keyboard.cpp File Reference

Buttons related functions. More...

#include "../includes/keyboard.h"
#include <OneButton.h>
#include "../includes/activation.h"
#include "../includes/buzzer.h"
#include "../includes/calibration.h"
#include "../includes/config.h"
#include "../includes/debug.h"
#include "../includes/main_controller.h"
#include "../includes/parameters.h"

Go to the source code of this file.

Macros
#define	SM_DEBOUNCE   2u
#define	SM_REPEAT   20u
#define	SM_PERIOD   15u

Functions
static OneButton	buttonAlarmOff (PIN_BTN_ALARM_OFF, false, false)
static OneButton	buttonStart (PIN_BTN_START, false, false)
static OneButton	buttonStop (PIN_BTN_STOP, false, false)
void	onPeakPressureIncrease ()
	Handler of the button to increase the crete pressure. More...
void	onPeakPressureDecrease ()
	Handler of the button to decrease the crete pressure. More...
void	onPlateauPressureIncrease ()
	Handler of the button to increase the plateau pressure. More...
void	onPlateauPressureDecrease ()
	Handler of the button to decrease the plateau pressure. More...
void	onPeepPressureIncrease ()
	Handler of the button to increase the PEP pressure. More...
void	onPeepPressureDecrease ()
	Handler of the button to decrease the PEP pressure. More...
void	onCycleIncrease ()
	Handler of the button to increase the number of breathing cycles. More...
void	onCycleDecrease ()
	Handler of the button to decrease the number of breathing cycles. More...
void	onAlarmOff ()
	Handler of the button to stop alarm. More...
void	onStart ()
	Handler of the button to start. More...
void	onStop ()
	Handler of the button to stop. More...
void	initKeyboard ()
	Initialize keyboard abstraction. More...
void	scanMatrixLoop ()
void	keyboardLoop ()
	Handle button events. More...
void	calibrateButtons ()
	Helper to calibrate analog values of buttons. More...

Variables
uint16_t	scanMatrixCurrentColumn = 1
uint16_t	scanMatrixCounterC1R1 = 0
uint16_t	scanMatrixCounterC1R2 = 0
uint16_t	scanMatrixCounterC1R3 = 0
uint16_t	scanMatrixCounterC2R1 = 0
uint16_t	scanMatrixCounterC2R2 = 0
uint16_t	scanMatrixCounterC2R3 = 0
uint16_t	scanMatrixCounterC3R1 = 0
uint16_t	scanMatrixCounterC3R2 = 0
uint16_t	scanMatrixCounterC3R3 = 0

Detailed Description

Buttons related functions.

Author

Makers For Life

Copyright

Copyright (c) 2020 Makers For Life

This relies on the OneButton library (https://github.com/mathertel/OneButton).

Definition in file keyboard.cpp.

Macro Definition Documentation

SM_DEBOUNCE

#define SM_DEBOUNCE   2u

Definition at line 106 of file keyboard.cpp.

SM_PERIOD

#define SM_PERIOD   15u

Definition at line 108 of file keyboard.cpp.

SM_REPEAT

#define SM_REPEAT   20u

Definition at line 107 of file keyboard.cpp.

Function Documentation

buttonAlarmOff()

static OneButton buttonAlarmOff ( PIN_BTN_ALARM_OFF  , false  , false    )

static

buttonStart()

static OneButton buttonStart ( PIN_BTN_START  , false  , false    )

static

buttonStop()

static OneButton buttonStop ( PIN_BTN_STOP  , false  , false    )

static

calibrateButtons()

void calibrateButtons

(

)

Helper to calibrate analog values of buttons.

Definition at line 233 of file keyboard.cpp.

{}

initKeyboard()

void initKeyboard

(

)

Initialize keyboard abstraction.

Warning

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

Definition at line 78 of file keyboard.cpp.

                    {
    // define the 3x3 matrix keyboard input and output
    pinMode(PIN_OUT_COL1, OUTPUT);
    pinMode(PIN_OUT_COL2, OUTPUT);
    pinMode(PIN_OUT_COL3, OUTPUT);
    digitalWrite(PIN_OUT_COL1, LOW);
    digitalWrite(PIN_OUT_COL2, LOW);
    digitalWrite(PIN_OUT_COL3, LOW);
    pinMode(PIN_IN_ROW1, INPUT);
    pinMode(PIN_IN_ROW2, INPUT);
    pinMode(PIN_IN_ROW3, INPUT);
 
    buttonAlarmOff.attachClick(onAlarmOff);
    buttonStart.attachClick(onStart);
    buttonStop.attachClick(onStop);
}

keyboardLoop()

void keyboardLoop

(

)

Handle button events.

Warning

It must be called in the program loop

Definition at line 223 of file keyboard.cpp.

                    {
#ifndef DISABLE_BUTTONS
    scanMatrixLoop();
    buttonAlarmOff.tick();
    buttonStart.tick();
    buttonStop.tick();
#endif
}

onAlarmOff()

void onAlarmOff

(

)

Handler of the button to stop alarm.

Definition at line 62 of file keyboard.cpp.

{ alarmController.snooze(); }

onCycleDecrease()

void onCycleDecrease

(

)

Handler of the button to decrease the number of breathing cycles.

Definition at line 59 of file keyboard.cpp.

{ mainController.onCycleDecrease(); }

onCycleIncrease()

void onCycleIncrease

(

)

Handler of the button to increase the number of breathing cycles.

Definition at line 56 of file keyboard.cpp.

{ mainController.onCycleIncrease(); }

onPeakPressureDecrease()

void onPeakPressureDecrease

(

)

Handler of the button to decrease the crete pressure.

Definition at line 41 of file keyboard.cpp.

{ mainController.onPeakPressureDecrease(); }

onPeakPressureIncrease()

void onPeakPressureIncrease

(

)

Handler of the button to increase the crete pressure.

Definition at line 38 of file keyboard.cpp.

{ mainController.onPeakPressureIncrease(); }

onPeepPressureDecrease()

void onPeepPressureDecrease

(

)

Handler of the button to decrease the PEP pressure.

Definition at line 53 of file keyboard.cpp.

{ mainController.onPeepPressureDecrease(); }

onPeepPressureIncrease()

void onPeepPressureIncrease

(

)

Handler of the button to increase the PEP pressure.

Definition at line 50 of file keyboard.cpp.

{ mainController.onPeepPressureIncrease(); }

onPlateauPressureDecrease()

void onPlateauPressureDecrease

(

)

Handler of the button to decrease the plateau pressure.

Definition at line 47 of file keyboard.cpp.

{ mainController.onPlateauPressureDecrease(); }

onPlateauPressureIncrease()

void onPlateauPressureIncrease

(

)

Handler of the button to increase the plateau pressure.

Definition at line 44 of file keyboard.cpp.

{ mainController.onPlateauPressureIncrease(); }

onStart()

void onStart

(

)

Handler of the button to start.

Definition at line 65 of file keyboard.cpp.

               {
    if (Calibration_Started()) {
        // Restart calibration
        Calibration_Restart();
    } else {
        // Or start the machine
        activationController.onStartButton();
    }
}

onStop()

void onStop

(

)

Handler of the button to stop.

Definition at line 76 of file keyboard.cpp.

{ activationController.onStopButton(); }

scanMatrixLoop()

void scanMatrixLoop

(

)

Definition at line 112 of file keyboard.cpp.

                      {
    if (1u == scanMatrixCurrentColumn) {
        // Increase counter for each column and row
        if (HIGH == digitalRead(PIN_IN_ROW1)) {
            scanMatrixCounterC1R1++;
        } else {
            scanMatrixCounterC1R1 = 0;
        }
        if (HIGH == digitalRead(PIN_IN_ROW2)) {
            scanMatrixCounterC1R2++;
        } else {
            scanMatrixCounterC1R2 = 0;
        }
        if (HIGH == digitalRead(PIN_IN_ROW3)) {
            scanMatrixCounterC1R3++;
        } else {
            scanMatrixCounterC1R3 = 0;
        }
        // first click (after debounce ticks) or
        // later clicks if continuous press trigger action
        if ((SM_DEBOUNCE == scanMatrixCounterC1R1)
            || ((scanMatrixCounterC1R1 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC1R1 - SM_REPEAT) % SM_PERIOD))) {
            onPeakPressureIncrease();
        }
        if ((SM_DEBOUNCE == scanMatrixCounterC1R2)
            || ((scanMatrixCounterC1R2 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC1R2 - SM_REPEAT) % SM_PERIOD))) {
            onPeakPressureDecrease();
        }
        if ((SM_DEBOUNCE == scanMatrixCounterC1R3)
            || ((scanMatrixCounterC1R3 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC1R3 - SM_REPEAT) % SM_PERIOD))) {
            onPlateauPressureIncrease();
        }
    } else if (2u == scanMatrixCurrentColumn) {
        if (HIGH == digitalRead(PIN_IN_ROW1)) {
            scanMatrixCounterC2R1++;
        } else {
            scanMatrixCounterC2R1 = 0;
        }
        if (HIGH == digitalRead(PIN_IN_ROW2)) {
            scanMatrixCounterC2R2++;
        } else {
            scanMatrixCounterC2R2 = 0;
        }
        if (HIGH == digitalRead(PIN_IN_ROW3)) {
            scanMatrixCounterC2R3++;
        } else {
            scanMatrixCounterC2R3 = 0;
        }
        // first click (after debounce ticks) or
        // later clicks if continuous press trigger action
        if ((SM_DEBOUNCE == scanMatrixCounterC2R1)
            || ((scanMatrixCounterC2R1 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC2R1 - SM_REPEAT) % SM_PERIOD))) {
            onPlateauPressureDecrease();
        }
        if ((SM_DEBOUNCE == scanMatrixCounterC2R2)
            || ((scanMatrixCounterC2R2 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC2R2 - SM_REPEAT) % SM_PERIOD))) {
            onPeepPressureIncrease();
        }
        if ((SM_DEBOUNCE == scanMatrixCounterC2R3)
            || ((scanMatrixCounterC2R3 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC2R3 - SM_REPEAT) % SM_PERIOD))) {
            onPeepPressureDecrease();
        }
    } else if (3u == scanMatrixCurrentColumn) {
        if (HIGH == digitalRead(PIN_IN_ROW1)) {
            scanMatrixCounterC3R1++;
        } else {
            scanMatrixCounterC3R1 = 0;
        }
        if (HIGH == digitalRead(PIN_IN_ROW2)) {
            scanMatrixCounterC3R2++;
        } else {
            scanMatrixCounterC3R2 = 0;
        }
        if (HIGH == digitalRead(PIN_IN_ROW3)) {
            scanMatrixCounterC3R3++;
        } else {
            scanMatrixCounterC3R3 = 0;
        }
        // first click (after debounce ticks) or
        // later clicks if continuous press trigger action
        if ((SM_DEBOUNCE == scanMatrixCounterC3R1)
            || ((scanMatrixCounterC3R1 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC3R1 - SM_REPEAT) % SM_PERIOD))) {
            onCycleIncrease();
        }
        if ((SM_DEBOUNCE == scanMatrixCounterC3R2)
            || ((scanMatrixCounterC3R2 >= SM_REPEAT)
                && (0u == (scanMatrixCounterC3R2 - SM_REPEAT) % SM_PERIOD))) {
            onCycleDecrease();
        }
        // there is no button on col3 x row3
    } else {
        // Do nothing
    }
 
    // next column
    scanMatrixCurrentColumn++;
    if (4u == scanMatrixCurrentColumn) {
        scanMatrixCurrentColumn = 1;
    }
    digitalWrite(PIN_OUT_COL1, (1u == scanMatrixCurrentColumn) ? HIGH : LOW);
    digitalWrite(PIN_OUT_COL2, (2u == scanMatrixCurrentColumn) ? HIGH : LOW);
    digitalWrite(PIN_OUT_COL3, (3u == scanMatrixCurrentColumn) ? HIGH : LOW);
}

Variable Documentation

scanMatrixCounterC1R1

uint16_t scanMatrixCounterC1R1 = 0

Definition at line 97 of file keyboard.cpp.

scanMatrixCounterC1R2

uint16_t scanMatrixCounterC1R2 = 0

Definition at line 98 of file keyboard.cpp.

scanMatrixCounterC1R3

uint16_t scanMatrixCounterC1R3 = 0

Definition at line 99 of file keyboard.cpp.

scanMatrixCounterC2R1

uint16_t scanMatrixCounterC2R1 = 0

Definition at line 100 of file keyboard.cpp.

scanMatrixCounterC2R2

uint16_t scanMatrixCounterC2R2 = 0

Definition at line 101 of file keyboard.cpp.

scanMatrixCounterC2R3

uint16_t scanMatrixCounterC2R3 = 0

Definition at line 102 of file keyboard.cpp.

scanMatrixCounterC3R1

uint16_t scanMatrixCounterC3R1 = 0

Definition at line 103 of file keyboard.cpp.

scanMatrixCounterC3R2

uint16_t scanMatrixCounterC3R2 = 0

Definition at line 104 of file keyboard.cpp.

scanMatrixCounterC3R3

uint16_t scanMatrixCounterC3R3 = 0

Definition at line 105 of file keyboard.cpp.

scanMatrixCurrentColumn

uint16_t scanMatrixCurrentColumn = 1

Definition at line 96 of file keyboard.cpp.