Add build automation via Github Actions

Author: calotlea

.github/workflows/main.yml

@@ -0,0 +1,51 @@
+#
+#      Author  lea_calot
+#
+name: FirmwareBuild
+
+on:
+  push:
+    branches: [ ]
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+jobs:
+  build_firmware:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Install Arm GNU Toolchain (arm-none-eabi-gcc)
+        uses: carlosperate/arm-none-eabi-gcc-action@v1
+        with:
+          release: '11.2-2022.02'
+
+      - name: Install SEGGER J-Link RTT
+        run: |
+          wget --post-data "accept_license_agreement=accepted" -c https://www.segger.com/downloads/jlink/JLink_Linux_V792_x86_64.tgz
+          tar xvzf JLink_Linux_V792_x86_64.tgz
+          tar xvzf JLink_Linux_V792_x86_64/Samples/RTT/SEGGER_RTT_V792.tgz
+          cp SEGGER_RTT_V792/Config/SEGGER_RTT_Conf.h SEGGER_RTT_V792/RTT/
+
+      - name: Install CubeMX G0
+        run: |
+          git clone --recursive -b v1.6.0 https://github.com/STMicroelectronics/STM32CubeG0.git
+
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          path: NeoDK
+
+      - name: Build Firmware
+        run: |
+          echo $(pwd)
+          cd NeoDK/firmware
+          SEGGER=~/work/NeoDK/NeoDK/SEGGER_RTT_V792/RTT/ STM32CUBE_G0=~/work/NeoDK/NeoDK/STM32CubeG0 GNU_INSTALL_ROOT=$(dirname $(which arm-none-eabi-gcc))/ make
+          
+      - name: Upload firmware artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: neodk_firmware
+          compression-level: 9
+          path: |
+            NeoDK/firmware/build/neodk_g071.bin
+            NeoDK/firmware/build/neodk_g071.hex

README.md

@@ -10,10 +10,7 @@ Discord: @Onwrikbaar<br/>
 E: <[email protected]>
 
 ### Status
-This is a work in progress. Updates may be few and far between.
-
-### Request
-Please send me an e-mail in case you are building this design, and let me know whether you run into any questions or problems. It will help me decide how I can best lower the threshold to replicating NeoDK. Thanks!
+This is a work in progress. The electronics are production-ready. The firmware is far from finished.
 
 ### Goals
 1. The last quarter century, innovation in the e-stim realm has been virtually nonexistent, despite massive advances in electronics and cheap computing power. Currently available commercial devices are without exception channel-oriented and produce TENS-like waveforms. Most are horrendously energy-inefficient. The time has come to unlock the potential of a more capable architecture.

firmware/Makefile

@@ -11,8 +11,8 @@ MAO_LIB_SRC := maolib/src
 PROJ_DIR_INC := inc
 PROJ_DIR_SRC := src
 STM32REPO := $(HOME)/STM32Cube/Repository
-STM32CUBE_G0 := $(STM32REPO)/STM32Cube_FW_G0_V1.6.0
-SEGGER := $(HOME)/SEGGER_RTT
+STM32CUBE_G0 ?= $(STM32REPO)/STM32Cube_FW_G0_V1.6.0
+SEGGER ?= $(HOME)/SEGGER_RTT
 
 $(OUTPUT_DIRECTORY)/neodk_g071.out: \
   LINKER_SCRIPT := STM32G071_FLASH.ld
@@ -47,7 +47,7 @@ STM32G0xx_INC += \
   $(STM32CUBE_G0)/Drivers/CMSIS/Core/Include \
   $(STM32CUBE_G0)/Drivers/CMSIS/Device/ST/STM32G0xx/Include \
   $(STM32CUBE_G0)/Drivers/STM32G0xx_HAL_Driver/Inc \
-  $(HOME)/gcc-arm/arm-none-eabi/include \
+  $(GNU_INSTALL_ROOT)/../include \
   $(SEGGER) \
 
 # Libraries common to all targets

firmware/Setup.md

@@ -1,12 +1,40 @@
-### ARM gcc
+## Updating the firmware without using a debugging probe
+1. Download and install STM's free [STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html) programming tool.
+2. Connect NeoDK to a computer using a USB-to-3.5mm-TRS-serial cable. Suitable cables (3.3V TTL, Tip=Tx, Ring=Rx, Sleeve=GND) are readily available from various sources, like Aliexpress, for about €10 including shipping.
+3. Press and hold the pushbutton on NeoDK while switching on its power (or connecting the battery). This puts NeoDK in bootloader mode. Release the button.
+4. Open a terminal window and execute the following on the command line:<br/>
+&nbsp;&nbsp;`cd firmware`<br/>
+&nbsp;&nbsp;`STM32_Programmer_CLI -c port=/dev/tty.usbserial-0001 -w build/neodk_g071.hex -v`<br/>
+(Specify the COM port that corresponds to your USB-serial cable, in place of `/dev/tty.usbserial-0001`).<br/>
+A power cycle starts the firmware; the blue LED should light up and the box is ready for use.
+
+## Controlling NeoDK from a computer
+1. Connect NeoDK to a computer using a USB-to-3.5mm-TRS-serial cable (3.3V TTL, Tip=Tx, Ring=Rx, Sleeve=GND).
+2. Open a Chrome, Edge or Opera browser window and point it to the [NUUI](https://deviceweb.org/neostim) (Neostim Ugly User Interface).
+3. The following commands can be typed into the command box:
+- /? list the commands
+- /a print the instantaneous primary current and some voltages
+- /b simulate the button, to start/pause/resume the pattern
+- /d primary voltage down by 200 mV
+- /l toggle the lovely blue LED
+- /u primary voltage up by 200 mV
+- /v print firmware version
+- /0 (zero) turn off the primary voltage
+- /1../9 set the primary voltage to 1..9 Volt (be careful what you wish for)
+
+## Developing code for NeoDK
+### Debugging probe
+A suitable probe is the Segger JLink or Segger JLink EDU. Other probes supporting the SWD interface will work too.
+
+### Compiler
 1. Download and install the [Arm GNU Toolchain](https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain) for bare metal targets.
 2. Edit [Makefile.posix](toolchain/gcc/Makefile.posix) or [Makefile.windows](toolchain/gcc/Makefile.windows) (depending on your operating system) to set three environment variables to their appropriate values. Alternatively, they can be set in the startup file for your command line interface.
 
-### STM32Cube
+### STM's low-level code library
 1. Download and install [STM32Cube for STM32G0 series](https://www.st.com/en/embedded-software/stm32cubeg0.html).
 2. In your home directory, create a softlink to directory 'STM32Cube' of the just installed tree.
 
-### SEGGER J-Link
+### SEGGER J-Link software
 1. Download and install [Segger J-Link](https://www.segger.com/downloads/jlink/).
 2. In the just installed Segger directory tree, find file JLink_V792k/Samples/RTT/SEGGER_RTT_V792k.tgz and unpack it in place.
 3. In your home directory, create a softlink named 'SEGGER_RTT' to directory 'JLink_V792k/Samples/RTT/SEGGER_RTT_V792k/RTT' of the just installed tree.
@@ -35,15 +63,3 @@ This should now show output from NeoDK.<br>
 In the JLinkRTTClient window, type<br>
 &nbsp;&nbsp;`/?`<br>
 to see a list of available NeoDK interactive commands.
-
-### Updating the firmware without using a debugging probe
-1. Download and install STM's free [STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html) programming tool.
-2. Connect NeoDK to a computer using a USB-to-3.5mm-TRS-serial cable. Suitable cables (3.3V TTL, Tip=Tx, Ring=Rx, Sleeve=GND) are readily available from various sources, like Aliexpress, for about €10 including shipping.
-3. Press and hold the pushbutton on NeoDK while switching on its power (or connecting the battery). This puts NeoDK in bootloader mode. Release the button.
-4. Open a terminal window and execute the following on the command line:<br/>
-&nbsp;&nbsp;`cd firmware`<br/>
-&nbsp;&nbsp;`STM32_Programmer_CLI -c port=/dev/tty.usbserial-0001 -w build/neodk_g071.hex -v`<br/>
-(Specify the COM port that corresponds to your USB-serial cable, in place of `/dev/tty.usbserial-0001`).<br/>
-If flashing was successful, execute:<br/>
-&nbsp;&nbsp;`STM32_Programmer_CLI -c port=/dev/tty.usbserial-0001 -g`<br/>
-This last command starts the firmware; the blue LED should light up and the box is ready for use. A power cycle instead of this command will have the same effect.