Add Adafruit ItsyBitsy rp2040

awawa-dev · awawa-dev · commit cacaebf6fb55 · 2023-07-22T22:37:44.000+02:00
diff --git a/.github/workflows/push-master.yml b/.github/workflows/push-master.yml
@@ -34,78 +34,99 @@ jobs:
       if: (startsWith(github.event.ref, 'refs/tags') != true)
       with:
         path: |
-          firmwares/*.uf2
+          firmware/*.uf2
 
     - uses: actions/upload-artifact@v3
       name: Upload artifacts (release)
       if: startsWith(github.ref, 'refs/tags/')
       with:
         name: firmware-release
         path: |
-          firmwares/*.uf2
+          firmware/*.uf2
 
     - name: Build packages for Adafruit Feather RP2040 Scorpio (release-only)
       if: startsWith(github.ref, 'refs/tags/')
       shell: bash
       run: |
         cd build
         rm *.*
-        rm ../firmwares/*
-        echo "Neopixel is using GPIO16(OUTPUT_SPI_DATA_PIN) on output 0." > ../firmwares/Firmwares_for_Adafruit_Feather_RP2040_Scorpio.txt
-        echo "SPI is using spi0 interface pins: GPIO19(OUTPUT_SPI_DATA_PIN) and GPIO18(OUTPUT_SPI_CLOCK_PIN) on output 3 and 2 respectively." >> ../firmwares/Firmwares_for_Adafruit_Feather_RP2040_Scorpio.txt
+        rm ../firmware/*
+        echo "Neopixel is using GPIO16(OUTPUT_DATA_PIN) on output 0." > ../firmware/Firmwares_for_Adafruit_Feather_RP2040_Scorpio.txt
+        echo "SPI is using spi0 interface pins: GPIO19(OUTPUT_SPI_DATA_PIN) and GPIO18(OUTPUT_SPI_CLOCK_PIN) on output 3 and 2 respectively." >> ../firmware/Firmwares_for_Adafruit_Feather_RP2040_Scorpio.txt
         cmake -DOVERRIDE_DATA_PIN=16 -DOVERRIDE_SPI_DATA_PIN=19 -DOVERRIDE_SPI_CLOCK_PIN=18 -DCMAKE_BUILD_TYPE=Release ..
         cmake --build .
-        zip -j ../firmwares/Adafruit_Feather_RP2040_Scorpio.zip ../firmwares/*
+        zip -j ../firmware/Adafruit_Feather_RP2040_Scorpio.zip ../firmware/*
 
     - uses: actions/upload-artifact@v3
-      name: Upload artifacts (release)
+      name: Upload artifacts (release Adafruit_Feather)
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        name: firmware-release
+        path: |
+          firmware/*.zip
+
+    - name: Build packages for Adafruit ItsyBitsy RP2040 (release-only)
+      if: startsWith(github.ref, 'refs/tags/')
+      shell: bash
+      run: |
+        cd build
+        rm *.*
+        rm ../firmware/*
+        echo "Neopixel is using GPIO5(OUTPUT_DATA_PIN) on output 5." > ../firmware/Firmwares_for_Adafruit_ItsyBitsy_2040.txt
+        cmake -DOVERRIDE_DATA_PIN=5 -DCMAKE_BUILD_TYPE=Release ..
+        cmake --build .
+        rm ../firmware/*_Spi.uf2
+        zip -j ../firmware/Adafruit_ItsyBitsy_2040.zip ../firmware/*
+
+    - uses: actions/upload-artifact@v3
+      name: Upload artifacts (release Adafruit_ItsyBitsy)
       if: startsWith(github.ref, 'refs/tags/')
       with:
         name: firmware-release
         path: |
-          firmwares/*.zip
+          firmware/*.zip
 
     - name: Build packages for Pimoroni Plasma Stick 2040 W (release-only)
       if: startsWith(github.ref, 'refs/tags/')
       shell: bash
       run: |
         cd build
         rm *.*
-        rm ../firmwares/*
-        echo "Neopixel is using GPIO15(OUTPUT_SPI_DATA_PIN) on output PIXELS." > ../firmwares/Firmwares_for_Pimoroni_Plasma_Stick_2040_W.txt
+        rm ../firmware/*
+        echo "Neopixel is using GPIO15(OUTPUT_DATA_PIN) on output PIXELS." > ../firmware/Firmwares_for_Pimoroni_Plasma_Stick_2040_W.txt
         cmake -DOVERRIDE_DATA_PIN=15 -DCMAKE_BUILD_TYPE=Release ..
         cmake --build .
-        rm ../firmwares/*_Spi.uf2
-        zip -j ../firmwares/Pimoroni_Plasma_Stick_2040_W.zip ../firmwares/*
+        rm ../firmware/*_Spi.uf2
+        zip -j ../firmware/Pimoroni_Plasma_Stick_2040_W.zip ../firmware/*
 
     - uses: actions/upload-artifact@v3
-      name: Upload artifacts (release)
+      name: Upload artifacts (release Pimoroni_Plasma_Stick_W)
       if: startsWith(github.ref, 'refs/tags/')
       with:
         name: firmware-release
         path: |
-          firmwares/*.zip
+          firmware/*.zip
 
     - name: Build packages for Pimoroni Plasma 2040 (release-only)
       if: startsWith(github.ref, 'refs/tags/')
       shell: bash
       run: |
         cd build
         rm *.*
-        rm ../firmwares/*
-        echo "Neopixel is using GPIO15(OUTPUT_SPI_DATA_PIN) on output DA." > ../firmwares/Firmwares_for_Pimoroni_Plasma_2040.txt
-        echo "SPI is using spi1 interface pins: GPIO15(OUTPUT_SPI_DATA_PIN) and GPIO14(OUTPUT_SPI_CLOCK_PIN) on output DA and CL respectively." >> ../firmwares/Firmwares_for_Pimoroni_Plasma_2040.txt
+        rm ../firmware/*
+        echo "Neopixel is using GPIO15(OUTPUT_DATA_PIN) on output DA." > ../firmware/Firmwares_for_Pimoroni_Plasma_2040.txt
+        echo "SPI is using spi1 interface pins: GPIO15(OUTPUT_SPI_DATA_PIN) and GPIO14(OUTPUT_SPI_CLOCK_PIN) on output DA and CL respectively." >> ../firmware/Firmwares_for_Pimoroni_Plasma_2040.txt
         cmake -DOVERRIDE_DATA_PIN=15 -DOVERRIDE_SPI_INTERFACE=spi1 -DOVERRIDE_SPI_DATA_PIN=15 -DOVERRIDE_SPI_CLOCK_PIN=14 -DCMAKE_BUILD_TYPE=Release ..
         cmake --build .
-        zip -j ../firmwares/Pimoroni_Plasma_2040.zip ../firmwares/*
+        zip -j ../firmware/Pimoroni_Plasma_2040.zip ../firmware/*
 
     - uses: actions/upload-artifact@v3
-      name: Upload artifacts (release)
+      name: Upload artifacts (release Pimoroni_Plasma)
       if: startsWith(github.ref, 'refs/tags/')
       with:
         name: firmware-release
         path: |
-          firmwares/*.zip
+          firmware/*.zip
 
 ################################
 ###### Publish Releases ########
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -49,7 +49,7 @@ pico_sdk_init()
 set(HyperSerialPicoCompanionLibs FreeRTOS-Kernel FreeRTOS-Kernel-Heap1 pico_stdlib pico_multicore hardware_pio hardware_dma hardware_spi)
 set(HyperSerialPicoCompanionIncludes ${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/sdk/config)
 file(MAKE_DIRECTORY ${CMAKE_SOURCE_DIR}/generated)
-file(MAKE_DIRECTORY ${CMAKE_SOURCE_DIR}/firmwares)
+file(MAKE_DIRECTORY ${CMAKE_SOURCE_DIR}/firmware)
 
 if(NOT CMAKE_HOST_WIN32)
 	string(ASCII 27 EscChar)
@@ -96,7 +96,7 @@ macro(HyperSerialPicoTarget HyperSerialPicoTargetName)
     pico_enable_stdio_uart(${HyperSerialPicoTargetName} 0)
     pico_generate_pio_header(${HyperSerialPicoTargetName} ${CMAKE_SOURCE_DIR}/pio/neopixel.pio OUTPUT_DIR ${CMAKE_SOURCE_DIR}/generated)
     pico_generate_pio_header(${HyperSerialPicoTargetName} ${CMAKE_SOURCE_DIR}/pio/neopixel_ws2812b.pio OUTPUT_DIR ${CMAKE_SOURCE_DIR}/generated)
-    add_custom_command(TARGET ${HyperSerialPicoTargetName} POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${HyperSerialPicoTargetName}.uf2 ${CMAKE_SOURCE_DIR}/firmwares)
+    add_custom_command(TARGET ${HyperSerialPicoTargetName} POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${HyperSerialPicoTargetName}.uf2 ${CMAKE_SOURCE_DIR}/firmware)
 endmacro()
 
 # targets for different LED strips
diff --git a/README.md b/README.md
@@ -5,9 +5,9 @@ Adalight serial port LED driver implementation for Raspberry Pi Pico RP2040.
 <p align="center"><img src="https://user-images.githubusercontent.com/69086569/236885968-baab51ba-a54b-4072-9a2a-cf867f2edb4b.png" width="250" height="250"/><img src="https://user-images.githubusercontent.com/69086569/236885360-dce9cfd7-92a8-43c6-911f-649325ee8a96.png" width="250" height="250"/></p>
 
 # Recommended boards with a built-in level shifter
-To ensure the LEDs will work properly with the Pico board, a 3.3V to 5V level shifter is needed. You can use an external one e.g. SN74AHCT125N or just buy a model of rp2040 that already has it built-in: Adafruit Feather RP2040 Scorpio (output: GPIO16-23), Pimoroni Plasma 2040 (GPIO14-15) or Pimoroni Plasma Stick 2040 W (GPIO15).
+To ensure the LEDs will work properly with the Pico board, a 3.3V to 5V level shifter is needed. You can use an external one e.g. SN74AHCT125N or just buy a model of rp2040 that already has it built-in: Adafruit Feather RP2040 Scorpio (output: GPIO16-23), Adafruit ItsyBitsy RP2040 (output: GPIO5), Pimoroni Plasma 2040 (GPIO14-15) or Pimoroni Plasma Stick 2040 W (GPIO15).
 
-<p align="center"><img src="https://user-images.githubusercontent.com/69086569/242393809-4e491159-76c7-4c1e-be0a-1f10cd5291f2.png"  width="200" height="200"/><img src="https://user-images.githubusercontent.com/69086569/241395006-ee27175e-677b-4971-97bc-ed294eaa8f3b.png" width="200" height="200"/><img src="https://user-images.githubusercontent.com/69086569/241394387-f8193ed8-56d5-46c6-b406-911720aed605.png" width="200" height="200"/></p>
+<p align="center"><img src="https://user-images.githubusercontent.com/69086569/242393809-4e491159-76c7-4c1e-be0a-1f10cd5291f2.png"  width="200" height="200"/><img src="https://github.com/awawa-dev/HyperSerialPico/assets/69086569/e7a2a945-be12-47b1-8e48-ffc1b11c5b2f.png"  width="200" height="200"/><img src="https://user-images.githubusercontent.com/69086569/241395006-ee27175e-677b-4971-97bc-ed294eaa8f3b.png" width="200" height="200"/><img src="https://user-images.githubusercontent.com/69086569/241394387-f8193ed8-56d5-46c6-b406-911720aed605.png" width="200" height="200"/></p>
 
 # Supported LED strips
 | LED strip / Device             |    Single lane   |    Multi-segment   |
@@ -26,9 +26,9 @@ It's very easy and you don't need any special flasher.
 \
 For HyperHDR and generic rp2040 choose `HyperSerialPico_<type>.uf2` firmware where *type* is one of supported LEDs: sk6812 cold/neutral white, variants of ws2812 and apa102. \
 \
-Due to the often neglected issue of the required 5 volt logic necessary for the correct operation of the supported LEDs, we want to promote rp2040 boards with a built-in 3.3V to 5V level shifter and we provide firmwares compiled to their GPIO specifications. You can find these firmwares & short pin-out manuals in the archives: `Adafruit_Feather_RP2040_Scorpio.zip`, `Pimoroni_Plasma_2040.zip`, `Pimoroni_Plasma_Stick_2040_W.zip`. Also you can read about their specific GPIO output in the `Recommended boards with a built-in level shifter` section above.  \
+Due to the often neglected issue of the required 5 volt logic necessary for the correct operation of the supported LEDs, we want to promote rp2040 boards with a built-in 3.3V to 5V level shifter and we provide firmware compiled to their GPIO specifications. You can find these firmware & short pin-out manuals in the archives: `Adafruit_Feather_RP2040_Scorpio.zip`, `Adafruit_ItsyBitsy_2040.zip`, `Pimoroni_Plasma_2040.zip`, `Pimoroni_Plasma_Stick_2040_W.zip`. Also you can read about their specific GPIO output in the `Recommended boards with a built-in level shifter` section above.  \
 \
-If you are using an application other than HyperHDR, select the `classic_adalight.zip` archive, unzip it and select `classic_adalight_HyperSerialPico_<type>.uf2` firmware (note: do not use firmwares from this archive for HyperHDR, they do not support my AWA protocol extension, missing many options and are simply only backwards compatible with other applications).  
+If you are using an application other than HyperHDR, select the `classic_adalight.zip` archive, unzip it and select `classic_adalight_HyperSerialPico_<type>.uf2` firmware (note: do not use firmware from this archive for HyperHDR, they do not support my AWA protocol extension, missing many options and are simply only backwards compatible with other applications).  
   
 3) Next put your Pico board into DFU mode:  
 * If your Pico board has only one button (`boot`) then press & hold it and connect the board to the USB port. Then you can release the button.
@@ -53,7 +53,7 @@ rp2040 allows hardware SPI on corresponding pairs of pins:
 spi0 ⇒ Data/Clock: GPIO3/GPIO2, GPIO19/GPIO18, GPIO7/GPIO6  
 spi1 ⇒ Data/Clock: GPIO11/GPIO10, GPI15/GPIO14, GPIO27/GPI26  
 
-Pinout can be changed, but you need to make changes to `CMakeList.txt` (e.g. `OUTPUT_DATA_PIN` / `OUTPUT_SPI_DATA_PIN` / `OUTPUT_SPI_CLOCK_PIN`) and recompile the project. Also multi-segment mode can be enabled in this file: `SECOND_SEGMENT_INDEX` option at the beginning and optionally `SECOND_SEGMENT_REVERSED`. Once compiled, the results can be found in the `firmwares` folder.
+Pinout can be changed, but you need to make changes to `CMakeList.txt` (e.g. `OUTPUT_DATA_PIN` / `OUTPUT_SPI_DATA_PIN` / `OUTPUT_SPI_CLOCK_PIN`) and recompile the project. Also multi-segment mode can be enabled in this file: `SECOND_SEGMENT_INDEX` option at the beginning and optionally `SECOND_SEGMENT_REVERSED`. Once compiled, the results can be found in the `firmware` folder.
 
 Of course, you can also build your custom firmware completely online using Github Actions. The manual can be found on [wiki](https://github.com/awawa-dev/HyperSerialPico/wiki). Be sure to follow the steps in the correct order.
 
