Merge branch 'dev'

Author: dsferruzza

.github/workflows/firmware-release.yml

@@ -16,16 +16,14 @@ jobs:
 
       - name: Install STM libs
         run: |
-          arduino-cli config init --additional-urls https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json
+          arduino-cli config init --additional-urls https://github.com/stm32duino/BoardManagerFiles/raw/master/package_stmicroelectronics_index.json
           arduino-cli config dump
           arduino-cli core update-index
-          export STM32DUINO_VERSION="1.9.0"
-          arduino-cli core install STM32:stm32@$STM32DUINO_VERSION
+          export STM32DUINO_VERSION="2.0.0"
+          arduino-cli core install STMicroelectronics:stm32@$STM32DUINO_VERSION
           arduino-cli lib install [email protected]
           arduino-cli lib install [email protected]
           arduino-cli lib install [email protected]
-          sed -i '/recipe.output.tmp_file={build.project_name}.hex/d' "$HOME/.arduino15/packages/STM32/hardware/stm32/$STM32DUINO_VERSION/platform.txt"
-          sed -i '/recipe.output.save_file={build.project_name}.{build.variant}.hex/d' "$HOME/.arduino15/packages/STM32/hardware/stm32/$STM32DUINO_VERSION/platform.txt"
 
       - name: Get the version
         id: version
@@ -41,7 +39,7 @@ jobs:
       - name: Build production HW3
         run: |
           sed -Ei 's/#define MODE .+/#define MODE MODE_PROD/' includes/config.h
-          arduino-cli compile --fqbn STM32: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 output/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"
@@ -50,7 +48,7 @@ jobs:
         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 STM32: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 output/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"

.gitignore

@@ -10,3 +10,7 @@
 /*.ods#
 build/*
 .scannerwork
+
+flash.sh
+
+srcs/srcs.ino

CHANGELOG.md

@@ -2,12 +2,18 @@
 
 ## unreleased
 
+_Nothing for now_
+
+## v4.0.0
+
 - drop support of electronic hardware v1 and v2
   (_from now on, minimum compatibility is from v3_)
 - refactor main loop and breathing control
   (_breathing-related computations are now triggered by a hardware timer_)
 - support several breathing modes
-  (_PC-CMV stays the default mode, PC-BIPAP was added_)
+  (_PC-CMV stays the default mode, PC-VSAI and PC-AC were added_)
+- added volume controlled ventilation modes
+  (_VC-CMV and VC-AC were added_)
 - telemetry protocol v2 was introduced
   (_basically, this means sending more data_)
 - drop support of useless "qualification" and "integration test" modes
@@ -21,9 +27,27 @@
 - allow to snooze alarms or start/stop breathing using the serial control protocol
 - drop support of old valves and pneumatic systems
 - make mass flow meter more reliable
+- support for SFM mass flow meters
+  (_SFM3019 and SFM_3300D_)
+- added support for a mass flow meter on the expiratory branch
+  (_if it is missing, the expiratory flow rate will be estimated using an algorithm_)
 - turn the green LED on when alarms are snoozed
+- added a facility to pre-configure the ventilator settings upon boot, using a patient height setting
+  (_submitting the patient height will update all ventilation hyperparameters to optimum values_)
+- added configurable alarms for pressure and volume modes, adding to all existing alarms
+- sending more measured values for display, e.g. respiratory durations and cycles per minute
+- a more precise battery voltage value is now sent over the telemetry protocol
+  (_this is used for battery SoC estimations_)
 - display a special message on LCD screen when watchdog reset was triggered
+- ability to detect in a reliable way when AC gets off, and that power is switched to battery
 - allow to retry pressure calibration when it fails
+- added a ramp-up algorithm on the blower speed controller, in order to prevent current surges in the transformer, which could trigger a temporary handover on batteries
+  (_this is a security feature, in cases where batteries would be depleted or not connected, the ventilator would suddenly reboot during use_)
+- added a compilation flag to disable all hardware buttons
+  (_this is used for touchscreen-only MakAir devices, i.e. non-traditional ones_)
+- added basic support for the motherboard V3 EEPROM chip over I2C
+  (_disabled by default until stable_)
+- a lot of potential exceptions due to possible divisions by zero have been fixed
 - increase the size of the hardware buffer used by telemetry
 - improve Doxygen documentation
 

Doxyfile

@@ -44,7 +44,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Software Firmware (MakAir — Covid-19 Respirator)"
+PROJECT_BRIEF          = "MakAir Firmware"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55

README.md

@@ -10,15 +10,15 @@
 | V1.3.x | Add Hardware V2 support | ✅
 | V1.5.x | Rework ventilation algorithms (pressure control, alarms, code quality) | ✅
 | V3.0.x | Support for triggers, add mass flow meter, add Hardware V3 support | ✅
-| V4.0.x | Protocol V2 with ventilation modes, drop Hardware V1 & V2 support | ❌
+| V4.0.x | Protocol V2 with ventilation modes, drop Hardware V1 & V2 support | ✅
 
 For a full history of all minor versions, as well as details of all changes, see [CHANGELOG.md](CHANGELOG.md).
 
 ## ⚛️ Latest Improvements
 
-A bleeding edge firmware version is available on the [dev](https://github.com/makers-for-life/makair-firmware/tree/dev) branch, which contains our latest improvements, ventilation modes and safety fixes.
+A _bleeding edge_ firmware version is available on the [dev](https://github.com/makers-for-life/makair-firmware/tree/dev) branch, which contains our latest improvements. This firmware version might still be work in progress and thus might not be suitable for production use.
 
-**⚠️ Note that the `master` branch contains a legacy firmware version, that will not work with the latest version of [makair-control-ui](https://github.com/makers-for-life/makair-firmware/tree/dev), please use the `dev` branch instead.**
+**⚠️ Note that the `master` branch may not contain the latest firmware version. It might not work with the latest version of [makair-control-ui](https://github.com/makers-for-life/makair-control-ui). In this case, please use the `dev` branch instead.**
 
 ## Releases
 
@@ -30,18 +30,20 @@ Code documentation can be [found there](https://makers-for-life.github.io/makair
 
 ## How To Build?
 
+First, make sure `arduino-cli` is installed on your system. The supported version is `0.9.0`. _Newer versions are known to cause issues with compiling the firmware code._
+
 In order to setup your environment and build the code, please follow the following commands (for MacOS):
 
 1. `brew install arduino-cli`
-2. `arduino-cli config init --additional-urls https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json`
+2. `arduino-cli config init --additional-urls https://github.com/stm32duino/BoardManagerFiles/raw/master/package_stmicroelectronics_index.json`
 3. `arduino-cli core update-index`
-4. `arduino-cli core install STM32:stm32@1.9.0`
+4. `arduino-cli core install STMicroelectronics:stm32@2.0.0`
 5. `arduino-cli lib install [email protected] && arduino-cli lib install [email protected] && arduino-cli lib install [email protected]`
 
 Then, compile the project:
 
 ```sh
-arduino-cli compile --fqbn STM32: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 output/respirator-production
 ```
 
 ## How To Flash?
@@ -53,13 +55,14 @@ 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 STM32: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 output/respirator-production
 ```
 
 _Make sure to replace {SERIAL_PORT} with your serial port, which should begin with `/dev/`._
 
 ## Configuration
 
-High-level configuration options are available and documented in [includes/config.h](includes/config.h).
+The configuration options can be found in the following files:
 
-Low-level configuration options can be found in [includes/parameters.h](includes/parameters.h).
+* High-level configuration options are available and documented in [includes/config.h](includes/config.h);
+* Low-level configuration options can be found in [includes/parameters.h](includes/parameters.h);

flash.sh

@@ -0,0 +1,2 @@
+arduino-cli compile --fqbn STM32:stm32:Nucleo_64:pnum=NUCLEO_F411RE srcs/respirator.cpp --output-dir output
+dfu-util -a 0 --dfuse-address 0x08000000 -D output/srcs.ino.bin

includes/alarm.h

@@ -55,6 +55,15 @@ class Alarm {
     /// Reset to zero the number of detection.
     void notDetected();
 
+    /// Enable this alarm
+    void enable();
+
+    /// Disable this alarm
+    void disable();
+
+    /// True if this alarm is enabled
+    bool isEnabled();
+
  private:
     /// Alarm priority
     AlarmPriority m_priority;
@@ -73,4 +82,7 @@ class Alarm {
 
     /// Number of cycles since the alarm was triggered
     uint32_t m_cyclesSinceTrigger;
+
+    /// Whether or not this alarm is enabled
+    bool m_enabled;
 };

includes/alarm_controller.h

@@ -15,20 +15,36 @@
 
 // CONSTANTS ==================================================================
 
-#define ALARMS_SIZE 10u
-
-#define RCM_SW_1 12u
-#define RCM_SW_2 11u
-#define RCM_SW_3 14u
-// #define RCM_SW_6 15u - NOT IN THIS VERSION
-// #define RCM_SW_8 18u - NOT IN THIS VERSION
-#define RCM_SW_11 21u
-#define RCM_SW_12 13u
-#define RCM_SW_14 22u
-#define RCM_SW_15 23u
-#define RCM_SW_16 31u
-#define RCM_SW_18 17u
-#define RCM_SW_19 24u
+#define ALARMS_SIZE 21u
+
+#define RCM_SW_1 12u   // Plateau pressure not reached
+#define RCM_SW_2 11u   // Patient is unplugged
+#define RCM_SW_3 14u   // Peep not reached
+#define RCM_SW_11 21u  // Battery Low
+#define RCM_SW_12 13u  // Battery vers Low
+#define RCM_SW_14 22u  // Plateau pressure not reached
+#define RCM_SW_15 23u  // Peep not reached
+#define RCM_SW_16 31u  // Mains disconnected
+#define RCM_SW_18 17u  // Pressure too high
+#define RCM_SW_19 24u  // Patient is unplugged
+
+#define RCM_SW_4 40u   // Inspiratory minute Volume is too low
+#define RCM_SW_5 41u   // Inspiratory minute Volume is too high
+#define RCM_SW_6 42u   // Expiratory minute Volume is too low
+#define RCM_SW_7 43u   // Expiratory minute Volume is too high
+#define RCM_SW_8 44u   // Respiratory rate is too low
+#define RCM_SW_9 45u   // Respiratory rate is too high
+#define RCM_SW_10 46u  // Leak is too high
+
+#define RCM_SW_20 47u  // Tidal Volume is too low
+#define RCM_SW_21 48u  // Tidal Volume is too high
+#define RCM_SW_22 49u  // peak pressure is too high
+#define RCM_SW_23 107u  // Expiratory flow too low
+
+/// List of alarms (named by their code)
+struct Alarms {
+    uint8_t alarms[ALARMS_SIZE];
+};
 
 // CLASS =====================================================================
 
@@ -89,6 +105,13 @@ class AlarmController {
     /// Get the alarms triggered during this cycle
     uint8_t* triggeredAlarms() { return m_triggeredAlarms; }
 
+    /**
+     * Update the list of enabled alarms (alarms not provided here will have no effects)
+     *
+     * @param enabledAlarms The new list of enabled alarms
+     */
+    void updateEnabledAlarms(Alarms enabledAlarms);
+
  private:
     /// Highest priority of the currently triggered alarms
     AlarmPriority m_highestPriority;

includes/battery.h

@@ -17,52 +17,52 @@
  * RawValue = (Vbat*0.1087)*1024/3.348
  * So, Vbat = RawValue * (3.348/(1024*0.1087))
  *
- * 1 bit = 3.348/(1024*0.1087) = 30.07mV
+ * 1 bit = 3.348/(4096*0.1087) = 7.5mV
  */
-#define RAW_BATTERY_MULTIPLIER 0.0300784843606
+#define RAW_BATTERY_MULTIPLIER 0.0075196210
 
 /**
  * Expected voltage in volts when power cord is plugged
  * 27,4 V => 27,4 / RAW_BATTERY_MULTIPLIER
  */
-#define RAW_VOLTAGE_MAINS 907
+#define RAW_VOLTAGE_MAINS 3643u
 
 /**
  * RCM_SW_16
  * Expected voltage in volts when power cord is unplugged
  *  = 27 => 27 / RAW_BATTERY_MULTIPLIER
  */
-#define RAW_VOLTAGE_ON_BATTERY_HIGH 897u
+#define RAW_VOLTAGE_ON_BATTERY_HIGH 3590u
 
 /**
  * Hysteresis is used to prevent fast switching when voltage is at the limit of 2 states
  *  analogRead(PIN) * RAW_BATTERY_MULTIPLIER = 0,1 => 0,1 / RAW_BATTERY_MULTIPLIER = 3
  */
-#define RAW_VOLTAGE_HYSTERESIS 3u
+#define RAW_VOLTAGE_HYSTERESIS 12u
 
 /**
  * RCM_SW_11
- *  = 24,6 => 24,6 / RAW_BATTERY_MULTIPLIER
+ *  = 23,2 => 23,2 / RAW_BATTERY_MULTIPLIER
  */
-#define RAW_VOLTAGE_ON_BATTERY 817u
+#define RAW_VOLTAGE_ON_BATTERY 3085u
 
 /**
  * RCM_SW_12
- *  = 24 => 24 / RAW_BATTERY_MULTIPLIER
+ *  = 22,6 => 22,6 / RAW_BATTERY_MULTIPLIER
  */
-#define RAW_VOLTAGE_ON_BATTERY_LOW 797u
+#define RAW_VOLTAGE_ON_BATTERY_LOW 3005u
 
 /**
  * Below this value, the machine wont start
  *  = 22 => 22 / RAW_BATTERY_MULTIPLIER
  */
-#define RAW_VOLTAGE_ON_BATTERY_NOT_STARTING_THRESHOLD 731u
+#define RAW_VOLTAGE_ON_BATTERY_NOT_STARTING_THRESHOLD 3191u
 
 /**
  * Below this value, the machine will stop immediately
  *  = 20 => 20 / RAW_BATTERY_MULTIPLIER
  */
-#define RAW_VOLTAGE_ON_BATTERY_STOP_THRESHOLD 664u
+#define RAW_VOLTAGE_ON_BATTERY_STOP_THRESHOLD 2660u
 
 /// Number of samples of the moving average
 #define BATTERY_MAX_SAMPLES 20u

includes/blower.h

@@ -41,19 +41,38 @@ class Blower {
     /// Initialize the hardware timer used to control the blower
     void setup();
 
+    /**
+     * Run the blower to a given speed applying a ramp-up to prevent high current drain
+     *
+     * @param p_targetSpeed Speed between MIN_BLOWER_SPEED and MAX_BLOWER_SPEED
+     */
+    void runSpeedWithRampUp(uint16_t p_targetSpeed);
+
     /**
      * Run the blower to a given speed
      *
-     * @param p_speed Speed between MIN_BLOWER_SPEED and MAX_BLOWER_SPEED
+     * @param p_runSpeed Speed between MIN_BLOWER_SPEED and MAX_BLOWER_SPEED
      */
-    void runSpeed(uint16_t p_speed);
+    void runSpeed(uint16_t p_runSpeed);
+
+    void execute();
 
     /// Stops the blower
     void stop();
 
     /// Get speed value
     uint16_t getSpeed() const;
 
+    /// Get target speed value
+    uint16_t getTargetSpeed() const;
+    /**
+     * Given a flow in mL/min, return an estimated pressure just at the output of the blower. This
+     * pressure has been determined using the pressure-flow characteristic of the blower
+     *
+     * @param p_flow inspiratory flow in mL/min
+     */
+    int32_t getBlowerPressure(int32_t p_flow);
+
  private:
     /// Hardware timer used to control the blower
     HardwareTimer* actuator;
@@ -67,8 +86,14 @@ class Blower {
     /// Current speed
     uint16_t m_speed;
 
+    /// target speed
+    uint16_t m_targetSpeed;
+
     /// Current state
     bool m_stopped;
+
+    // Last call of the runspeed function of the blower
+    uint32_t m_lastCallDate;
 };
 
 extern Blower blower;