version 1.3.0

src/my_config.h

@@ -1,57 +1,43 @@
 /*
  * my_config.h
+ * 
  * All configurations and customization's go here
  * 
- * Paul Derbyshire - https://github.com/proddy/EMS-ESP-Boiler
+ * Paul Derbyshire - https://github.com/proddy/EMS-ESP
  */
 
 #pragma once
 
-// these are set as -D build flags during compilation
-// they can be set in platformio.ini or alternatively hard coded here
-/*
-#define WIFI_SSID "<my_ssid>"
-#define WIFI_PASSWORD "<my_password>"
-#define MQTT_IP "<broker_ip>"
-#define MQTT_USER "<broker_username>"
-#define MQTT_PASS "<broker_password>"
-*/
+#include "ems.h"
+
+// Set your wifi and mqtt params
+// If set to NULL (default) you'll need to set them in AP mode using the 'set' command
+// as these values are stored in SPIFFs for persisted
+#define WIFI_SSID NULL
+#define WIFI_PASSWORD NULL
+#define MQTT_IP NULL
+#define MQTT_USER NULL
+#define MQTT_PASS NULL
+
+// All MQTT topics are prefixed with the following string
+#define MQTT_BASE "home"
 
 // default values for shower logic on/off
-#define BOILER_SHOWER_TIMER 1 // monitors how long a shower has taken
-#define BOILER_SHOWER_ALERT 0 // send alert if showetime exceeded
+#define BOILER_SHOWER_TIMER 1      // enable (1) to monitor shower time
+#define BOILER_SHOWER_ALERT 0      // enable (1) to send alert of cold watewr when shower time limit has exceeded
+#define SHOWER_MAX_DURATION 420000 // in ms. 7 minutes, before trigger a shot of cold water
 
-// 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
-
-// if using the shower timer, change these settings
-#define SHOWER_PAUSE_TIME 15000     // in ms. 15 seconds, max time if water is switched off & on during a shower
-#define SHOWER_MIN_DURATION 120000  // in ms. 2 minutes, before recognizing its a shower
-#define SHOWER_MAX_DURATION 420000  // in ms. 7 minutes, before trigger a shot of cold water
-#define SHOWER_OFFSET_TIME 5000     // in ms. 5 seconds grace time, to calibrate actual time under the shower
-#define SHOWER_COLDSHOT_DURATION 10 // in seconds. 10 seconds for cold water before turning back hot water
-
-// The LED for showing connection errors, either onboard or via an external pull-up LED
-// can be disabled using -DNO_LED build flag in platformio.ini
+// Set LED pin used for showing ems bus connection status. Solid is connected, Flashing is error
+// can be either the onboard LED on the ESP8266 or external via an external pull-up LED (e.g. D1)
+// note: can be disabled completely using -DNO_LED build flag in platformio.ini
 #define BOILER_LED LED_BUILTIN // LED_BULLETIN for onboard LED
-//#define BOILER_LED D1          // for external LED like on the latest bbqkees boards
 
 // set this if using an external temperature sensor like a DS18B20
 #define TEMPERATURE_SENSOR_PIN D7
 
-// logging - EMS_SYS_LOGGING_VERBOSE, EMS_SYS_LOGGING_NONE, EMS_SYS_LOGGING_BASIC (see ems.h)
-// this can be changed via the Telnet console using the 'l' command
-#define BOILER_DEFAULT_LOGGING EMS_SYS_LOGGING_NONE
-//#define BOILER_DEFAULT_LOGGING EMS_SYS_LOGGING_VERBOSE
-//#define BOILER_DEFAULT_LOGGING EMS_SYS_LOGGING_BASIC
-
-// By default the EMS bus will be scanned for known devices. You can override this here
-// by fixing the Boiler and Thermostat types
-// Options are in ems.h and include..
+// By default the EMS bus will be scanned for known devices (EMS_MODEL_NONE).
+// You can override this here by fixing the Boiler and Thermostat types.
+// See ems.h for the list of recognized types. For example:
 // boilers: EMS_MODEL_BK15, EMS_MODEL_UBA, EMS_MODEL_BC10, EMS_MODEL_MM10, EMS_MODEL_WM10
 // thermostats: EMS_MODEL_ES73, EMS_MODEL_RC20, EMS_MODEL_RC30, EMS_MODEL_RC35, EMS_MODEL_EASY
 #define MY_BOILER_MODELID EMS_MODEL_NONE