smart-Tx - Take Two

platformio.ini~

@@ -0,0 +1,56 @@
+[platformio]
+; add here your board, e.g. nodemcuv2, d1_mini, d1_mini_pro
+env_default = d1_mini
+
+[common]
+flash_mode = dout
+;cpu_clock = 160000000L
+cpu_clock =  80000000L
+build_flags = -g -w
+
+; for debug use these...
+build_flags = -g -Wall -Wextra -Werror -Wno-missing-field-initializers -Wno-unused-parameter -Wno-unused-variable -DCRASH
+
+;wifi_settings =
+; hard code if you prefer. Recommendation is to set from within the app when in Serial or AP mode
+wifi_settings = '-DWIFI_SSID="SusiconStrolch"' '-DWIFI_PASSWORD="2759838837626100"'
+
+lib_deps =
+  CRC32
+  CircularBuffer
+  JustWifi
+  AsyncMqttClient
+  ArduinoJson
+  OneWire
+  EEPROM_rotate
+
+[env:d1_mini]
+board = d1_mini
+platform = espressif8266
+framework = arduino
+lib_deps = ${common.lib_deps}
+build_flags = ${common.build_flags} ${common.wifi_settings}
+board_build.f_cpu = ${common.cpu_clock}
+board_build.flash_mode = ${common.flash_mode}
+upload_speed = 921600
+monitor_speed = 115200
+upload_port = /dev/ttyUSB0
+; for OTA comment out these sections
+upload_protocol = espota
+upload_port = 192.168.254.139
+;upload_port = <add here your ip of the device>
+
+[env:esp12f]
+board = esp12e
+platform = espressif8266
+framework = arduino
+lib_deps = ${common.lib_deps}
+build_flags = ${common.build_flags} ${common.wifi_settings}
+board_build.flash_mode = ${common.flash_mode}
+board_build.f_cpu = ${common.cpu_clock}
+upload_speed = 921600
+upload_port = /dev/esp8266
+monitor_speed = 115200
+; for OTA comment out these sections
+upload_protocol = espota
+upload_port = 192.168.254.82

src/ems.h~

@@ -0,0 +1,329 @@
+/*
+ * Header file for ems.cpp
+ * 
+ * Paul Derbyshire - https://github.com/proddy/EMS-ESP
+ *
+ * See ChangeLog.md for history
+ * See README.md for Acknowledgments
+ *
+ */
+
+#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_ME 0x0B   // Fixed - our device, hardcoded as the "Service Key"
+#define EMS_ID_DEFAULT_BOILER 0x08
+#define EMS_ID_SM10 0x30 // Solar Module SM10
+
+#define EMS_MIN_TELEGRAM_LENGTH 6 // minimal length for a validation telegram, including CRC
+
+// max length of a telegram, including CRC, for Rx and Tx.
+#define EMS_MAX_TELEGRAM_LENGTH 32
+
+// 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_SHORT_NOTSET 0x8000  // for 2-byte shorts
+#define EMS_VALUE_LONG_NOTSET 0xFFFFFF // for 3-byte longs
+
+#define EMS_THERMOSTAT_READ_YES true
+#define EMS_THERMOSTAT_READ_NO false
+#define EMS_THERMOSTAT_WRITE_YES true
+#define EMS_THERMOSTAT_WRITE_NO false
+
+// trigger settings to determine if hot tap water or the heating is active
+#define EMS_BOILER_BURNPOWER_TAPWATER 100
+#define EMS_BOILER_SELFLOWTEMP_HEATING 70
+
+//define maximum settable tapwater temperature, not every installation supports 90 degrees
+#define EMS_BOILER_TAPWATER_TEMPERATURE_MAX 60
+
+#define EMS_TX_TELEGRAM_QUEUE_MAX 50 // max size of Tx FIFO queue
+
+<<<<<<< Updated upstream
+//#define EMS_SYS_LOGGING_DEFAULT EMS_SYS_LOGGING_VERBOSE
+#define EMS_SYS_LOGGING_DEFAULT EMS_SYS_LOGGING_NONE
+=======
+#define EMS_SYS_LOGGING_DEFAULT EMS_SYS_LOGGING_VERBOSE
+//#define EMS_SYS_LOGGING_DEFAULT EMS_SYS_LOGGING_NONE
+>>>>>>> Stashed changes
+
+/* EMS UART transfer status */
+typedef enum {
+    EMS_RX_STATUS_IDLE,
+    EMS_RX_STATUS_BUSY // Rx package is being received
+} _EMS_RX_STATUS;
+
+typedef enum {
+    EMS_TX_STATUS_IDLE, // ready
+    EMS_TX_STATUS_WAIT  // waiting for response from last Tx
+} _EMS_TX_STATUS;
+
+#define EMS_TX_SUCCESS 0x01 // EMS single byte after a Tx Write indicating a success
+#define EMS_TX_ERROR 0x04   // EMS single byte after a Tx Write indicating an error
+
+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
+    _EMS_SYS_LOGGING emsLogging;       // logging
+    bool             emsRefreshed;     // fresh data, needs to be pushed out to MQTT
+    bool             emsBusConnected;  // is there an active bus
+    unsigned long    emsRxTimestamp;   // timestamp of last EMS message received
+    unsigned long    emsPollTimestamp; // timestamp of last EMS poll sent to us
+    bool             emsTxCapable;     // able to send via Tx
+    bool             emsTxDisabled;    // true to prevent all Tx
+    uint8_t          txRetryCount;     // # times the last Tx was re-sent
+} _EMS_Sys_Status;
+
+// The Tx send package
+typedef struct {
+    _EMS_TX_TELEGRAM_ACTION action; // read, write, validate, init
+    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                    forceRefresh;       // should we send to MQTT after a successful Tx?
+    unsigned long           timestamp;          // when created
+    uint8_t                 data[EMS_MAX_TELEGRAM_LENGTH];
+} _EMS_TxTelegram;
+
+// The Rx receive package
+typedef struct {
+    uint32_t  timestamp; // timestamp from millis()
+    uint8_t * telegram;  // the full data package
+    uint8_t   length;    // length in bytes
+} _EMS_RxTelegram;
+
+
+// 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,                // forceRefresh
+    0,                    // timestamp
+    {0x00}                // data
+};
+
+typedef struct {
+    uint8_t model_id;
+    uint8_t product_id;
+    uint8_t type_id;
+    char    model_string[50];
+} _Boiler_Type;
+
+typedef struct {
+    uint8_t model_id;
+    uint8_t product_id;
+    uint8_t type_id;
+    char    model_string[50];
+} _Other_Type;
+
+// Definition for thermostat type
+typedef struct {
+    uint8_t model_id;
+    uint8_t product_id;
+    uint8_t type_id;
+    char    model_string[50];
+    bool    read_supported;
+    bool    write_supported;
+} _Thermostat_Type;
+
+/*
+ * 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
+    uint8_t wWComfort;     // Warm water comfort or ECO mode
+
+    // UBAMonitorFast
+    uint8_t  selFlowTemp;        // Selected flow temperature
+    int16_t  curFlowTemp;        // Current flow temperature
+    int16_t  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
+    uint16_t flameCurr;          // Flame current in micro amps
+    uint8_t  sysPress;           // System pressure
+    char     serviceCodeChar[3]; // 2 character status/service code
+    uint16_t serviceCode;        // error/service code
+
+    // UBAMonitorSlow
+    int16_t  extTemp;     // Outside temperature
+    int16_t  boilTemp;    // Boiler temperature
+    uint8_t  pumpMod;     // Pump modulation
+    uint32_t burnStarts;  // # burner starts
+    uint32_t burnWorkMin; // Total burner operating time
+    uint32_t heatWorkMin; // Total heat operating time
+
+    // UBAMonitorWWMessage
+    int16_t  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
+    uint8_t  wWCurFlow; // Warm Water current flow in l/min
+
+    // UBATotalUptimeMessage
+    uint32_t UBAuptime; // Total UBA working hours
+
+    // UBAParametersMessage
+    uint8_t heating_temp; // Heating temperature setting on the boiler
+    uint8_t pump_mod_max; // Boiler circuit pump modulation max. power
+    uint8_t pump_mod_min; // Boiler circuit pump modulation min. power
+
+    // calculated values
+    uint8_t tapwaterActive; // Hot tap water is on/off
+    uint8_t heatingActive;  // Central heating is on/off
+
+    // settings
+    char    version[10];
+    uint8_t type_id; // this is typically always 0x08
+    uint8_t product_id;
+} _EMS_Boiler;
+
+/*
+ * Telegram package defintions for Other EMS devices
+ */
+typedef struct {
+    // SM10 Solar Module - SM10Monitor
+    bool    SM10;               // set true if there is a SM10 available
+    int16_t SM10collectorTemp;  // collector temp from SM10
+    int16_t SM10bottomTemp;     // bottom temp from SM10
+    uint8_t SM10pumpModulation; // modulation solar pump
+    uint8_t SM10pump;           // pump active
+} _EMS_Other;
+
+// Thermostat data
+typedef struct {
+    uint8_t type_id;  // the type ID of the thermostat
+    uint8_t model_id; // which Thermostat type
+    uint8_t product_id;
+    bool    read_supported;
+    bool    write_supported;
+    char    version[10];
+    int16_t setpoint_roomTemp; // current set temp
+    int16_t curr_roomTemp;     // current room temp
+    uint8_t mode;              // 0=low, 1=manual, 2=auto
+    bool    day_mode;          // 0=night, 1=day
+    uint8_t hour;
+    uint8_t minute;
+    uint8_t second;
+    uint8_t day;
+    uint8_t month;
+    uint8_t year;
+} _EMS_Thermostat;
+
+// call back function signature for processing telegram types
+typedef void (*EMS_processType_cb)(uint8_t src, uint8_t * data, uint8_t length);
+
+// Definition for each EMS type, including the relative callback function
+typedef struct {
+    uint8_t            model_id;
+    uint8_t            type;
+    const char         typeString[50];
+    EMS_processType_cb processType_cb;
+} _EMS_Type;
+
+// 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_setPoll(bool b);
+void ems_setLogging(_EMS_SYS_LOGGING loglevel);
+void ems_setEmsRefreshed(bool b);
+void ems_setWarmWaterModeComfort(uint8_t comfort);
+bool ems_checkEMSBUSAlive();
+void ems_setModels();
+void ems_setTxDisabled(bool b);
+
+void             ems_getThermostatValues();
+void             ems_getBoilerValues();
+void             ems_getOtherValues();
+bool             ems_getPoll();
+bool             ems_getTxEnabled();
+bool             ems_getThermostatEnabled();
+bool             ems_getBoilerEnabled();
+bool             ems_getBusConnected();
+_EMS_SYS_LOGGING ems_getLogging();
+bool             ems_getEmsRefreshed();
+uint8_t          ems_getThermostatModel();
+void             ems_discoverModels();
+bool             ems_getTxCapable();
+
+void   ems_scanDevices();
+void   ems_printAllTypes();
+char * ems_getThermostatDescription(char * buffer);
+void   ems_printTxQueue();
+char * ems_getBoilerDescription(char * buffer);
+
+void ems_startupTelegrams();
+
+// private functions
+uint8_t _crcCalculator(uint8_t * data, uint8_t len);
+void    _processType(_EMS_RxTelegram * EMS_RxTelegram);
+void    _debugPrintPackage(const char * prefix, _EMS_RxTelegram * EMS_RxTelegram, const char * color);
+void    _ems_clearTxData();
+int     _ems_findBoilerModel(uint8_t model_id);
+bool    _ems_setModel(uint8_t model_id);
+void    _ems_setThermostatModel(uint8_t thermostat_modelid);
+void    _removeTxQueue();
+void    _ems_readTelegram(uint8_t * telegram, uint8_t length);
+
+// global so can referenced in other classes
+extern _EMS_Sys_Status EMS_Sys_Status;
+extern _EMS_Boiler     EMS_Boiler;
+extern _EMS_Thermostat EMS_Thermostat;
+extern _EMS_Other      EMS_Other;