Open Trickler branch based on 2022.05.x

.github/README.md

@@ -0,0 +1,76 @@
+# Open Trickler Buildroot
+
+This repo creates the Linux firmware images for the Open Trickler project.
+
+
+## Configuration
+
+The following files and directories are the most relevant for Open Trickler:
+
+- `configs/opentrickler_dev_defconfig`
+- `configs/opentrickler_prod_defconfig`
+- `package/python-opentrickler/`
+- `board/ammolytics/opentrickler/`
+
+
+## Build commands
+
+    make opentrickler_dev_defconfig
+    make
+
+The resulting firmware images will be in `output/images/`.
+
+
+## Syncing with upstream Buildroot
+
+Always keep commits to the `opentrickler-2022.05.x` on top of the latest upstream `2022.05.x` branch.
+
+    git checkout 2022.05.x
+    git pull
+    git checkout opentrickler-2022.05.x
+    git merge 2022.05.x
+    git push origin opentrickler-2022.05.x
+
+
+## Inspecting the image filesystem
+
+First, use `fdisk` to list the partitions and block positions.
+
+    fdisk -l  output/images/sdcard.img
+
+Example output
+
+    Disk output/images/sdcard.img: 596 MiB, 624951808 bytes, 1220609 sectors
+    Units: sectors of 1 * 512 = 512 bytes
+    Sector size (logical/physical): 512 bytes / 512 bytes
+    I/O size (minimum/optimal): 512 bytes / 512 bytes
+    Disklabel type: dos
+    Disk identifier: 0x00000000
+
+    Device                    Boot   Start     End Sectors  Size Id Type
+    output/images/sdcard.img1 *          1   65536   65536   32M  c W95 FAT32 (LBA)
+    output/images/sdcard.img2        65537 1089536 1024000  500M 83 Linux
+    output/images/sdcard.img3      1089537 1220608  131072   64M  c W95 FAT32 (LBA)
+
+
+The math that determines the block offset needed to mount a parition
+
+    start * sector size = offset  # equation
+    1 * 512 = 512  # BOOT parition
+    65537 * 512 = 33554944  # Linux root partition
+    1089537 * 512 = 557842944  # CODE parition
+
+
+Mounting the paritions (read-only)
+
+    sudo mkdir /mnt/ot-img/boot /mnt/ot-img/rootfs /mnt/ot-img/code
+    sudo mount -o loop,ro,sync,offset=512 output/images/sdcard.img /mnt/ot-img/boot
+    sudo mount -o loop,ro,offset=33554944 -t ext4 output/images/sdcard.img /mnt/ot-img/rootfs
+    sudo mount -o loop,ro,sync,offset=557842944 output/images/sdcard.img /mnt/ot-img/code
+
+
+Unmount the paritions
+
+    sudo umount /mnt/ot-img/boot
+    sudo umount /mnt/ot-img/rootfs
+    sudo umount /mnt/ot-img/code

.github/workflows/build-ot-firmware.yml

@@ -0,0 +1,91 @@
+# Build the Open Trickler firmware images
+
+name: build-ot-firmware
+
+# Controls when the workflow will run
+on:
+  # Note(eric): Disabled for now in favor of cron. Run on commits to existing PR.
+  #pull_request:
+  #  types: [labeled, synchronize]
+  # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
+  schedule:
+    # Monday at 1:00pm UTC which is usually 6:00am Pacific
+    - cron: '0 13 * * 1'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  firmware-build:
+    # The type of runner that the job will run on
+    runs-on: self-hosted
+
+    # Define the firmware matrix to build
+    strategy:
+      matrix:
+        board: [pi0w_dev, pizero2w_dev, pi0w_prod, pi3_dev]
+
+    outputs:
+      date: ${{ steps.date.outputs.date }}
+      sha: ${{ steps.sha.outputs.sha }}
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+
+      - id: date
+        run: echo "::set-output name=date::$(date +'%Y%m%d')"
+
+      - id: sha
+        run: echo "::set-output name=sha::${GITHUB_SHA:0:7}"
+
+      - name: Python pre-flight check
+        run: |
+          pwd
+          ls -al
+          whoami
+          which python3
+          python3 --version
+          which pip3 || true
+          pip3 --version || true
+          pip3 freeze || true
+          python3 -m pip --version || true
+          python3 -m venv tmp-venv
+          . tmp-venv/bin/activate
+          which python
+          python --version
+          python -m ensurepip --upgrade
+          which pip
+          pip install --upgrade pip
+          pip freeze
+          pip install wheel
+          pip install bluezero==0.8.0 pybleno pyserial gpiozero pymemcache RPi.GPIO grpcio
+          deactivate
+
+      - name: Build firmware
+        run: |
+          make opentrickler_${{ matrix.board }}_defconfig
+          make -j35
+
+      - name: Package firmware image
+        run: |
+          ls -al output/images/
+          cp output/images/sdcard.img .
+          xz --keep --force sdcard.img
+          mv sdcard.img.xz opentrickler-${{ matrix.board }}-${{ steps.date.outputs.date }}-${{ steps.sha.outputs.sha }}.img.xz
+          shasum -a 256 opentrickler-${{ matrix.board }}-${{ steps.date.outputs.date }}-${{ steps.sha.outputs.sha }}.img.xz > shasum.txt
+          ls -al *sdcard.img*
+          du -sh *sdcard.img*
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: ${{ matrix.board }} firmware
+          path: |
+            opentrickler-${{ matrix.board }}-${{ steps.date.outputs.date }}-${{ steps.sha.outputs.sha }}.img.xz
+            shasum.txt
+
+      - name: Garbage collection
+        run: |
+          make clean
+          rm shasum.txt *.img *.img.xz

.github/workflows/sync-with-upstream.yml

@@ -0,0 +1,40 @@
+# Sync local branches with buildroot upstream on a regular basis.
+name: sync-with-upstream
+
+on:
+  # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
+  schedule:
+    # Monday at 12:30pm UTC which is usually 5:30am Pacific
+    - cron: '30 12 * * 1'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+
+      - name: Sync with upstream then merge local changes
+        run: |
+          which gh
+          whoami
+          cat .git/config
+          git config --list | head -20
+          git remote -v
+          git remote add upstream https://github.com/buildroot/buildroot.git
+          git remote -v
+          cat .git/config
+          tree .git/refs/
+          git fetch origin
+          git checkout 2022.05.x
+          git fetch upstream
+          git merge upstream/2022.05.x
+          git push origin 2022.05.x
+          git pull
+          tree .git/refs/
+          git checkout opentrickler-2022.05.x
+          git merge 2022.05.x
+

board/ammolytics/opentrickler-pi-generic

@@ -0,0 +1 @@
+opentrickler

board/ammolytics/opentrickler-pi0w

@@ -0,0 +1 @@
+opentrickler

board/ammolytics/opentrickler-pi3

@@ -0,0 +1 @@
+opentrickler

board/ammolytics/opentrickler-pizero2w

@@ -0,0 +1 @@
+opentrickler

board/ammolytics/opentrickler/cmdline.txt

@@ -0,0 +1 @@
+root=/dev/mmcblk0p2 rootwait

board/ammolytics/opentrickler/config.txt

@@ -0,0 +1,24 @@
+# Please note that this is only a sample, we recommend you to change it to fit
+# your needs.
+# You should override this file using a post-build script.
+# See http://buildroot.org/manual.html#rootfs-custom
+# and http://elinux.org/RPiconfig for a description of config.txt syntax
+
+kernel=zImage
+
+# To use an external initramfs file
+#initramfs rootfs.cpio.gz
+
+# Disable overscan assuming the display supports displaying the full resolution
+# If the text shown on the screen disappears off the edge, comment this out
+disable_overscan=1
+
+# How much memory in MB to assign to the GPU on Pi models having
+# 256, 512 or 1024 MB total memory
+gpu_mem_256=100
+gpu_mem_512=100
+gpu_mem_1024=100
+
+
+# Increase I2C speed to 400KHz, tries to reduce flicker on display
+dtparam=i2c_baudrate=400000

board/ammolytics/opentrickler/device_table.txt

@@ -0,0 +1,4 @@
+/boot d 755 0 0 - - - - -
+/code d 755 0 0 - - - - -
+/usr/bin/python3.10 f 755 root root - - - - -
+|xattr cap_net_raw+eip

board/ammolytics/opentrickler/genimage-opentrickler-pi-generic.cfg

@@ -0,0 +1,54 @@
+image boot.vfat {
+  vfat {
+    extraargs = "-n BOOT"
+    files = {
+			"bcm2708-rpi-b.dtb",
+			"bcm2708-rpi-b-plus.dtb",
+			"bcm2708-rpi-cm.dtb",
+      "rpi-firmware/bootcode.bin",
+      "rpi-firmware/fixup.dat",
+      "rpi-firmware/start.elf",
+      "rpi-firmware/overlays",
+      "cmdline.txt",
+      "config.txt",
+      "wpa_supplicant.conf",
+      "zImage"
+    }
+  }
+  size = 32M
+}
+
+image code.vfat {
+  vfat {
+    extraargs = "-n CODE"
+    files = {
+      "opentrickler",
+      "venv"
+    }
+  }
+  size = 64M
+  # For some reason, this fails the build.
+  #mountpoint = "/code"
+}
+
+image sdcard.img {
+  hdimage {
+  }
+
+  partition boot {
+    partition-type = 0xC
+    bootable = "true"
+    image = "boot.vfat"
+  }
+
+  partition rootfs {
+    partition-type = 0x83
+    image = "rootfs.ext4"
+  }
+
+  partition code {
+    partition-type = 0xC
+    image = "code.vfat"
+  }
+
+}

board/ammolytics/opentrickler/genimage-opentrickler-pi0w.cfg

@@ -0,0 +1,52 @@
+image boot.vfat {
+  vfat {
+    extraargs = "-n BOOT"
+    files = {
+      "bcm2708-rpi-zero-w.dtb",
+      "rpi-firmware/bootcode.bin",
+      "rpi-firmware/fixup.dat",
+      "rpi-firmware/start.elf",
+      "rpi-firmware/overlays",
+      "cmdline.txt",
+      "config.txt",
+      "wpa_supplicant.conf",
+      "zImage"
+    }
+  }
+  size = 32M
+}
+
+image code.vfat {
+  vfat {
+    extraargs = "-n CODE"
+    files = {
+      "opentrickler",
+      "venv"
+    }
+  }
+  size = 64M
+  # For some reason, this fails the build.
+  #mountpoint = "/code"
+}
+
+image sdcard.img {
+  hdimage {
+  }
+
+  partition boot {
+    partition-type = 0xC
+    bootable = "true"
+    image = "boot.vfat"
+  }
+
+  partition rootfs {
+    partition-type = 0x83
+    image = "rootfs.ext4"
+  }
+
+  partition code {
+    partition-type = 0xC
+    image = "code.vfat"
+  }
+
+}