KeyboardManager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef _KEYBOARD_MANGER_H_
#define _KEYBOARD_MANGER_H_
 
#include "IoAbstraction.h"


class KeyboardListener {
public:
    virtual void keyPressed(char key, bool held)=0;
    virtual void keyReleased(char key)=0;
};

class KeyboardLayout {
private:
    uint8_t rows;
    uint8_t cols;
    const char *pgmLayout;
    uint8_t *pins;
public:
    KeyboardLayout(uint8_t rows, uint8_t cols, const char* pgmLayout) {
        this->rows = rows;
        this->cols = cols;
        this->pgmLayout = pgmLayout;
        this->pins = new uint8_t[rows + cols];
    }
 
    ~KeyboardLayout() {
        delete pins;
    }
 
    int numColumns() { return cols; }
 
    int numRows() { return rows; }
 
    void setColPin(int col, int pin) {
        if(col < cols) pins[rows + col] = pin;
    }
 
    void setRowPin(int row, int pin) {
        if(row < rows) pins[row] = pin;
    }
 
    int getRowPin(int row) {
        return pins[row];
    }
 
    int getColPin(int col) {
        return pins[rows + col];
    }
 
    char keyFor(uint8_t row, uint8_t col) {
        if(row < rows && col < cols) return pgm_read_byte_near(&pgmLayout[(row * cols)+col]);
        else return 0;
    }
};

enum KeyMode: uint8_t {
    KEYMODE_NOT_PRESSED,
    KEYMODE_DEBOUNCE,
    KEYMODE_DEBOUNCE1,
    KEYMODE_DEBOUNCE2,
    KEYMODE_PRESSED,
    KEYMODE_REPEATING
};
 
#define KEYBOARD_TASK_MILLIS 50

class MatrixKeyboardManager : public BaseEvent {
private:
    static MatrixKeyboardManager* INSTANCE;
    KeyboardListener* listener;
    KeyboardLayout* layout;
    IoAbstractionRef ioRef;
    uint8_t repeatTicks = 10;
    uint8_t repeatStartTicks = 30;
    char currentKey;
    volatile KeyMode keyMode;
    uint8_t counter;
    bool interruptMode;
public:
    MatrixKeyboardManager();
    void initialise(IoAbstractionRef ref, KeyboardLayout* layout, KeyboardListener* listener, bool interruptMode = false);
    void setRepeatKeyMillis(int startAfterMillis, int repeatMillis);
 
    uint32_t timeOfNextCheck() override;
    void exec() override;
 
    friend void rawKeyboardInterrupt();
private:
    void setToOutput(int i);
    void enableAllOutputsForInterrupt();
 
    void doDebounce(char time);
};
 
#define MAKE_KEYBOARD_LAYOUT_3X4(varName) const char KEYBOARD_STD_3X4_KEYS[] PROGMEM = "123456789*0#"; KeyboardLayout varName(4, 3, KEYBOARD_STD_3X4_KEYS);
#define MAKE_KEYBOARD_LAYOUT_4X4(varName) const char KEYBOARD_STD_4X4_KEYS[] PROGMEM = "123A456B789C*0#D"; KeyboardLayout varName(4, 4, KEYBOARD_STD_4X4_KEYS);
 
#endif // _KEYBOARD_MANGER_H_