Manage alarm features. More...

#include <alarm_controller.h>

Public Member Functions
	AlarmController ()
	Default constructor. More...

void	snooze ()
	Snooze alarm for 2 minutes. More...

void	unsnooze ()
	Unsnooze alarms. More...

bool	isSnoozed () const
	Check if alarms are currently snoozed. More...

void	detectedAlarm (uint8_t p_alarmCode, uint32_t p_cycleNumber, uint32_t p_expected, uint32_t p_measured)
	Mark a specific alarm as detected. More...

void	notDetectedAlarm (uint8_t p_alarmCode)
	Reset detection of a specific alarm. More...

void	runAlarmEffects (uint32_t p_tick)
	Run effects (buzzer, LCD message, LED) according to the currently triggered alarms. More...

void	updateCoreData (uint32_t p_tick, uint16_t p_pressure, CyclePhases p_phase, uint32_t p_cycle_number)
	Update internal state of alarm controller with data from pressure controller. More...

uint8_t *	triggeredAlarms ()
	Get the alarms triggered during this cycle. More...

void	updateEnabledAlarms (Alarms enabledAlarms)
	Update the list of enabled alarms (alarms not provided here will have no effects) More...

Private Attributes
AlarmPriority	m_highestPriority
	Highest priority of the currently triggered alarms. More...

uint32_t	m_snoozeTime
	Time when snoozed was triggered. More...

Alarm	m_alarms [ALARMS_SIZE]
	Collections of available alarms. More...

bool	m_snoozedAlarms [ALARMS_SIZE]
	Collections of snoozed alarms. More...

uint8_t	m_triggeredAlarms [ALARMS_SIZE]
	Alarms currently triggered. More...

uint16_t	m_tick
	Current pressure. More...

uint16_t	m_pressure
	Current pressure. More...

CyclePhases	m_phase
	Current phase. More...

uint32_t	m_cycle_number
	Current cycle number. More...

bool	m_unsnooze
	Is unsnoozed right now. More...

Detailed Description

Manage alarm features.

Definition at line 52 of file alarm_controller.h.

Constructor & Destructor Documentation

◆ AlarmController()

AlarmController::AlarmController ( )

Default constructor.

Definition at line 27 of file alarm_controller.cpp.

     : m_highestPriority(AlarmPriority::ALARM_NONE),
       m_snoozeTime(0u),
       m_alarms({
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_2, 3u),
  
           /* RCM-SW-1
            * The device shall embed a high priority alarm 12 when the plateau pressure is not
            * reached (absolute difference > 20% in absolute value) from the 3th respiratory cycle.
            */
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_1, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_12, 1u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_3, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_4, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_5, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_6, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_7, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_8, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_9, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_10, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_18, 1u),
  
           Alarm(AlarmPriority::ALARM_MEDIUM, RCM_SW_11, 1u),
  
           Alarm(AlarmPriority::ALARM_MEDIUM, RCM_SW_14, 2u),
  
           Alarm(AlarmPriority::ALARM_MEDIUM, RCM_SW_15, 2u),
  
           Alarm(AlarmPriority::ALARM_MEDIUM, RCM_SW_19, 2u),
  
           Alarm(AlarmPriority::ALARM_LOW, RCM_SW_16, 1u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_20, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_21, 3u),
  
           Alarm(AlarmPriority::ALARM_HIGH, RCM_SW_22, 1u),
  
           Alarm(AlarmPriority::ALARM_MEDIUM, RCM_SW_23, 3u),
       }),
  
       m_tick(0u),
       m_unsnooze(true),
       m_pressure(0u),
       m_phase(CyclePhases::INHALATION),
       // cppcheck-suppress misra-c2012-5.2 ; false positive
       m_cycle_number(0u) {
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         m_snoozedAlarms[i] = false;
     }
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         m_triggeredAlarms[i] = 0u;
     }
 }

Member Function Documentation

◆ detectedAlarm()

void AlarmController::detectedAlarm	(	uint8_t	p_alarmCode,
		uint32_t	p_cycleNumber,
		uint32_t	p_expected,
		uint32_t	p_measured
	)

Mark a specific alarm as detected.

Parameters

p_alarmCode	The code of the alarm
p_cycleNumber	The cycle number since the device startup
p_expected	The expected value
p_measured	The measured value that was different from the expected value thus triggering the alarm

Definition at line 207 of file alarm_controller.cpp.

                                                          {
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         Alarm* current = &m_alarms[i];
         bool wasTriggered = current->isTriggered();
         if (current->isEnabled() && (current->getCode() == p_alarmCode)) {
             current->detected(p_cycleNumber);
  
             if (current->isTriggered()) {
                 for (uint8_t j = 0; j < ALARMS_SIZE; j++) {
                     if (m_triggeredAlarms[j] == p_alarmCode) {
                         break;
                     }
                     if (m_triggeredAlarms[j] == 0u) {
                         m_triggeredAlarms[j] = p_alarmCode;
                         break;
                     }
                 }
  
                 if (!wasTriggered) {
                     sendAlarmTrap(m_tick, m_pressure, m_phase, m_cycle_number, current->getCode(),
                                   current->getPriority(), true, p_expected, p_measured,
                                   current->getCyclesSinceTrigger());
                 }
             }
             break;
         }
     }
 }

◆ isSnoozed()

bool AlarmController::isSnoozed ( ) const

inline

Check if alarms are currently snoozed.

Definition at line 70 of file alarm_controller.h.

70 { return !m_unsnooze; }

◆ notDetectedAlarm()

void AlarmController::notDetectedAlarm ( uint8_t p_alarmCode )

Reset detection of a specific alarm.

Parameters

p_alarmCode The code of the alarm

Definition at line 241 of file alarm_controller.cpp.

                                                           {
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         Alarm* current = &m_alarms[i];
         bool wasTriggered = current->isTriggered();
         if (current->getCode() == p_alarmCode) {
             current->notDetected();
  
             if (!current->isTriggered()) {
                 for (uint8_t j = 0; j < ALARMS_SIZE; j++) {
                     if (m_triggeredAlarms[j] == p_alarmCode) {
                         m_triggeredAlarms[j] = 0u;
                         std::sort(m_triggeredAlarms, &m_triggeredAlarms[ALARMS_SIZE], compare);
                         break;
                     }
                 }
  
                 if (wasTriggered) {
                     sendAlarmTrap(m_tick, m_pressure, m_phase, m_cycle_number, current->getCode(),
                                   current->getPriority(), false, 0u, 0u,
                                   current->getCyclesSinceTrigger());
                 }
             }
             break;
         }
     }
 }

◆ runAlarmEffects()

void AlarmController::runAlarmEffects ( uint32_t p_tick )

Run effects (buzzer, LCD message, LED) according to the currently triggered alarms.

Parameters

p_tick Centile in the respiratory cycle

Definition at line 268 of file alarm_controller.cpp.

                                                      {
     AlarmPriority highestPriority = AlarmPriority::ALARM_NONE;
     uint8_t triggeredAlarmCodes[ALARMS_SIZE];
     uint8_t numberOfTriggeredAlarms = 0;
     bool justUnsnoozed = false;
  
     //
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         Alarm* current = &m_alarms[i];
         if (current->isTriggered()) {
             if (numberOfTriggeredAlarms == 0u) {
                 highestPriority = current->getPriority();
             }
  
             triggeredAlarmCodes[numberOfTriggeredAlarms] = current->getCode();
             numberOfTriggeredAlarms++;
  
             if (!m_unsnooze && !m_snoozedAlarms[i]) {
                 unsnooze();
                 justUnsnoozed = true;
             }
         } else {
             m_snoozedAlarms[i] = false;
         }
     }
  
     uint32_t millisSinceSnooze = millis() - m_snoozeTime;
     if (!m_unsnooze && (m_snoozeTime > 0u) && (millisSinceSnooze >= 120000u)) {
         unsnooze();
     }
  
     if ((p_tick % (LCD_UPDATE_PERIOD_US / MAIN_CONTROLLER_COMPUTE_PERIOD_MICROSECONDS)) == 0u) {
         displayAlarmInformation(triggeredAlarmCodes, numberOfTriggeredAlarms);
     }
  
     if (highestPriority == AlarmPriority::ALARM_HIGH) {
         if ((m_highestPriority != highestPriority) || justUnsnoozed) {
             if (m_unsnooze) {
                 Buzzer_High_Prio_Start();
             }
         }
  
         if ((p_tick % 100u) == 50u) {
             digitalWrite(PIN_LED_RED, LED_RED_ACTIVE);
         } else if ((p_tick % 100u) == 0u) {
             digitalWrite(PIN_LED_RED, LED_RED_INACTIVE);
         } else {
         }
         digitalWrite(PIN_LED_YELLOW, LED_YELLOW_INACTIVE);
     } else if (highestPriority == AlarmPriority::ALARM_MEDIUM) {
         if ((m_highestPriority != highestPriority) || justUnsnoozed) {
             if (m_unsnooze) {
                 Buzzer_Medium_Prio_Start();
             }
         }
         digitalWrite(PIN_LED_RED, LED_RED_INACTIVE);
         if ((p_tick % 100u) == 50u) {
             digitalWrite(PIN_LED_YELLOW, LED_YELLOW_ACTIVE);
         } else if ((p_tick % 100u) == 0u) {
             digitalWrite(PIN_LED_YELLOW, LED_YELLOW_INACTIVE);
         } else {
         }
     } else if (highestPriority == AlarmPriority::ALARM_LOW) {
         if ((m_highestPriority != highestPriority) || justUnsnoozed) {
             if (m_unsnooze) {
                 Buzzer_Low_Prio_Start();
             }
         }
  
         digitalWrite(PIN_LED_RED, LED_RED_INACTIVE);
         digitalWrite(PIN_LED_YELLOW, LED_YELLOW_ACTIVE);
     } else {
         Buzzer_Stop();
  
         digitalWrite(PIN_LED_RED, LED_RED_INACTIVE);
         digitalWrite(PIN_LED_YELLOW, LED_YELLOW_INACTIVE);
     }
  
     m_highestPriority = highestPriority;
 }

◆ snooze()

void AlarmController::snooze ( )

Snooze alarm for 2 minutes.

There is no more buzzer during the alarm

Definition at line 188 of file alarm_controller.cpp.

                              {
     if (m_unsnooze) {
         m_unsnooze = false;
         digitalWrite(PIN_LED_GREEN, LED_GREEN_ACTIVE);
         m_snoozeTime = millis();
         for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
             Alarm* current = &m_alarms[i];
             if (current->isTriggered()) {
                 m_snoozedAlarms[i] = true;
             } else {
                 m_snoozedAlarms[i] = false;
             }
         }
  
         Buzzer_Mute();
     }
     sendControlAck(9, !m_unsnooze);
 }

◆ triggeredAlarms()

uint8_t* AlarmController::triggeredAlarms ( )

inline

Get the alarms triggered during this cycle.

Definition at line 106 of file alarm_controller.h.

106 { return m_triggeredAlarms; }

◆ unsnooze()

void AlarmController::unsnooze ( )

Unsnooze alarms.

Definition at line 350 of file alarm_controller.cpp.

                                {
     digitalWrite(PIN_LED_GREEN, LED_GREEN_INACTIVE);
     m_snoozeTime = 0u;
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         m_snoozedAlarms[i] = false;
     }
     m_unsnooze = true;
     sendControlAck(9, !m_unsnooze);
 }

◆ updateCoreData()

void AlarmController::updateCoreData	(	uint32_t	p_tick,
		uint16_t	p_pressure,
		CyclePhases	p_phase,
		uint32_t	p_cycle_number
	)

Update internal state of alarm controller with data from pressure controller.

Definition at line 361 of file alarm_controller.cpp.

                                                               {
     m_tick = p_tick;
     m_pressure = p_pressure;
     m_phase = p_phase;
     m_cycle_number = p_cycle_number;
 }

◆ updateEnabledAlarms()

void AlarmController::updateEnabledAlarms ( Alarms enabledAlarms )

Update the list of enabled alarms (alarms not provided here will have no effects)

Parameters

enabledAlarms The new list of enabled alarms

Definition at line 371 of file alarm_controller.cpp.

                                                               {
     // Untrigger every alarms
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         m_triggeredAlarms[i] = 0u;
     }
  
     // First Disable every alarms
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         m_alarms[i].disable();
     }
  
     // Then Enable provided alarms
     for (uint8_t i = 0; i < ALARMS_SIZE; i++) {
         if (enabledAlarms.alarms[i] != 0u) {
             for (uint8_t j = 0; j < ALARMS_SIZE; j++) {
                 if (m_alarms[j].getCode() == enabledAlarms.alarms[i]) {
                     m_alarms[j].enable();
                     break;
                 }
             }
         }
     }
 }

Member Data Documentation

◆ m_alarms

Alarm AlarmController::m_alarms[ALARMS_SIZE]

private

Collections of available alarms.

Definition at line 123 of file alarm_controller.h.

◆ m_cycle_number

uint32_t AlarmController::m_cycle_number

private

Current cycle number.

Definition at line 141 of file alarm_controller.h.

◆ m_highestPriority

AlarmPriority AlarmController::m_highestPriority

private

Highest priority of the currently triggered alarms.

Definition at line 117 of file alarm_controller.h.

◆ m_phase

CyclePhases AlarmController::m_phase

private

Current phase.

Definition at line 138 of file alarm_controller.h.

◆ m_pressure

uint16_t AlarmController::m_pressure

private

Current pressure.

Definition at line 135 of file alarm_controller.h.

◆ m_snoozedAlarms

bool AlarmController::m_snoozedAlarms[ALARMS_SIZE]

private

Collections of snoozed alarms.

Definition at line 126 of file alarm_controller.h.

◆ m_snoozeTime

uint32_t AlarmController::m_snoozeTime

private

Time when snoozed was triggered.

Definition at line 120 of file alarm_controller.h.

◆ m_tick

uint16_t AlarmController::m_tick

private

Current pressure.

Definition at line 132 of file alarm_controller.h.

◆ m_triggeredAlarms

uint8_t AlarmController::m_triggeredAlarms[ALARMS_SIZE]

private

Alarms currently triggered.

Definition at line 129 of file alarm_controller.h.

◆ m_unsnooze

bool AlarmController::m_unsnooze

private

Is unsnoozed right now.

Definition at line 144 of file alarm_controller.h.

The documentation for this class was generated from the following files:

includes/alarm_controller.h
srcs/alarm_controller.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AlarmController()

Member Function Documentation

◆ detectedAlarm()

◆ isSnoozed()

◆ notDetectedAlarm()

◆ runAlarmEffects()

◆ snooze()

◆ triggeredAlarms()

◆ unsnooze()

◆ updateCoreData()

◆ updateEnabledAlarms()

Member Data Documentation

◆ m_alarms

◆ m_cycle_number

◆ m_highestPriority

◆ m_phase

◆ m_pressure

◆ m_snoozedAlarms

◆ m_snoozeTime

◆ m_tick

◆ m_triggeredAlarms

◆ m_unsnooze