Merge pull request #2 from pimoroni/dir2uf2-and-refactor

Dir2uf2 and refactor

Author: Gadgetoid

.github/workflows/micropython.yml

@@ -34,11 +34,14 @@ jobs:
       # MicroPython version will be contained in github.event.release.tag_name for releases
       RELEASE_FILE: ${{ matrix.name }}-${{ github.event.release.tag_name || github.sha }}-micropython
       PIMORONI_PICO_DIR: "${{ github.workspace }}/pimoroni-pico"
-      MICROPY_BOARD_DIR: "${{ github.workspace }}/src-${{ github.sha }}/${{ matrix.BOARD }}"
       USER_C_MODULES: "${{ github.workspace }}/src-${{ github.sha }}/modules/${{ matrix.modules }}.cmake"
+      USER_FS_MANIFEST: "${{ github.workspace }}/src-${{ github.sha }}/modules/${{ matrix.modules }}.txt"
+      USER_FS_SOURCE: "${{ github.workspace }}/src-${{ github.sha }}/modules/littlefs"
       TAG_OR_SHA: ${{ github.event.release.tag_name || github.sha }}
       MICROPY_BOARD: ${{ matrix.board }}
       MICROPY_BOARD_VARIANT: ${{ matrix.variant }}
+      MICROPY_BOARD_DIR: "${{ github.workspace }}/src-${{ github.sha }}/${{ matrix.BOARD }}"
+      MICROPY_FROZEN_MANIFEST: "${{ github.workspace }}/src-${{ github.sha }}/modules/${{ matrix.modules }}.py"
       BOARD_NAME: ${{ matrix.name }}
       BUILD_TOOLS: src-${{ github.sha }}/ci/micropython.sh
 
@@ -81,12 +84,19 @@ jobs:
         source $BUILD_TOOLS
         micropython_clone
 
-    - name: "Py_Decl: Checkout py_decl"
+    - name: "Py_Decl: Checkout"
       uses: actions/checkout@v4
       with:
         repository: gadgetoid/py_decl
         ref: v0.0.2
         path: py_decl
+        
+    - name: "dir2uf2: Checkout"
+      uses: actions/checkout@v4
+      with:
+        repository: gadgetoid/dir2uf2
+        ref: v0.0.7
+        path: dir2uf2
 
     - name: "MicroPython: Build MPY Cross"
       run: |
@@ -106,24 +116,47 @@ jobs:
         source $BUILD_TOOLS
         cmake_build
 
-    - name: "Py_Decl: Verify UF2"
+    - name: "Py_Decl: Verify .uf2"
       shell: bash
       run: |
         python3 py_decl/py_decl.py --to-json --verify build-${{ matrix.name }}/${{ env.RELEASE_FILE }}.uf2
 
-    - name: Store .uf2 as artifact
+    - name: "dir2uf2: Append filesystem to .uf2"
+      shell: bash
+      run: |
+        python3 -m pip install littlefs-python==0.12.0
+        ./dir2uf2/dir2uf2 --fs-compact --append-to build-${{ matrix.name }}/${{ env.RELEASE_FILE }}.uf2 --manifest ${{env.USER_FS_MANIFEST}} --filename with-filesystem.uf2 ${{env.USER_FS_SOURCE}}/
+
+    - name: "Artifacts: Upload .uf2"
       uses: actions/upload-artifact@v4
       with:
         name: ${{ env.RELEASE_FILE }}.uf2
         path: build-${{ matrix.name }}/${{ env.RELEASE_FILE }}.uf2
 
-    - name: Upload .uf2
+    - name: "Artifacts: Upload .uf2 with filesystem"
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ env.RELEASE_FILE }}-with-filesystem.uf2
+        path: ${{ env.RELEASE_FILE }}-with-filesystem.uf2
+
+    - name: "Release: Upload .uf2"
       if: github.event_name == 'release'
       uses: actions/upload-release-asset@v1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        asset_path: build-${{ matrix.name }}/firmware.uf2
+        asset_path: build-${{ matrix.name }}/${{ env.RELEASE_FILE }}.uf2
         upload_url: ${{ github.event.release.upload_url }}
         asset_name: ${{ env.RELEASE_FILE }}.uf2
+        asset_content_type: application/octet-stream
+
+    - name: "Release: Upload .uf2 with filesystem"
+      if: github.event_name == 'release'
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        asset_path: ${{ env.RELEASE_FILE }}-with-filesystem.uf2
+        upload_url: ${{ github.event.release.upload_url }}
+        asset_name: ${{ env.RELEASE_FILE }}-with-filesystem.uf2
         asset_content_type: application/octet-stream

README.md

@@ -13,4 +13,7 @@ should automatically handle building MicroPython for you.
 * pga2350 - MicroPython and Pico SDK board definitions for PGA2350, with PSRAM variant
 * modules/c/example - An example MicroPython C++ module, demonstrating C class bindings
 * modules/py_frozen - Python files intended to be frozen into the firmware
-* modules/py_littlefs - Python files intended to be visible/editable in the LittleFS user filesystem
+* modules/py_littlefs - Python files intended to be visible/editable in the LittleFS user filesystem
+* modules/default.py - The MicroPython manifest file, for specifying frozen libs
+* modules/default.txt - The dir2uf2 LittleFS manifest file, for specifying included files
+* modules/default.cmake - The MicroPython USER_C_MODULES file, for specifying included C/C++ modules

ci/micropython.sh

@@ -52,6 +52,7 @@ function cmake_configure {
     -DMICROPY_BOARD_DIR=$MICROPY_BOARD_DIR \
     -DMICROPY_BOARD=$MICROPY_BOARD \
     -DMICROPY_BOARD_VARIANT=$MICROPY_BOARD_VARIANT \
+    -DMICROPY_FROZEN_MANIFEST=$MICROPY_FROZEN_MANIFEST \
     -DCMAKE_C_COMPILER_LAUNCHER=ccache \
     -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
 }

modules/default.py

@@ -0,0 +1,8 @@
+# Include the manifest.py from micropython/ports/rp2/boards/manifest.py
+include("$(PORT_DIR)/boards/manifest.py")
+
+# Include the manifest.py from micropython/<board>/manifest.py
+include("$(BOARD_DIR)/manifest.py")
+
+# Include pga/modules/py_frozen
+freeze("py_frozen/")

modules/default.txt

@@ -0,0 +1 @@
+example.py

modules/frozen.py

@@ -0,0 +1,5 @@
+# This file should be frozen into the MicroPython build
+# try: `import frozen_example`
+
+def example():
+    print("Hello Frozen Example")

modules/littlefs.txt

@@ -0,0 +1,2 @@
+# This file should be added to the user-facing MicroPython filesystem
+print("Hello World")

modules/py_frozen/frozen_example.py

@@ -1,5 +1 @@
-# Include the manifest.py from micropython/ports/rp2/boards/manifest.py
-include("$(PORT_DIR)/boards/manifest.py")
-
-# Include frozen.py from pga/modules/frozen.py
-include("../modules/frozen.py")
+# Board-specific frozen libs go here

modules/py_littlefs/example.py

@@ -1,5 +1 @@
-# Include the manifest.py from micropython/ports/rp2/boards/manifest.py
-include("$(PORT_DIR)/boards/manifest.py")
-
-# Include frozen.py from pga/modules/frozen.py
-include("../modules/frozen.py")
+# Board-specific frozen libs go here