screen.h File Reference

Display and LCD screen related functions. More...

#include <LiquidCrystal.h>
#include "../includes/parameters.h"

Go to the source code of this file.

Functions
void	startScreen ()
	Start the screen. More...
void	resetScreen ()
	Erase everything that is on the screen. More...
void	displayCurrentPressure (uint16_t pressure, uint16_t cyclesPerMinute)
	Display the current step of the breathing. More...
void	displayCurrentVolume (int32_t volumeMassFlow, uint16_t cyclesPerMinute)
	Display the current injected air volume. More...
void	displayCurrentSettings (uint16_t peakPressureMax, uint16_t plateauPressureMax, uint16_t peepMin)
	Display the current settings. More...
void	displayCurrentInformation (uint16_t peakPressure, uint16_t plateauPressure, uint16_t peep)
	Display relevant values from the ongoing cycle. More...
void	displayAlarmInformation (uint8_t p_alarmCodes[], uint8_t p_nbTriggeredAlarms)
	Display triggered alarm codes. More...
void	displayPressureOffsetUnstable (uint32_t p_minOffsetValue, uint32_t p_maxOffsetValue)
	Display error when pressure offset is unstable. More...
void	displayPressureOffset (int32_t p_inspiratoryPressureSensorOffset)
	Display pressure offset. More...
void	displayFlowMeterFail (int32_t p_flowMeterFlowAtStarting, int32_t p_flowMeterFlowWithBlowerOn)
	Display error when flow meter fails. More...
void	displayFlowMeterOffset (int32_t p_flowMeterFlowOffset)
	Display flow meter offset. More...
void	displayPatientMustBeUnplugged ()
	Display the "calibration in progress" message. More...
void	displayEndOfLineTestMode ()
	Show that EOL mode was triggered. More...
void	displayBatteryDeepDischarge ()
	Display error when battery level is too discharged. More...
void	displayWatchdogError ()
	Display error when machine was restarted by watchdog. More...
void	displayMachineStopped ()
	Display a message when the machine is stopped. More...
void	clearAlarmDisplayCache ()
	Force clear the alarm display cache. More...
uint16_t	convertAndRound (uint16_t pressure)
	Convert and round a pressure value. More...

Variables
LiquidCrystal	screen
	Instance of the screen controller. More...

Detailed Description

Display and LCD screen related functions.

Author

Makers For Life

Copyright

Copyright (c) 2020 Makers For Life

This relies on the LiquidCrystal library (https://github.com/arduino-libraries/LiquidCrystal). LCD screen must have 4 lines of 20 characters.

Definition in file screen.h.

Function Documentation

clearAlarmDisplayCache()

void clearAlarmDisplayCache

(

)

Force clear the alarm display cache.

Definition at line 144 of file screen.cpp.

{ clearCache = true; }

convertAndRound()

uint16_t convertAndRound

(

uint16_t

pressure

)

Convert and round a pressure value.

Parameters

pressure

Pressure in mmH2O

Returns

Rounded pressure in cmH2O

Definition at line 275 of file screen.cpp.

                                            {
    uint16_t result;
    uint16_t lastDigit = pressure % 10u;
 
    if (lastDigit < 5u) {
        result = (pressure / 10u);
    } else {
        result = (pressure / 10u) + 1u;
    }
 
    return result;
}

displayAlarmInformation()

void displayAlarmInformation	(	uint8_t	p_alarmCodes[],
		uint8_t	p_nbTriggeredAlarms
	)

Display triggered alarm codes.

Parameters

p_alarmCodes	List of alarm codes to display
p_nbTriggeredAlarms	Number of triggered alarms

Definition at line 146 of file screen.cpp.

                                                                                  {
    // WARNING There is a risk of data not being displayed as expected
    // if the line is overwritten somewhere else in the code.
    if (hasAlarmInformationChanged(p_alarmCodes, p_nbTriggeredAlarms)) {
        if (p_nbTriggeredAlarms == 0u) {
            screen.setCursor(0, 2);
            screen.print(NO_ALARM_LINE);
        } else {
            uint8_t nbAlarmToPrint = min(MAX_ALARMS_DISPLAYED, p_nbTriggeredAlarms);
 
            // +1 for trailing NULL char
            char buf[SCREEN_LINE_LENGTH + 1];
 
            // Write beginning of line
            (void)strncpy(buf, ALARM_LINE, ALARMS_CODE_POS);
 
            // Write alarm codes
            int pos = ALARMS_CODE_POS;
            for (uint8_t i = 0; i < nbAlarmToPrint; i++) {
                int spaceLeft = SCREEN_LINE_LENGTH - pos;
                // + 1 for the trailing NULL char
                int n = snprintf(&buf[pos], spaceLeft + 1, " %u", p_alarmCodes[i]);
                if ((n < 0) || (n > spaceLeft)) {
                    break;  // Error or no space left in buffer
                }
                pos += n;
            }
 
            // Fill the end of the line with spaces
            (void)strncpy(&buf[pos], &ALARM_LINE[pos], SCREEN_LINE_LENGTH - pos);
 
            // Make sure string is NULL terminated
            buf[SCREEN_LINE_LENGTH] = '\0';
 
            screen.setCursor(0, 2);
            screen.print(buf);
        }
    }
}

displayBatteryDeepDischarge()

void displayBatteryDeepDischarge

(

)

Display error when battery level is too discharged.

Definition at line 260 of file screen.cpp.

                                   {
    screen.clear();
    screen.setCursor(0, 0);
    screen.print("Battery very low");
    screen.setCursor(0, 2);
    screen.print("Please charge");
    screen.setCursor(0, 3);
    screen.print("before running.");
}

displayCurrentInformation()

void displayCurrentInformation	(	uint16_t	peakPressure,
		uint16_t	plateauPressure,
		uint16_t	peep
	)

Display relevant values from the ongoing cycle.

Parameters

peakPressure	The peak pressure [mmH2O]
plateauPressure	The plateau pressure [mmH2O]
peep	The Positive End Expiratory Pressure (PEEP) [mmH2O]

Definition at line 91 of file screen.cpp.

                                                                                               {
    // cppcheck-suppress misra-c2012-12.3 ; call to unknown external: screen.setCursor
    screen.setCursor(0, 3);
    char message[SCREEN_LINE_LENGTH + 1];
 
    // If plateau was not detected
    if (plateauPressure == UINT16_MAX) {
        (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "%2u     ?    %2u  meas",
                       convertAndRound(peakPressure), convertAndRound(peep));
    } else {
        (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "%2u    %2u    %2u  meas",
                       convertAndRound(peakPressure), convertAndRound(plateauPressure),
                       convertAndRound(peep));
    }
 
    screen.print(message);
}

displayCurrentPressure()

void displayCurrentPressure	(	uint16_t	pressure,
		uint16_t	cyclesPerMinute
	)

Display the current step of the breathing.

Parameters

pressure	The current pressure [mmH2O]
cyclesPerMinute	Next desired number of cycles per minute

Definition at line 65 of file screen.cpp.

                                                                         {
    screen.setCursor(0, 0);
 
    char message[SCREEN_LINE_LENGTH + 1];
 
    (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "Pressure:%2u    %2ucpm",
                   convertAndRound(pressure), cyclesPerMinute);
 
    screen.print(message);
}

displayCurrentSettings()

void displayCurrentSettings	(	uint16_t	peakPressureMax,
		uint16_t	plateauPressureMax,
		uint16_t	peepMin
	)

Display the current settings.

Parameters

peakPressureMax	PeakPressureMax [mmH2O]
plateauPressureMax	Next maximal plateau pressure [mmH2O]
peepMin	Next desired Positive End Expiratory Pressure (PEEP) [mmH2O]

Definition at line 76 of file screen.cpp.

                                              {
    // cppcheck-suppress misra-c2012-12.3
    screen.setCursor(0, 1);
 
    char message[SCREEN_LINE_LENGTH + 1];
 
    (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "%2u    %2u    %2u  set ",
                   convertAndRound(peakPressureMax), convertAndRound(plateauPressureMax),
                   convertAndRound(peepMin));
 
    screen.print(message);
}

displayCurrentVolume()

void displayCurrentVolume	(	int32_t	volumeMassFlow,
		uint16_t	cyclesPerMinute
	)

Display the current injected air volume.

Parameters

volumeMassFlow	The number of liter breathed in this cycle
cyclesPerMinute	Next desired number of cycles per minute

Definition at line 53 of file screen.cpp.

                                                                            {
    screen.setCursor(0, 0);
 
    char message[SCREEN_LINE_LENGTH + 1];
 
    (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "Cpm:%2u      %4dml", cyclesPerMinute,
                   volumeMassFlow);
 
    screen.print(message);
}

displayEndOfLineTestMode()

void displayEndOfLineTestMode

(

)

Show that EOL mode was triggered.

Definition at line 245 of file screen.cpp.

                                {
    screen.clear();
    screen.print("EOL Test Mode");
}

displayFlowMeterFail()

void displayFlowMeterFail	(	int32_t	p_flowMeterFlowAtStarting,
		int32_t	p_flowMeterFlowWithBlowerOn
	)

Display error when flow meter fails.

Parameters

p_flowMeterFlowAtStarting	Measured flow offset value
p_flowMeterFlowWithBlowerOn	Maximum measured flow offset value

Definition at line 194 of file screen.cpp.

                                                                                                  {
    resetScreen();
    screen.setCursor(0, 0);
    char line1[SCREEN_LINE_LENGTH + 1];
    (void)snprintf(line1, SCREEN_LINE_LENGTH + 1, "Flow offset: %3d SLM",
                   p_flowMeterFlowAtStarting / 1000);
    screen.print(line1);
    screen.setCursor(0, 1);
    char line2[SCREEN_LINE_LENGTH + 1];
    (void)snprintf(line2, SCREEN_LINE_LENGTH + 1, "Max flow:  %-3d SLM",
                   p_flowMeterFlowWithBlowerOn / 1000);
    screen.print(line2);
    screen.setCursor(0, 2);
    screen.print("Flow meter fail");
    screen.setCursor(0, 3);
    screen.print("Press start to retry");
}

displayFlowMeterOffset()

void displayFlowMeterOffset

(

int32_t

p_flowMeterFlowOffset

)

Display flow meter offset.

Parameters

p_flowMeterFlowOffset

Measured flow offset value

Definition at line 212 of file screen.cpp.

                                                           {
    screen.setCursor(0, 3);
    char message[SCREEN_LINE_LENGTH + 1];
    (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "Flow offset: %3d SLM", p_flowMeterFlowOffset);
    screen.print(message);
}

displayMachineStopped()

void displayMachineStopped

(

)

Display a message when the machine is stopped.

Definition at line 270 of file screen.cpp.

                             {
    screen.setCursor(0, 3);
    screen.print("Press start to begin");
}

displayPatientMustBeUnplugged()

void displayPatientMustBeUnplugged

(

)

Display the "calibration in progress" message.

Definition at line 236 of file screen.cpp.

                                     {
    screen.setCursor(0, 0);
    screen.print("Calibration");
    screen.setCursor(0, 2);
    screen.print("Patient must be");
    screen.setCursor(0, 3);
    screen.print("unplugged");
}

displayPressureOffset()

void displayPressureOffset

(

int32_t

p_inspiratoryPressureSensorOffset

)

Display pressure offset.

Parameters

p_inspiratoryPressureSensorOffset

Measured offset value

Definition at line 186 of file screen.cpp.

                                                                      {
    screen.setCursor(0, 3);
    char message[SCREEN_LINE_LENGTH + 1];
    (void)snprintf(message, SCREEN_LINE_LENGTH + 1, "P offset: %3d mmH2O",
                   p_inspiratoryPressureSensorOffset);
    screen.print(message);
}

displayPressureOffsetUnstable()

void displayPressureOffsetUnstable	(	uint32_t	p_minOffsetValue,
		uint32_t	p_maxOffsetValue
	)

Display error when pressure offset is unstable.

Parameters

p_minOffsetValue	Minimum measured offset value
p_maxOffsetValue	Maximum measured offset value

Definition at line 219 of file screen.cpp.

                                                                                         {
    resetScreen();
    screen.setCursor(0, 0);
    char line1[SCREEN_LINE_LENGTH + 1];
    (void)snprintf(line1, SCREEN_LINE_LENGTH + 1, "P offset is unstable");
    screen.print(line1);
    screen.setCursor(0, 1);
    char line2[SCREEN_LINE_LENGTH + 1];
    (void)snprintf(line2, SCREEN_LINE_LENGTH + 1, "Max-Min: %3u mmH2O",
                   p_maxOffsetValue - p_minOffsetValue);
    screen.print(line2);
    screen.setCursor(0, 2);
    screen.print("Unplug patient and");
    screen.setCursor(0, 3);
    screen.print("press start");
}

displayWatchdogError()

void displayWatchdogError

(

)

Display error when machine was restarted by watchdog.

Definition at line 250 of file screen.cpp.

                            {
    screen.clear();
    screen.setCursor(0, 0);
    screen.print("An error has occured");
    screen.setCursor(0, 2);
    screen.print("Check the machine");
    screen.setCursor(0, 3);
    screen.print("before re-using");
}

resetScreen()

void resetScreen

(

)

Erase everything that is on the screen.

Definition at line 50 of file screen.cpp.

{ screen.clear(); }

startScreen()

void startScreen

(

)

Start the screen.

Warning

It must be called once to be able to use the screen

Definition at line 42 of file screen.cpp.

                   {
    screen.begin(SCREEN_LINE_LENGTH, SCREEN_LINE_NUMBER);
    screen.setCursor(0, 0);
    screen.print("Initialization      ");
    screen.setCursor(0, 1);
    screen.print(VERSION);
}

Variable Documentation

screen

LiquidCrystal screen

extern

Instance of the screen controller.