software:firmware
MakAir Firmware
Macros | Functions | Variables
serial_control.cpp File Reference

Handle control protocol on the serial input. More...

#include "../includes/config.h"
#include "../includes/serial_control.h"
#include "Arduino.h"
#include "CRC32.h"
#include "../includes/activation.h"
#include "../includes/alarm_controller.h"
#include "../includes/main_controller.h"
#include "../includes/rpi_watchdog.h"

Go to the source code of this file.

Macros

#define CONTROL_HEADER_SIZE   2
 Internals. More...
 
#define CONTROL_FOOTER_SIZE   2
 

Functions

uint16_t toU16 (byte bytes[])
 Convert an array of 2 bytes to a u16. More...
 
uint32_t toU32 (byte bytes[])
 Convert an array of 4 bytes to a u32. More...
 
void serialControlLoop ()
 Parse input and handle changes of settings. More...
 

Variables

static const uint8_t header [CONTROL_HEADER_SIZE] = {0x05, 0x0A}
 
static const uint8_t footer [CONTROL_FOOTER_SIZE] = {0x50, 0xA0}
 

Detailed Description

Handle control protocol on the serial input.

Author
Makers For Life
Copyright
Copyright (c) 2020 Makers For Life

Definition in file serial_control.cpp.

Macro Definition Documentation

◆ CONTROL_FOOTER_SIZE

#define CONTROL_FOOTER_SIZE   2

Definition at line 31 of file serial_control.cpp.

◆ CONTROL_HEADER_SIZE

#define CONTROL_HEADER_SIZE   2

Internals.

Definition at line 29 of file serial_control.cpp.

Function Documentation

◆ serialControlLoop()

void serialControlLoop ( )

Parse input and handle changes of settings.

Warning
This must be used after initTelemetry()

Definition at line 61 of file serial_control.cpp.

61  {
62  // Let's note this current time to avoid blocking too long here
63  int time = millis();
64 
65  // We need to ensure we received the whole message
66  while (((time + 2) >= millis()) && (Serial6.available() >= 11)) {
67  // Let's check the first header byte
68  if (Serial6.peek() == header[0]) {
69  // If it is correct, we discard it and continue
70  (void)Serial6.read();
71 
72  // Let's check the second header byte
73  if (Serial6.peek() == header[1]) {
74  // If it is correct, we discard it and continue
75  (void)Serial6.read();
76 
77  // Let's prepare to compute a CRC
78  CRC32 computedCRC;
79 
80  byte setting = Serial6.read();
81  computedCRC.update(setting);
82 
83  byte rawValue[2];
84  Serial6.readBytes(rawValue, 2);
85  computedCRC.update(rawValue, 2);
86  uint16_t value = toU16(rawValue);
87 
88  byte rawExpectedCRC[4];
89  Serial6.readBytes(rawExpectedCRC, 4);
90  uint32_t expectedCRC = toU32(rawExpectedCRC);
91 
92  // Let's check that the 2 bytes footer is correct
93  if ((Serial6.read() != footer[0]) || (Serial6.read() != footer[1])) {
94  DBG_DO(Serial.println(
95  "Invalid footer for control message; discarding whole message"));
96  continue;
97  }
98 
99  // The computed CRC must be the same as the one included with the message
100  if (expectedCRC != computedCRC.finalize()) {
101  DBG_DO(Serial.println(
102  "Invalid CRC for control message; discarding whole message"));
103  continue;
104  }
105 
106  DBG_DO({
107  Serial.print("Serial control message: setting = ");
108  Serial.print(setting);
109  Serial.print(", value = ");
110  Serial.print(value);
111  Serial.println();
112  });
113 
114  switch (setting) {
115  case Heartbeat:
116  if (value == DISABLE_RPI_WATCHDOG) {
117  rpiWatchdog.disable();
118  } else {
119  rpiWatchdog.resetCountDown();
120  }
121  break;
122 
123  case VentilationMode:
124  mainController.onVentilationModeSet(value);
125  break;
126 
127  case PlateauPressure:
128  mainController.onPlateauPressureSet(value);
129  break;
130 
131  case PEEP:
132  mainController.onPeepSet(value);
133  break;
134 
135  case CyclesPerMinute:
136  mainController.onCycleSet(value);
137  break;
138 
139  case ExpiratoryTerm:
140  mainController.onExpiratoryTermSet(value);
141  break;
142 
143  case TriggerEnabled:
144  mainController.onTriggerModeEnabledSet(value);
145  break;
146 
147  case TriggerOffset:
148  mainController.onTriggerOffsetSet(value);
149  break;
150 
151  case RespirationEnabled:
152  activationController.changeState(value);
153  break;
154 
155  case AlarmSnooze:
156  alarmController.snooze();
157  break;
158 
159  case InspiratoryTriggerFlow:
160  mainController.onInspiratoryTriggerFlowSet(value);
161  break;
162 
163  case ExpiratoryTriggerFlow:
164  mainController.onExpiratoryTriggerFlowSet(value);
165  break;
166 
167  case TiMin:
168  mainController.onTiMinSet(value);
169  break;
170 
171  case TiMax:
172  mainController.onTiMaxSet(value);
173  break;
174 
175  case LowInspiratoryMinuteVolumeAlarmThreshold:
176  mainController.onLowInspiratoryMinuteVolumeAlarmThresholdSet(value);
177  break;
178 
179  case HighInspiratoryMinuteVolumeAlarmThreshold:
180  mainController.onHighInspiratoryMinuteVolumeAlarmThresholdSet(value);
181  break;
182 
183  case LowExpiratoryMinuteVolumeAlarmThreshold:
184  mainController.onLowExpiratoryMinuteVolumeAlarmThresholdSet(value);
185  break;
186 
187  case HighExpiratoryMinuteVolumeAlarmThreshold:
188  mainController.onHighExpiratoryMinuteVolumeAlarmThresholdSet(value);
189  break;
190 
191  case LowRespiratoryRateAlarmThreshold:
192  mainController.onlowRespiratoryRateAlarmThresholdSet(value);
193  break;
194 
195  case HighRespiratoryRateAlarmThreshold:
196  mainController.onhighRespiratoryRateAlarmThresholdSet(value);
197  break;
198 
199  case TargetTidalVolume:
200  mainController.onTargetTidalVolumeSet(value);
201  break;
202 
203  case LowTidalVolumeAlarmThreshold:
204  mainController.onLowTidalVolumeAlarmThresholdSet(value);
205  break;
206 
207  case HighTidalVolumeAlarmThreshold:
208  mainController.onHighTidalVolumeAlarmThresholdSet(value);
209  break;
210 
211  case PlateauDuration:
212  mainController.onPlateauDurationSet(value);
213  break;
214 
215  case LeakAlarmThreshold:
216  mainController.onLeakAlarmThresholdSet(value);
217  break;
218 
219  case TargetInspiratoryFlow:
220  mainController.onTargetInspiratoryFlow(value);
221  break;
222 
223  case InspiratoryDuration:
224  mainController.onInspiratoryDuration(value);
225  break;
226 
227  case Locale:
228  // TODO
229  break;
230 
231  case PatientHeight:
232  mainController.onPatientHeight(value);
233  break;
234 
235  case PatientGender:
236  mainController.onPatientGender(value);
237  break;
238 
239  case PeakPressureAlarmThreshold:
240  mainController.onPeakPressureAlarmThreshold(value);
241  break;
242 
243  case EolConfirm:
244  eolTest.onConfirm();
245  break;
246 
247  default:
248  DBG_DO({
249  Serial.print("Unknown control setting: ");
250  Serial.print(setting);
251  Serial.println();
252  });
253  break;
254  }
255  } else {
256  // This is not the begining of a message, let's discard it
257  (void)Serial6.read();
258  DBG_DO(Serial.println("Invalid header for control message; discarding a byte"));
259  }
260  } else {
261  // This is not the begining of a message, let's discard it
262  (void)Serial6.read();
263  DBG_DO(Serial.println("Invalid header for control message; discarding a byte"));
264  }
265  }
266 }
activationController
ActivationController activationController
Instance of the activation controller.
Definition: activation.cpp:21
alarmController
AlarmController alarmController
Instance of the alarm controller.
Definition: alarm_controller.cpp:23
ActivationController::changeState
void changeState(uint16_t state)
Change the current state.
Definition: activation.cpp:29
AlarmController::snooze
void snooze()
Snooze alarm for 2 minutes.
Definition: alarm_controller.cpp:188
EolTest::onConfirm
void onConfirm()
Handle EOL confirm control setting from telemetry.
Definition: end_of_line_test.cpp:621
MainController::onTargetInspiratoryFlow
void onTargetInspiratoryFlow(uint16_t p_targetInspiratoryFlow)
Set the inspiratory flow target.
Definition: main_controller.cpp:1171
MainController::onTriggerOffsetSet
void onTriggerOffsetSet(uint16_t p_triggerOffset)
Set the desired offset for expiratory trigger.
Definition: main_controller.cpp:959
MainController::onInspiratoryDuration
void onInspiratoryDuration(uint16_t p_inspiratoryDuration)
Set the inspiration duration.
Definition: main_controller.cpp:1183
MainController::onCycleSet
void onCycleSet(uint16_t p_cpm)
Set the desired number of cycles per minute.
Definition: main_controller.cpp:780
MainController::onLowTidalVolumeAlarmThresholdSet
void onLowTidalVolumeAlarmThresholdSet(uint16_t p_lowTidalVolumeAlarmThreshold)
Set threshold on tidal volume below which an alarm is raised.
Definition: main_controller.cpp:1123
MainController::onlowRespiratoryRateAlarmThresholdSet
void onlowRespiratoryRateAlarmThresholdSet(uint16_t p_lowRespiratoryRateAlarmThreshold)
Set alarm threshold for low respiratory rate.
Definition: main_controller.cpp:1088
MainController::onLeakAlarmThresholdSet
void onLeakAlarmThresholdSet(uint16_t p_leakAlarmThreshold)
Set the threshold for leak that raise the alarm.
Definition: main_controller.cpp:1160
MainController::onExpiratoryTermSet
void onExpiratoryTermSet(uint16_t p_expiratoryTerm)
Set the desired expiratory term.
Definition: main_controller.cpp:936
MainController::onhighRespiratoryRateAlarmThresholdSet
void onhighRespiratoryRateAlarmThresholdSet(uint16_t p_highRespiratoryRateAlarmThreshold)
Set alarm threshold for high respiratory rate.
Definition: main_controller.cpp:1100
MainController::onTiMinSet
void onTiMinSet(uint16_t p_tiMin)
Set min inspiratory time.
Definition: main_controller.cpp:1000
MainController::onInspiratoryTriggerFlowSet
void onInspiratoryTriggerFlowSet(uint16_t p_inspiratoryTriggerFlow)
Set inspiratory trigger flow.
Definition: main_controller.cpp:974
MainController::onTiMaxSet
void onTiMaxSet(uint16_t p_tiMax)
Set max inspiratory time.
Definition: main_controller.cpp:1011
MainController::onPeepSet
void onPeepSet(int16_t p_peep)
Set the desired PEEP.
Definition: main_controller.cpp:823
MainController::onPeakPressureAlarmThreshold
void onPeakPressureAlarmThreshold(int16_t p_peakPressureAlarmThreshold)
Set the desired threshold for max peak pressure.
Definition: main_controller.cpp:1194
MainController::onLowExpiratoryMinuteVolumeAlarmThresholdSet
void onLowExpiratoryMinuteVolumeAlarmThresholdSet(uint16_t p_lowExpiratoryMinuteVolumeAlarmThreshold)
Set alarm threshold for low expiratory minute volume.
Definition: main_controller.cpp:1055
MainController::onPlateauPressureSet
void onPlateauPressureSet(int16_t p_plateauPressure)
Set the desired plateau pressure.
Definition: main_controller.cpp:870
MainController::onPatientHeight
void onPatientHeight(int16_t p_patientHeight)
Set the desired patient height.
Definition: main_controller.cpp:1205
MainController::onPatientGender
void onPatientGender(int16_t p_patientGender)
Set the desired patient gender.
Definition: main_controller.cpp:1220
MainController::onLowInspiratoryMinuteVolumeAlarmThresholdSet
void onLowInspiratoryMinuteVolumeAlarmThresholdSet(uint16_t p_lowInspiratoryMinuteVolumeAlarmThreshold)
Set alarm threshold for low inspiratory minute volume.
Definition: main_controller.cpp:1022
MainController::onHighInspiratoryMinuteVolumeAlarmThresholdSet
void onHighInspiratoryMinuteVolumeAlarmThresholdSet(uint16_t p_highInspiratoryMinuteVolumeAlarmThreshold)
Set alarm threshold for high inspiratory minute volume.
Definition: main_controller.cpp:1040
MainController::onVentilationModeSet
void onVentilationModeSet(uint16_t p_ventilationControllerMode)
Set ventilation mode.
Definition: main_controller.cpp:741
MainController::onTargetTidalVolumeSet
void onTargetTidalVolumeSet(uint16_t p_targetTidalVolume)
Set target tidal volume (used in VC modes)
Definition: main_controller.cpp:1113
MainController::onHighExpiratoryMinuteVolumeAlarmThresholdSet
void onHighExpiratoryMinuteVolumeAlarmThresholdSet(uint16_t p_highExpiratoryMinuteVolumeAlarmThreshold)
Set alarm threshold for high expiratory minute volume.
Definition: main_controller.cpp:1073
MainController::onPlateauDurationSet
void onPlateauDurationSet(uint16_t p_plateauDuration)
Set the duration of Pause at the end of expiration in VC modes.
Definition: main_controller.cpp:1147
MainController::onExpiratoryTriggerFlowSet
void onExpiratoryTriggerFlowSet(uint16_t p_expiratoryTriggerFlow)
Set expiratory trigger flow.
Definition: main_controller.cpp:987
MainController::onTriggerModeEnabledSet
void onTriggerModeEnabledSet(uint16_t p_triggerEnabled)
Enable or disable expiratory trigger mode.
Definition: main_controller.cpp:950
MainController::onHighTidalVolumeAlarmThresholdSet
void onHighTidalVolumeAlarmThresholdSet(uint16_t p_highTidalVolumeAlarmThreshold)
Set threshold on tidal volume for which an alarm is raised.
Definition: main_controller.cpp:1136
RpiWatchdog::disable
void disable()
Disable countdown mode (used for debug)
Definition: rpi_watchdog.cpp:58
RpiWatchdog::resetCountDown
void resetCountDown()
When the UI software on the Raspberry PI sends a heartbeat, reset countdown.
Definition: rpi_watchdog.cpp:50
DBG_DO
#define DBG_DO(statement)
Expand arbitrary code only when in debug mode.
Definition: debug.h:24
eolTest
EolTest eolTest
Definition: end_of_line_test.cpp:37
mainController
MainController mainController
Definition: main_controller.cpp:20
Serial6
HardwareSerial Serial6(PIN_TELEMETRY_SERIAL_RX, PIN_TELEMETRY_SERIAL_TX)
rpiWatchdog
RpiWatchdog rpiWatchdog
Definition: rpi_watchdog.cpp:16
header
static const uint8_t header[CONTROL_HEADER_SIZE]
Definition: serial_control.cpp:30
toU16
uint16_t toU16(byte bytes[])
Convert an array of 2 bytes to a u16.
Definition: serial_control.cpp:43
footer
static const uint8_t footer[CONTROL_FOOTER_SIZE]
Definition: serial_control.cpp:32
toU32
uint32_t toU32(byte bytes[])
Convert an array of 4 bytes to a u32.
Definition: serial_control.cpp:55
DISABLE_RPI_WATCHDOG
#define DISABLE_RPI_WATCHDOG
Special value that can be used in a heartbeat control message to disable RPi watchdog.
Definition: serial_control.h:11
PatientHeight
@ PatientHeight
Patient's height in centimeters.
Definition: serial_control.h:87
Heartbeat
@ Heartbeat
Heartbeat used for the RPi watchdog feature (value is ignored except for the special value DISABLE_RP...
Definition: serial_control.h:17
CyclesPerMinute
@ CyclesPerMinute
Number of cycles per minute (value bounds must be between 5 and 35)
Definition: serial_control.h:30
TiMin
@ TiMin
Minimum duration of inhalation in ms (value bounds must be between 100 and 3000)
Definition: serial_control.h:47
HighInspiratoryMinuteVolumeAlarmThreshold
@ HighInspiratoryMinuteVolumeAlarmThreshold
Threshold for high inspiratory minute volume alarm in L/min (value bounds must be between 10 and 40)
Definition: serial_control.h:55
RespirationEnabled
@ RespirationEnabled
State of the respiration (value must be 1 if enabled and 0 if disabled)
Definition: serial_control.h:39
ExpiratoryTriggerFlow
@ ExpiratoryTriggerFlow
Expiratory trigger flow in percent.
Definition: serial_control.h:45
LowTidalVolumeAlarmThreshold
@ LowTidalVolumeAlarmThreshold
Threshold for low tidal volume in mL (value bounds must be between 0 and 1000)
Definition: serial_control.h:71
TriggerEnabled
@ TriggerEnabled
State of the trigger (value must be 1 if enabled and 0 if disabled)
Definition: serial_control.h:35
PatientGender
@ PatientGender
Patient's gender (0 = male, 1 = female)
Definition: serial_control.h:89
EolConfirm
@ EolConfirm
Confirm end-of-line test step (value bounds must be between 0 and 0)
Definition: serial_control.h:93
HighRespiratoryRateAlarmThreshold
@ HighRespiratoryRateAlarmThreshold
Threshold for high respiratory rate alarm in cycle per minute (value bounds must be between 15 and 35...
Definition: serial_control.h:67
LowExpiratoryMinuteVolumeAlarmThreshold
@ LowExpiratoryMinuteVolumeAlarmThreshold
Threshold for low expiratory minute volume alarm in L/min (value bounds must be between 0 and 20)
Definition: serial_control.h:58
LowInspiratoryMinuteVolumeAlarmThreshold
@ LowInspiratoryMinuteVolumeAlarmThreshold
Threshold for low inspiratory minute volume alarm in L/min (value bounds must be between 0 and 20)
Definition: serial_control.h:52
TargetTidalVolume
@ TargetTidalVolume
Target tidal volume in mL (value bounds must be between 50 and 2000)
Definition: serial_control.h:69
LeakAlarmThreshold
@ LeakAlarmThreshold
Threshold for leak alarm in cL/min (value bounds must be between 0 and 10000)
Definition: serial_control.h:78
InspiratoryDuration
@ InspiratoryDuration
Duration of inspiration in ms (value bounds must be between 200 and 3000)
Definition: serial_control.h:82
HighTidalVolumeAlarmThreshold
@ HighTidalVolumeAlarmThreshold
Threshold for high tidal volume in mL (value bounds must be between 50 and 2000)
Definition: serial_control.h:73
TargetInspiratoryFlow
@ TargetInspiratoryFlow
Target flow during inspiration in L/min (value bounds must be between 5 and 80)
Definition: serial_control.h:80
HighExpiratoryMinuteVolumeAlarmThreshold
@ HighExpiratoryMinuteVolumeAlarmThreshold
Threshold for high expiratory minute volume alarm in L/min (value bounds must be between 10 and 40)
Definition: serial_control.h:61
InspiratoryTriggerFlow
@ InspiratoryTriggerFlow
Inspiratory trigger flow in percent.
Definition: serial_control.h:43
LowRespiratoryRateAlarmThreshold
@ LowRespiratoryRateAlarmThreshold
Threshold for low respiratory rate alarm in cycle per minute (value bounds must be between 5 and 25)
Definition: serial_control.h:64
Locale
@ Locale
Language of the system; this should be two letters (see ISO 639-1) in ASCII representation as two u8.
Definition: serial_control.h:85
ExpiratoryTerm
@ ExpiratoryTerm
Expiration term in the "Inspiration/Expiration" ratio given that Inspiration = 10 (value bounds must ...
Definition: serial_control.h:33
PlateauPressure
@ PlateauPressure
Plateau pressure in mmH2O (value bounds must be between 100 and 400)
Definition: serial_control.h:26
TiMax
@ TiMax
Maximum duration of inhalation in ms (value bounds must be between 200 and 5000)
Definition: serial_control.h:49
TriggerOffset
@ TriggerOffset
Trigger offset in mmH2O (value bounds must be between 0 and 100)
Definition: serial_control.h:37
PEEP
@ PEEP
PEEP in mmH2O (value bounds must be between 0 and 300)
Definition: serial_control.h:28
AlarmSnooze
@ AlarmSnooze
Alarm snooze (value must be 1 to snooze and 0 to unsnooze)
Definition: serial_control.h:41
VentilationMode
@ VentilationMode
Ventilation mode, must be one of the following:
Definition: serial_control.h:24
PeakPressureAlarmThreshold
@ PeakPressureAlarmThreshold
Threshold for peak pressure alarm in mmH2O (value bounds must be between 50 and 700)
Definition: serial_control.h:91
PlateauDuration
@ PlateauDuration
Duration in ms of closing both valves to effectively measure plateau pressure in volume control modes...
Definition: serial_control.h:76

◆ toU16()

uint16_t toU16 ( byte  bytes[])

Convert an array of 2 bytes to a u16.

Parameters
bytesArray of 2 elements
Returns
The corresponding u16 number

Definition at line 43 of file serial_control.cpp.

43  {
44  uint16_t num = (bytes[0] << 8) + bytes[1];
45  return num;
46 }

◆ toU32()

uint32_t toU32 ( byte  bytes[])

Convert an array of 4 bytes to a u32.

Parameters
bytesArray of 4 elements
Returns
The corresponding u32 number

Definition at line 55 of file serial_control.cpp.

55  {
56  uint32_t num = (bytes[0] << 24) + (bytes[1] << 16) + (bytes[2] << 8) + bytes[3];
57  return num;
58 }

Variable Documentation

◆ footer

const uint8_t footer[CONTROL_FOOTER_SIZE] = {0x50, 0xA0}
static

Definition at line 32 of file serial_control.cpp.

◆ header

const uint8_t header[CONTROL_HEADER_SIZE] = {0x05, 0x0A}
static

Definition at line 30 of file serial_control.cpp.