Merge pull request #85 from makers-for-life/dev

Refactor directory structure (normalize & de-dup & clear unused files)

Author: valeriansaliou

.github/workflows/firmware-release.yml

@@ -39,19 +39,19 @@ jobs:
       - name: Build production HW3
         run: |
           sed -Ei 's/#define MODE .+/#define MODE MODE_PROD/' includes/config.h
-          arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output output/respirator-production
+          arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output builds/respirator-production
           mkdir -p dist/
           VERSION=$(sed -En 's/#define VERSION[ ]+["](.+)["]/\1/p' includes/parameters.h)
-          cp output/respirator-production.bin "dist/respirator-production-HW3-$VERSION-$GITHUB_SHA.bin"
+          cp builds/respirator-production.bin "dist/respirator-production-HW3-$VERSION-$GITHUB_SHA.bin"
 
       - name: Build production HW3 without mass flow meter
         run: |
           sed -Ei 's/#define MODE .+/#define MODE MODE_PROD/' includes/config.h
           sed -Ei 's/#define MASS_FLOW_METER_ENABLED/\/\/ #define MASS_FLOW_METER_ENABLED/' includes/config.h
-          arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output output/respirator-production
+          arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output builds/respirator-production
           mkdir -p dist/
           VERSION=$(sed -En 's/#define VERSION[ ]+["](.+)["]/\1/p' includes/parameters.h)
-          cp output/respirator-production.bin "dist/respirator-production-HW3-NOMASSFLOWMETER-$VERSION-$GITHUB_SHA.bin"
+          cp builds/respirator-production.bin "dist/respirator-production-HW3-NOMASSFLOWMETER-$VERSION-$GITHUB_SHA.bin"
 
       - name: Archive binaries
         uses: actions/upload-artifact@v1

.github/workflows/firmware-unit-tests.yml.disabled

@@ -26,7 +26,7 @@ jobs:
         # build unit test
         mkdir build_test
         cd build_test
-        cmake $GITHUB_WORKSPACE/test/
+        cmake $GITHUB_WORKSPACE/tests/
         cmake --build .
         # Run tests
         ctest

.gitignore

@@ -1,16 +1,11 @@
 /.pio/
 /.vscode/
+
 /local/
+/builds/*
+!/builds/.gitkeep
+
 .DS_Store
-/output/*
-!/output/.gitkeep
-/*.csv
-/*.ods
-/*.csv#
-/*.ods#
-build/*
 .scannerwork
 
-flash.sh
-
 srcs/srcs.ino

.sonarcloud/build-and-analyse-all.sh

@@ -16,7 +16,7 @@ do
       export MODE=${softwareModes[$softwareIndex]}
       export HARDWARE_VERSION=${hardwareVersions[$hardwareIndex]}
 
-      path="build/${SOFTWARE_FULLNAME}/bo"
+      path="builds/${SOFTWARE_FULLNAME}/bo"
 
       mkdir -p "$path"
 

.sonarcloud/build.sh

@@ -2,4 +2,4 @@
 
 sed -Ei "s/#define HARDWARE_VERSION [0-9]+/#define HARDWARE_VERSION ${HARDWARE_VERSION}/" includes/config.h
 sed -Ei "s/#define MODE .+/#define MODE ${MODE}/" includes/config.h
-arduino-cli compile --build-path "$PWD/build/$SOFTWARE_FULLNAME" --fqbn STM32:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output "output/$SOFTWARE_FULLNAME"
+arduino-cli compile --build-path "$PWD/builds/$SOFTWARE_FULLNAME" --fqbn STM32:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output "builds/$SOFTWARE_FULLNAME"

.travis.yml.disabled

@@ -44,7 +44,7 @@ In order to setup your environment and build the code, please follow the followi
 Then, compile the project:
 
 ```sh
-arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output output/respirator-production
+arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output builds/respirator-production
 ```
 
 ## How To Flash?
@@ -56,7 +56,7 @@ In order to flash the firmware that you just built using the instructions above:
 3. Make sure that [STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html) is installed on your computer, and run:
 
 ```sh
-arduino-cli upload --port {SERIAL_PORT} --fqbn STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_F411RE,upload_method=swdMethod --input output/respirator-production
+arduino-cli upload --port {SERIAL_PORT} --fqbn STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_F411RE,upload_method=swdMethod --input builds/respirator-production
 ```
 
 _Make sure to replace {SERIAL_PORT} with your serial port, which should begin with `/dev/`._
@@ -66,6 +66,7 @@ _Make sure to replace {SERIAL_PORT} with your serial port, which should begin wi
 A few scripts are available, eg. to automate repeated manual actions:
 
 1. **Compile & Flash**: `./scripts/compile_and_flash.sh` (compiles firmware and flashes it over the plugged STM32 programmer);
+2. **Compile Only**: `./scripts/compile_only.sh` (compiles firmware, useful to check for code mistakes);
 
 ## Configuration
 

README.md

@@ -19,7 +19,7 @@ pushd "$BASE_DIR" > /dev/null
 
     sleep 0.5
 
-    rm -f ./output/* || exit 1
+    rm -f ./builds/* || exit 1
 
     echo "Old builds cleared."
 
@@ -28,14 +28,14 @@ pushd "$BASE_DIR" > /dev/null
 
     sleep 0.5
 
-    arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output output/respirator-production || exit 1
+    arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output builds/respirator-production || exit 1
 
     # Flash new firmware
     echo ">> [3] Flashing new firmware..."
 
     sleep 0.5
 
-    arduino-cli upload --port "$SERIAL_PORT" --fqbn STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_F411RE,upload_method=swdMethod --input output/respirator-production || exit 1
+    arduino-cli upload --port "$SERIAL_PORT" --fqbn STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_F411RE,upload_method=swdMethod --input builds/respirator-production || exit 1
 
     sleep 0.5
 

build/build.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+ABSPATH=$(cd "$(dirname "$0")"; pwd)
+BASE_DIR="$ABSPATH/../"
+
+pushd "$BASE_DIR" > /dev/null
+  # Clear out built code
+  echo ">> [1] Clearing old builds..."
+
+  sleep 0.5
+
+  rm -f ./builds/* || exit 1
+
+  echo "Old builds cleared."
+
+  # Compile new firmware
+  echo ">> [2] Compiling new firmware..."
+
+  sleep 0.5
+
+  arduino-cli compile --fqbn STMicroelectronics:stm32:Nucleo_64:opt=o3std,pnum=NUCLEO_F411RE --verbose srcs/respirator.cpp --output builds/respirator-production || exit 1
+
+  sleep 0.5
+
+  echo "Success: All done. Firmware was compiled successfully."
+popd > /dev/null
+
+exit 0

build/build_deploy_and_monitor.sh

@@ -62,7 +62,7 @@ void eolScreenMessage(char* message, bool isFailed) {
     screen.print(eolTestNumber);
     if (isFailed) {
         screen.setCursor(15, 0);
-        screen.print("ECHEC");
+        screen.print("FAIL");
     } else {
         screen.setCursor(18, 0);
         screen.print("OK");
@@ -306,7 +306,7 @@ void millisecondTimerEOL(void)
             totalPushed += buttonsPushed[i];
         }
         (void)snprintf(eolScreenBuffer, EOLSCREENSIZE,
-                       "Please press each\nbutton... \n %d / 11 OK", totalPushed);
+                       "Please press each\nbutton... \n %d / %d OK", totalPushed, EOL_TOTALBUTTONS);
         if (totalPushed == EOL_TOTALBUTTONS) {
             eolTestNumber++;
             while (digitalRead(PIN_BTN_START) == HIGH) {
@@ -361,7 +361,7 @@ void millisecondTimerEOL(void)
     } else if (eolstep == MAX_PRESSURE_NOT_REACHED) {
         // FAIL: Case max pressure was not reached
         blower.stop();
-        (void)snprintf(eolScreenBuffer, EOLSCREENSIZE, "Pressure increase\nimpossible ! ");
+        (void)snprintf(eolScreenBuffer, EOLSCREENSIZE, "Pressure increase\nimpossible! ");
     } else if (eolstep == MAX_PRESSURE_REACHED_OK) {
         // Close the valves and wait 1000 ms
         inspiratoryValve.close();
@@ -418,7 +418,7 @@ void millisecondTimerEOL(void)
         }
     } else if (eolstep == MIN_PRESSURE_NOT_REACHED) {
         // FAIL: Case emptying the system did not work
-        (void)snprintf(eolScreenBuffer, EOLSCREENSIZE, "Opening valves\nimpossible ! ");
+        (void)snprintf(eolScreenBuffer, EOLSCREENSIZE, "Opening valves\nimpossible! ");
     } else if (eolstep == USER_CONFIRMATION_BEFORE_O2_TEST) {
         // Ask the operator to open the oxygen entrance, and wait for confirmation
         (void)snprintf(eolScreenBuffer, EOLSCREENSIZE,
@@ -455,7 +455,7 @@ void millisecondTimerEOL(void)
     } else if (eolstep == O2_PRESSURE_NOT_REACH) {
         // FAIL: the pressure did not bo above 100 mmh2O during O2 test
         blower.stop();
-        (void)snprintf(eolScreenBuffer, EOLSCREENSIZE, "Pipe O2\nBlocked ! ");
+        (void)snprintf(eolScreenBuffer, EOLSCREENSIZE, "Pipe O2\nBlocked! ");
     } else if (eolstep == WAIT_USER_BEFORE_LONG_RUN) {
         // Wait for user to press start before long run.
         blower.stop();

output/.gitkeep builds/.gitkeep

@@ -16,7 +16,7 @@
 1. Create a build folder and navigate to it
 2. Run:
     ```
-    cmake PATH/TO/test
+    cmake PATH/TO/tests
     cmake --build .
     ```
 In the build folder, the test executable will be created.