mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-08 00:39:50 +03:00
285 lines
10 KiB
C
285 lines
10 KiB
C
/*
|
|
* Header file for EMS.cpp
|
|
*
|
|
* You shouldn't need to change much in this file
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <Arduino.h>
|
|
|
|
// EMS IDs
|
|
#define EMS_ID_NONE 0x00 // Fixed - used as a dest in broadcast messages and empty type IDs
|
|
#define EMS_ID_BOILER 0x08 // Fixed - also known as MC10.
|
|
#define EMS_ID_ME 0x0B // Fixed - our device, hardcoded as "Service Key"
|
|
|
|
#define EMS_MIN_TELEGRAM_LENGTH 6 // minimal length for a validation telegram, including CRC
|
|
#define EMS_MAX_TELEGRAM_LENGTH 99 // max length of a telegram, including CRC
|
|
|
|
#define EMS_TX_MAXBUFFERSIZE 128 // max size of the buffer. packets are 32 bits
|
|
|
|
#define EMS_ID_THERMOSTAT_RC20 0x17 // RC20 (e.g. Moduline 300)
|
|
#define EMS_ID_THERMOSTAT_RC30 0x10 // RC30 (e.g. Moduline 400)
|
|
#define EMS_ID_THERMOSTAT_EASY 0x18 // TC100 (Nefit Easy)
|
|
|
|
// define here the EMS telegram types you need
|
|
|
|
// Common for all EMS devices
|
|
#define EMS_TYPE_Version 0x02 // version of the UBA controller (boiler)
|
|
|
|
/*
|
|
* Boiler...
|
|
*/
|
|
#define EMS_TYPE_UBAMonitorFast 0x18 // is an automatic monitor broadcast
|
|
#define EMS_TYPE_UBAMonitorSlow 0x19 // is an automatic monitor broadcast
|
|
#define EMS_TYPE_UBAMonitorWWMessage 0x34 // is an automatic monitor broadcast
|
|
#define EMS_TYPE_UBAMaintenanceStatusMessage 0x1C // is an automatic monitor broadcast
|
|
#define EMS_TYPE_UBAParameterWW 0x33
|
|
#define EMS_TYPE_UBATotalUptimeMessage 0x14
|
|
#define EMS_TYPE_UBAMaintenanceSettingsMessage 0x15
|
|
#define EMS_TYPE_UBAParametersMessage 0x16
|
|
#define EMS_TYPE_UBASetPoints 0x1A
|
|
#define EMS_TYPE_UBAFunctionTest 0x1D
|
|
|
|
#define EMS_OFFSET_UBAParameterWW_wwtemp 2 // WW Temperature
|
|
#define EMS_OFFSET_UBAParameterWW_wwactivated 1 // WW Activated
|
|
|
|
/*
|
|
* Thermostat...
|
|
*/
|
|
|
|
// Common for all thermostats
|
|
#define EMS_TYPE_RCTime 0x06 // is an automatic thermostat broadcast
|
|
#define EMS_TYPE_RCOutdoorTempMessage 0xA3 // is an automatic thermostat broadcast, outdoor external temp
|
|
|
|
// RC20 specific
|
|
#define EMS_TYPE_RC20StatusMessage 0x91 // is an automatic thermostat broadcast giving us temps
|
|
#define EMS_TYPE_RC20Set 0xA8 // for setting values like temp and mode
|
|
#define EMS_OFFSET_RC20Set_mode 23 // position of thermostat mode
|
|
#define EMS_OFFSET_RC20Set_temp 28 // position of thermostat setpoint temperature
|
|
|
|
// RC30 specific
|
|
#define EMS_TYPE_RC30StatusMessage 0x41 // is an automatic thermostat broadcast giving us temps
|
|
#define EMS_TYPE_RC30Set 0xA7 // for setting values like temp and mode
|
|
#define EMS_OFFSET_RC30Set_mode 23 // position of thermostat mode
|
|
#define EMS_OFFSET_RC30Set_temp 28 // position of thermostat setpoint temperature
|
|
|
|
// Easy specific
|
|
#define EMS_TYPE_EasyStatusMessage 0x0A // reading values on an Easy Thermostat
|
|
|
|
// default values
|
|
#define EMS_VALUE_INT_ON 1 // boolean true
|
|
#define EMS_VALUE_INT_OFF 0 // boolean false
|
|
#define EMS_VALUE_INT_NOTSET 0xFF // for 8-bit ints
|
|
#define EMS_VALUE_FLOAT_NOTSET -255 // float unset
|
|
|
|
/* EMS UART transfer status */
|
|
typedef enum {
|
|
EMS_RX_IDLE,
|
|
EMS_RX_ACTIVE // Rx package is being sent
|
|
} _EMS_RX_STATUS;
|
|
|
|
typedef enum {
|
|
EMS_TX_IDLE,
|
|
EMS_TX_ACTIVE, // Tx package being sent, no break sent
|
|
EMS_TX_SUCCESS,
|
|
EMS_TX_ERROR
|
|
} _EMS_TX_STATUS;
|
|
|
|
typedef enum {
|
|
EMS_TX_TELEGRAM_INIT, // just initialized
|
|
EMS_TX_TELEGRAM_READ, // doing a read request
|
|
EMS_TX_TELEGRAM_WRITE, // doing a write request
|
|
EMS_TX_TELEGRAM_VALIDATE, // do a read but only to validate the last write
|
|
EMS_TX_TELEGRAM_RAW // sending in raw mode
|
|
} _EMS_TX_TELEGRAM_ACTION;
|
|
|
|
/* EMS logging */
|
|
typedef enum {
|
|
EMS_SYS_LOGGING_NONE, // no messages
|
|
EMS_SYS_LOGGING_RAW, // raw data mode
|
|
EMS_SYS_LOGGING_BASIC, // only basic read/write messages
|
|
EMS_SYS_LOGGING_THERMOSTAT, // only telegrams sent from thermostat
|
|
EMS_SYS_LOGGING_VERBOSE // everything
|
|
} _EMS_SYS_LOGGING;
|
|
|
|
// status/counters since last power on
|
|
typedef struct {
|
|
_EMS_RX_STATUS emsRxStatus;
|
|
_EMS_TX_STATUS emsTxStatus;
|
|
uint16_t emsRxPgks; // received
|
|
uint16_t emsTxPkgs; // sent
|
|
uint16_t emxCrcErr; // CRC errors
|
|
bool emsPollEnabled; // flag enable the response to poll messages
|
|
bool emsTxEnabled; // flag if we're allowing sending of Tx packages
|
|
bool emsThermostatEnabled; // if there is a RCxx thermostat active
|
|
bool emsBoilerEnabled; // is the boiler online
|
|
_EMS_SYS_LOGGING emsLogging; // logging
|
|
bool emsRefreshed; // fresh data, needs to be pushed out to MQTT
|
|
} _EMS_Sys_Status;
|
|
|
|
// The Tx send package
|
|
typedef struct {
|
|
_EMS_TX_TELEGRAM_ACTION action; // read or write
|
|
uint8_t dest;
|
|
uint8_t type;
|
|
uint8_t offset;
|
|
uint8_t length;
|
|
uint8_t dataValue; // value to validate against
|
|
uint8_t type_validate; // type to call after a successful Write command
|
|
uint8_t comparisonValue; // value to compare against during a validate
|
|
uint8_t comparisonOffset; // offset of where the byte is we want to compare too later
|
|
uint8_t comparisonPostRead; // after a successful write call this to read
|
|
bool hasSent; // has been sent, just pending ack
|
|
bool forceRefresh; // should we send to MQTT after a successful Tx?
|
|
uint8_t data[EMS_TX_MAXBUFFERSIZE];
|
|
} _EMS_TxTelegram;
|
|
|
|
// default empty Tx
|
|
const _EMS_TxTelegram EMS_TX_TELEGRAM_NEW = {
|
|
EMS_TX_TELEGRAM_INIT, // action
|
|
EMS_ID_NONE, // dest
|
|
EMS_ID_NONE, // type
|
|
0, // offset
|
|
0, // length
|
|
0, // data value
|
|
EMS_ID_NONE, // type_validate
|
|
0, // comparisonValue
|
|
0, // comparisonOffset
|
|
EMS_ID_NONE, // comparisonPostRead
|
|
false, // hasSent
|
|
false, // forceRefresh
|
|
{0x00} // data
|
|
};
|
|
|
|
/*
|
|
* Telegram package defintions
|
|
*/
|
|
typedef struct { // UBAParameterWW
|
|
uint8_t wWActivated; // Warm Water activated
|
|
uint8_t wWSelTemp; // Warm Water selected temperature
|
|
uint8_t wWCircPump; // Warm Water circulation pump Available
|
|
uint8_t wWDesiredTemp; // Warm Water desired temperature
|
|
|
|
// UBAMonitorFast
|
|
uint8_t selFlowTemp; // Selected flow temperature
|
|
float curFlowTemp; // Current flow temperature
|
|
float retTemp; // Return temperature
|
|
uint8_t burnGas; // Gas on/off
|
|
uint8_t fanWork; // Fan on/off
|
|
uint8_t ignWork; // Ignition on/off
|
|
uint8_t heatPmp; // Circulating pump on/off
|
|
uint8_t wWHeat; // 3-way valve on WW
|
|
uint8_t wWCirc; // Circulation on/off
|
|
uint8_t selBurnPow; // Burner max power
|
|
uint8_t curBurnPow; // Burner current power
|
|
float flameCurr; // Flame current in micro amps
|
|
float sysPress; // System pressure
|
|
|
|
// UBAMonitorSlow
|
|
float extTemp; // Outside temperature
|
|
float boilTemp; // Boiler temperature
|
|
uint8_t pumpMod; // Pump modulation
|
|
uint16_t burnStarts; // # burner restarts
|
|
uint16_t burnWorkMin; // Total burner operating time
|
|
uint16_t heatWorkMin; // Total heat operating time
|
|
|
|
// UBAMonitorWWMessage
|
|
float wWCurTmp; // Warm Water current temperature:
|
|
uint32_t wWStarts; // Warm Water # starts
|
|
uint32_t wWWorkM; // Warm Water # minutes
|
|
uint8_t wWOneTime; // Warm Water one time function on/off
|
|
|
|
// calculated values
|
|
uint8_t tapwaterActive; // Hot tap water is on/off
|
|
uint8_t heatingActive; // Central heating is on/off
|
|
|
|
} _EMS_Boiler;
|
|
|
|
// Thermostat data
|
|
typedef struct {
|
|
uint8_t type; // thermostat type (RC30, Easy etc)
|
|
float setpoint_roomTemp; // current set temp
|
|
float curr_roomTemp; // current room temp
|
|
uint8_t mode; // 0=low, 1=manual, 2=auto
|
|
uint8_t hour;
|
|
uint8_t minute;
|
|
uint8_t second;
|
|
uint8_t day;
|
|
uint8_t month;
|
|
uint8_t year;
|
|
} _EMS_Thermostat;
|
|
|
|
// call back function signature
|
|
typedef void (*EMS_processType_cb)(uint8_t * data, uint8_t length);
|
|
|
|
// Definition for each EMS type, including the relative callback function
|
|
typedef struct {
|
|
uint8_t src;
|
|
uint8_t type;
|
|
const char typeString[50];
|
|
EMS_processType_cb processType_cb;
|
|
} _EMS_Types;
|
|
|
|
// Definition for thermostat type
|
|
typedef struct {
|
|
uint8_t id;
|
|
const char typeString[50];
|
|
} _Thermostat_Types;
|
|
|
|
// ANSI Colors
|
|
#define COLOR_RESET "\x1B[0m"
|
|
#define COLOR_BLACK "\x1B[0;30m"
|
|
#define COLOR_RED "\x1B[0;31m"
|
|
#define COLOR_GREEN "\x1B[0;32m"
|
|
#define COLOR_YELLOW "\x1B[0;33m"
|
|
#define COLOR_BLUE "\x1B[0;34m"
|
|
#define COLOR_MAGENTA "\x1B[0;35m"
|
|
#define COLOR_CYAN "\x1B[0;36m"
|
|
#define COLOR_WHITE "\x1B[0;37m"
|
|
#define COLOR_BOLD_ON "\x1B[1m"
|
|
#define COLOR_BOLD_OFF "\x1B[21m"
|
|
|
|
// function definitions
|
|
extern void ems_parseTelegram(uint8_t * telegram, uint8_t len);
|
|
void ems_init();
|
|
void ems_doReadCommand(uint8_t type, uint8_t dest, bool forceRefresh = false);
|
|
void ems_sendRawTelegram(char * telegram);
|
|
|
|
void ems_setThermostatTemp(float temp);
|
|
void ems_setThermostatMode(uint8_t mode);
|
|
void ems_setWarmWaterTemp(uint8_t temperature);
|
|
void ems_setWarmWaterActivated(bool activated);
|
|
void ems_setWarmTapWaterActivated(bool activated);
|
|
void ems_setExperimental(uint8_t value);
|
|
void ems_setPoll(bool b);
|
|
void ems_setTxEnabled(bool b);
|
|
void ems_setThermostatEnabled(bool b);
|
|
void ems_setLogging(_EMS_SYS_LOGGING loglevel);
|
|
void ems_setEmsRefreshed(bool b);
|
|
|
|
void ems_getThermostatValues();
|
|
bool ems_getPoll();
|
|
bool ems_getTxEnabled();
|
|
bool ems_getThermostatEnabled();
|
|
bool ems_getBoilerEnabled();
|
|
_EMS_SYS_LOGGING ems_getLogging();
|
|
uint8_t ems_getEmsTypesCount();
|
|
uint8_t ems_getThermostatTypesCount();
|
|
bool ems_getEmsRefreshed();
|
|
|
|
void ems_printAllTypes();
|
|
void ems_printThermostatType();
|
|
void ems_printTxQueue();
|
|
|
|
// private functions
|
|
uint8_t _crcCalculator(uint8_t * data, uint8_t len);
|
|
void _processType(uint8_t * telegram, uint8_t length);
|
|
void _debugPrintPackage(const char * prefix, uint8_t * data, uint8_t len, const char * color);
|
|
void _ems_clearTxData();
|
|
|
|
// global so can referenced in other classes
|
|
extern _EMS_Sys_Status EMS_Sys_Status;
|
|
extern _EMS_Boiler EMS_Boiler;
|
|
extern _EMS_Thermostat EMS_Thermostat;
|