UIRims.h

Go to the documentation of this file.

#ifndef UIRims_h
#define UIRims_h

#define KEYNONE 0
#define KEYUP 1
#define KEYDOWN 2
#define KEYLEFT 3
#define KEYRIGHT 4
#define KEYSELECT 5

#define SCREENTEMP 0
#define SCREENTIMEFLOW 1
#define SCREENIDENT 2
#define SCREENPIDCOEF 3


#define LCDCOLUMNS 16
#define LCDROWS 2

#define POWERFREQ 500
#define RINGFREQ 1000
#define FLOWFREQ 1500
#define NCTHERMFREQ 2000
#define ALARMLENGTH 50

#define KEYDEBOUNCETIME 15

#include "Arduino.h"
#include "LiquidCrystal.h"


class UIRims
{
        
public:
    
    UIRims(LiquidCrystal* lcd, byte pinKeysAnalog,
           byte pinLight = LED_BUILTIN, char pinSpeaker = -1);
    
    // === STD DIALOGS METHOD ===
    void showSerialWarning();
    void showPumpWarning(float flow = 0.0);
    void showHeaterWarning(bool state = false);
    void showTempScreen();
    void showTimeFlowScreen();
    void switchScreen();
    void showIdentScreen();
    void showPIDTuningScreen(float Kp, float Ki, float Kd, float tauFilter);
    void showMemAccessScreen();
    
    // === VARIABLE SETTER ===
    void setTempSP(float tempCelcius);
    void setTempPV(float tempCelcius, bool buzz = true);
    void setCV(float controlValue);
    void setTime(unsigned int timeSec);
    void setFlow(float flow, bool buzz = true); //liter/min
    void setFlowBounds(float lowBound, float upBound);
    void setHeaterVoltState(bool state, bool buzz = true);
    
    // === KEYS READER ===
    byte readKeysADC(bool waitNone = true);
    
    // === ALARM METHODS ===
    void timerRunningChar(bool state);
    void ring(bool state = true);
    void lcdLight(bool state = true);
    
    // === SETUP DIALOGS ===
    float askSetPoint(float defaultVal); // Celsius
    unsigned int askTime(unsigned int defaultVal); // seconds
    byte askMashWater(int mashWaterValues[],byte defaultVal);
    
protected:
    
    byte _waitForKeyChange();
    void _waitTime(unsigned long timeInMilliSec);
    
    void _printStrLCD(String mess, byte col, byte row);
    void _printFloatLCD(float val, int width, int prec, byte col, byte row);
    void _setCursorPosition(byte col, byte row);
    float _celciusToFahrenheit(float celcius);
    void _moveCursorLR(byte begin, byte end, byte dotPosition,
                       byte row,bool left);
    float _incDecValue(float value,byte dotPosition, bool increase, 
                       float lowerBound, float upperBound, bool timeFormat);
    float _askValue(byte begin, byte end, byte dotPosition, byte row,
                    float defaultVal, float lowerBound, float upperBound,
                    bool timeFormat);
                    
private:
    
    LiquidCrystal* _lcd;
    byte _cursorCol;
    byte _cursorRow;
    byte _pinKeysAnalog;
    byte _pinLight;
    char _pinSpeaker;
    
    byte _screenShown;
    
    bool _waitNone;
    
    float _tempSP;
    float _tempPV;
    float _cv;
    unsigned int _time;
    float _flow;
    
    float _flowLowBound;
    float _flowUpBound;
    
};

#endif