From cd45f9899da6d4b8feda33ed8d1e8b199a8a43a6 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Thu, 20 Mar 2025 22:15:44 +0000 Subject: [PATCH 1/3] Add notices to various readmes --- azure-pipelines.yml | 69 ----------------------- drivers/ESP32-Storage/README.md | 2 + drivers/ESP32-WS2812/README.md | 2 + drivers/OLED-SS1306-display/README.md | 3 +- drivers/RFID-MFRC522-SPI/README.MD | 2 + drivers/Sensor-DS18B20/README.md | 3 + drivers/Simple-Web-Server/README.md | 7 ++- extensions/stm32/gpiocontroller/README.md | 2 + 8 files changed, 17 insertions(+), 73 deletions(-) diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 1b5a9d1..339e8f4 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -42,76 +42,7 @@ jobs: Write-host "Files changed:" $commit.files | % {$_.filename} - if ( $commit.files.filename -like "*extensions/stm32/gpiocontroller*" ) - { - echo "##vso[task.setvariable variable=BUILD_STM32_GPIOCONTROLLER;isOutput=true]true" - } - name: BuildOptions displayName: get list of changed paths # build jobs - -# STM32 GpioController extension -- job: Build_STM32_GpioController - # skip build if there are no changes - condition: eq( dependencies.Get_Build_Options.outputs['BuildOptions.BUILD_STM32_GPIOCONTROLLER'], true ) - dependsOn: - - Get_Build_Options - - pool: - vmImage: 'windows-latest' - - variables: - major: 1 - # creates a counter called versioncounter and assigns it to the minor variable - minor: $[counter('versioncounter', 0)] - - steps: - - - checkout: self - - - template: azure-pipelines-templates/install-nuget.yml@templates - - - task: NuGetCommand@2 - inputs: - command: 'custom' - arguments: 'pack extensions\stm32\gpiocontroller\package.nuspec -Version $(major).$(minor)' - condition: succeeded() - displayName: Pack NuGet with class library - - - task: CopyFiles@1 - inputs: - sourceFolder: $(Build.SourcesDirectory) - Contents: | - **\*nanoFramework.Extensions.Stm32.GpioController*.nupkg - TargetFolder: '$(Build.ArtifactStagingDirectory)' - flattenFolders: true - condition: succeeded() - displayName: Collecting deployable artifacts - - # publish artifacts (only possible if this is not a PR originated on a fork) - - task: PublishBuildArtifacts@1 - inputs: - PathtoPublish: '$(Build.ArtifactStagingDirectory)' - ArtifactName: deployables - ArtifactType: Container - condition: and( succeeded(), ne(variables['system.pullrequest.isfork'], true) ) - displayName: Publish deployables artifacts - - # push NuGet class lib package to NuGet (always happens except on PR builds) - - task: NuGetCommand@2 - inputs: - command: push - nuGetFeedType: external - packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg' - publishFeedCredentials: 'NuGetEcloSolutions' - condition: and( succeeded(), not( startsWith(variables['Build.SourceBranch'], 'refs/pull') ) ) - displayName: Push NuGet packages to NuGet - - # step from template @ nf-tools repo - - template: azure-pipelines-templates/discord-webhook-task.yml@templates - parameters: - status: 'failure' - webhookUrl: '$(DiscordWebhook)' - message: 'SMT32 GpioController extension' diff --git a/drivers/ESP32-Storage/README.md b/drivers/ESP32-Storage/README.md index 607a0d4..ef416dc 100644 --- a/drivers/ESP32-Storage/README.md +++ b/drivers/ESP32-Storage/README.md @@ -1,5 +1,7 @@ # SD card and internal storage support for nanoFramework +## ⚠️ This sample is potentially superseded with the [FileSystem Sample](https://github.com/nanoframework/Samples/tree/main/samples/System.IO.FileSystem). ⚠️ + Thanks to Adrian Soundy and José Simões and everyone helped make "Storage" possible for nanoFramework. Storage is still under construction check the samples here https://github.com/nanoframework/Samples/tree/master/samples/Storage for updates and changes. This library is for SD card readers connected using SPI. Other SD card options below were not tested. diff --git a/drivers/ESP32-WS2812/README.md b/drivers/ESP32-WS2812/README.md index 43e26d2..d5fc1b8 100644 --- a/drivers/ESP32-WS2812/README.md +++ b/drivers/ESP32-WS2812/README.md @@ -1,5 +1,7 @@ # ESP32 WS2812 Driver +## ⚠️ This driver is potentially superseded with [nanoFramework.IoT.Device.Ws28xx](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Ws28xx). ⚠️ + A C# helper class that helps you control pixels on WS2812 addressable RGB devices with the nanoFramework platform and ESP32. The WS2812.TestApp that produces a rainbow effect on a M5Stack ATOM. diff --git a/drivers/OLED-SS1306-display/README.md b/drivers/OLED-SS1306-display/README.md index 9c98396..79e3fa1 100644 --- a/drivers/OLED-SS1306-display/README.md +++ b/drivers/OLED-SS1306-display/README.md @@ -1,6 +1,7 @@ - # NanoFramework SSD1306 Oled 128x64, 128x32, 64x48, 96x16 display driver +## ⚠️ This driver is potentially superseded with [nanoFramework.IoT.Device.Ssd13xx](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Ssd13xx). ⚠️ + Source Code: https://github.com/Dweaver309/nanoframework.SS1306 diff --git a/drivers/RFID-MFRC522-SPI/README.MD b/drivers/RFID-MFRC522-SPI/README.MD index 207f3c6..d220a82 100644 --- a/drivers/RFID-MFRC522-SPI/README.MD +++ b/drivers/RFID-MFRC522-SPI/README.MD @@ -1,5 +1,7 @@ # RFID MFRC522 driver support for nanoFramework +## ⚠️ This driver is potentially superseded with [nanoFramework.IoT.Device.Mfrc522](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Mfrc522). ⚠️ + This drive is a port of [Bauland's](https://github.com/bauland/TinyClrLib/tree/master/Modules/Others/MfRc522) nice work for TinyClrLib. Added basic ability to write on Mifare1k and MifareUltraLight cards. diff --git a/drivers/Sensor-DS18B20/README.md b/drivers/Sensor-DS18B20/README.md index 871d503..e9634dd 100644 --- a/drivers/Sensor-DS18B20/README.md +++ b/drivers/Sensor-DS18B20/README.md @@ -1,4 +1,7 @@ # Driver for DS18B20 + +## ⚠️ This driver is potentially superseded with [nanoFramework.IoT.Device.Ds18b20](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Ds18b20). ⚠️ + NanoFramework 18B20 driver. A simplified version of nF-ESP32-One-Wire Source code [Here!](https://github.com/up-streamer/nF_18B20) diff --git a/drivers/Simple-Web-Server/README.md b/drivers/Simple-Web-Server/README.md index 54933a8..e9d1a2e 100644 --- a/drivers/Simple-Web-Server/README.md +++ b/drivers/Simple-Web-Server/README.md @@ -1,4 +1,7 @@ # nanoFramework Web Server + +## ⚠️ This sample is potentially superseded with the [Webserver Sample](https://github.com/nanoframework/Samples/tree/main/samples/Webserver). ⚠️ + ESP32 Web Server for nanoFramework This is a simple but powerful web server that allows the user to create a web server and application on one ESP board. In the past most applications used two chips one for the application and one to connect to the network. @@ -9,6 +12,4 @@ The web server runs on it's own thread so it is not blocked by the request proce The server is used by typing in the web server's assigned IP address into any web browser. -Sourc Code: https://github.com/Dweaver309/nanoFramework-Web-Server - - +Source Code: https://github.com/Dweaver309/nanoFramework-Web-Server diff --git a/extensions/stm32/gpiocontroller/README.md b/extensions/stm32/gpiocontroller/README.md index a1aabbc..acc8f58 100644 --- a/extensions/stm32/gpiocontroller/README.md +++ b/extensions/stm32/gpiocontroller/README.md @@ -1,5 +1,7 @@ # GpiController extension for STM32 targets +## ⚠️ This extension is obsolete and no longer used with current firmware versions. ⚠️ + This adds the extension `OpenStm32Pin(portName, pin)` to `GpioController` allowing the developer to conveniently use the standard STM naming for GPIO ports. Like this: From 32a6c9aafbebb93b839e862fd4068cd0fce78822 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Thu, 20 Mar 2025 22:33:37 +0000 Subject: [PATCH 2/3] Update modbus readme --- libraries/nanoFramework.Modbus/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libraries/nanoFramework.Modbus/README.md b/libraries/nanoFramework.Modbus/README.md index 40b50c4..8c9dd4f 100644 --- a/libraries/nanoFramework.Modbus/README.md +++ b/libraries/nanoFramework.Modbus/README.md @@ -1,5 +1,7 @@ # nanoFramework.Modbus +## ⚠️ This library is potentially superseded with [nanoFramework.IoT.Device.Modbus](https://github.com/nanoframework/nanoFramework.IoT.Device/tree/develop/devices/Modbus). ⚠️ + Serial port Modbus-RTU protocol implementation. Repository: [https://github.com/yureng/nanoFramework.Modbus](https://github.com/yureng/nanoFramework.Modbus). From 9555f89b9cdee7d36661da056dfb0d32e8faaf2f Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Thu, 20 Mar 2025 22:36:18 +0000 Subject: [PATCH 3/3] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bc4597d..fb5b4df 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,7 +6,7 @@ - [ ] I've placed my contribution in the appropriate section. - [ ] I've choosen a good name for it and I've checked the repo for duplicates. -- [ ] I've added a readme.md following the provided template (TBD). +- [ ] I've added a README.md following the provided template (TBD). - [ ] My code follows the code style of this project. - [ ] I've tidy my files inside the contribution folder. - [ ] I've edited the repo README.md to include the mention and link to my contribution. It's under the proper section and the link is correct.