Skip to content

Latest commit

 

History

History
542 lines (365 loc) · 21.6 KB

CHANGELOG.md

File metadata and controls

542 lines (365 loc) · 21.6 KB

EMS-ESP Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.9.4] 2019-12-15

There are breaking changes in this release. Make you sure you adjust the MQTT topics as described in the wiki.

Added

  • Added publish_always forcing MQTT topics to be always sent regardless if the data hasn't changed
  • Support for DHW once (OneTime water) heating command via MQTT issue 195
  • Added scripts to automatically build firmware images on every Commit/Pull and nightly builds using TravisCI
  • Added option to WebUI to also download the latest development build
  • Added build scripts for automated CI with TravisCI
  • Implemented timezone support and automatic adjustment, also taking daylight saving times into account
  • Added kick command to reset core services like NTP, Web, Web Sockets
  • Added WiFi static IP (setting done in WebUI only)
  • log w <type_id> for watching a specific telegram type ID
  • initial support for EMS+ GB125s and MC110's (https://github.com/proddy/EMS-ESP/wiki/MC110-controller)
  • Buderus RFM200 receiver

Fixed

  • Stability for some Wemos clones by decreasing wifi Tx strength and adding small delay

Changed

  • Debug log times show real internet time (if NTP enabled)
  • system shows local time instead of UTC
  • fixed version numbers of libraries in platformio.ini
  • Normalized Heating modes to off, manual, auto, night and day to keep generic and not Home Assistant specific (like heat)
  • Keeping Thermostat day/night modes separate from off/auto/manual, and setting this for the Junkers FR50
  • Removed publish_always
  • Changed NTP interval from 1 hour to 12 hours
  • Refactored EMS device library to make it support multi-EMS devices easier (e.g. multiple thermostats)
  • autodetect deep removed and replaced with autodetect scan for scanning known devices.
  • MQTT data will be sent when new data arrives. So publish_time is used to force a publish at a given frequency (2 mins is default), or 0 for off.

Removed

  • thermostat scan and autodetect deep functions
  • removed Event Logging to SPIFFS (worried about wearing). Replaced with SysLog.

[1.9.3] 2019-10-26

Added

  • Report # TCP dropouts in the system command. These could be due to WiFI or MQTT disconnected.
  • Added temp and mode to the MQTT thermostat_cmd topic

Fixed

  • vertical bar showing in WebUI sidebar menu using FireFox

Changed

  • Heartbeat MQTT payload is now in JSON
  • platformio.ini targets. Use debug for custom builds.

[1.9.2] 2019-10-19

Important! This build has breaking changes:

  • MQTT topics have changed. Use the mqttlog command to see the names of the subscriptions and the format of the payload data. Also reference the Wiki page.
  • Home Assistant .yaml files need updating to reflect the recent MQTT changes
  • The web builder has been upgraded to use Gulp 4. Remove tools/webfilesbuilder/node_modules and re-install the libraries using npm ci from within the tools/webfilesbuilder folder

Added

  • Handling of Mixing Module MM100 Status Messages (thanks @kstaniek)
  • Retrieve/Set thermostat mode for Junkers FW100/120 thermostats (thanks @Neonox31)
  • Added sending of all Mixer Module data via MQTT (thanks @peclik)
  • Improved handling of MQTT publish and subscribe errors
  • Added MQTT QOS (mqtt_qos, default 0), Keep Alive (mqtt_keepalive, default 60 seconds) and Retain (mqtt_retain, default off) as parameters to both telnet and WebUI

Fixed

  • publish command also sends Dallas external temperature sensor values
  • log_events setting wasn't persisted in config file

Changed

  • External dallas sensor values sent in MQTT payload as float values and not strings
  • All MQTT topics for the Thermostat have the Heating Circuit appended (e.g. thermostat_data1). This includes the commands.
  • Shower timer and shower alert and not MQTT published at boot up
  • Heating Active logic change to use Selected Flow Temp of min 30 instead of 70 (emsesp#193)
  • Cleaned up Telnet messages during bootup to only show key information.

Removed

  • Removed telnet command shower timer and shower alert to toggle the switches

[1.9.1] 2019-10-05

Added

  • Support for multiple Heating Circuits - emsesp#162
  • new mqttlog command also shows which MQTT topics it is subscribed too
  • Optimized event log loading in web and added integrity checks on all config and log files during boot
  • autodetect quick for detecting known devices from our database list
  • log_events option, now optional to save the log events to SPIFFS

Fixed

  • fixed zero values (0.0) for setpoint temperature with the RC35 thermostat when in Auto mode - emsesp#180
  • added check for corrupted event log, which could happen due to SPIFFS writing while UART is active
  • made Junkers work again (broke in 1.9.0)

Changed

  • Web login password is now mandatory
  • Faster detection of EMS devices on bus by using the 0x07 telegram instead of the brute-force scan
  • Fixes to the default HA climate component .yaml file to support latest Home Assistance ('heat' added)
  • Update documentation in Wiki on MQTT and troubleshooting
  • Slowed down firmware upload via the Web to prevent users rebooting too early
  • Change way WiFi is intialized to prevent dual AP and Client

Removed

  • Removed heating_circuit config setting
  • Removed showing the JSON config files when Saving from the Web

[1.9.0] 2019-09-01

Changed

  • New web interface with more features showing Boiler, Thermostat, Solar Module and Heat Pump. See https://github.com/proddy/EMS-ESP/wiki/Running-and-Monitoring
  • Merged with @susisstrolch's TxMode2 branch for improved support for sending EMS packages. This is the default tx mode.
  • Upgraded MyESP library optimizations for WiFi, AP and error handling
  • reboot command renamed to restart to keep consistent with web interface
  • Renamed heartbeat to mqtt_heartbeat in config settings
  • Renamed MQTT topic "wwactivated" to "boiler_cmd_wwactivated"

Fixed

  • Handle Read and Write to EMS+ device logic changed, tested with RC3000

[1.8.1] 2019-07-27

Added

  • Added back -DCRASH in Debug build target for capturing any ESP8266 stack dumps during crashes
  • Basic Web Interface, for checking stats and setting wifi credentials. See wiki for more details.
  • reset firmware option. If the reset button on the ESP is pressed during boot up sequence (the LED is flashing very fast) all settings are erased and goes into AP mode.
  • Added tx_mode back with options 0,1 and 2 until we've fixed option 2 that works for everyone and doesn't reset ESP
  • More solar module data captured, thanks to @Vuego123
  • Detect thermostat mode for EMS+ RC300/Moduline 3000
  • MQTT message to set boiler flowtemp (boiler_cmd_flowtemp). See wiki.

Fixed

  • Detecting unset values in the SPIFFS and setting default values
  • Bosch Easy Connect wrongly classified as a thermostat
  • Correctly handle telegrams who's size are exactly 32 bytes (e.g. 0x19 MonitorSlow)
  • Telnet also available when in AP mode
  • Handling of thermostat temperatures that were single bytes and couldn't exceed 25.5 (0xFF) degrees!

Changed

  • Improved handling of Solar Modules (thanks @Vuego123)
  • publish_wait renamed to publish_time, a value of 0 means disabling all MQTT sending
  • How signed shorts are handled such as the current and setpoint temps on RC300s
  • Stopped automatic refresh of web page, which causes crashes/memory loss after a short time
  • Support HA 0.96 climate component changes
  • -DDEFAULT_NO_SERIAL changed to -DFORCE_SERIAL
  • some code cleanups, removing NULLS and moving some things fron heap to stack to prevent memory fragmentation

[1.8.0] 2019-06-15

Added

  • HeatPump support (e.g. the Nefit Enviline)
  • new device: Buderus MM50 Mixer
  • new devices: Junkers FW100 and ISM1 (thanks Vuego123)
  • Improved Tx logic to support EMS, EMS+ and Heatronic 3 (thanks kwertie01, susisstrolch, philrich)
  • MQTT heartbeat

Fixed

  • runtime exceptions with latest 2.5.1 arduino core

[1.7.0] 2019-05-11

Added

  • EMS+ core support (thanks too @gl3nni3 for doing the first research)
  • MQTT 'restart' topic to reboot ESP (thanks @balk77)
  • Support for multiple thermostat heating circuits like the HC1/HC2 on a RC35, also via MQTT (thanks @lobocobra)
  • boiler flowtemp command to set the flow temperature (issue 59)
  • added a test harness to try out response to various telegrams (test command)
  • tx_delay setting for circuits where we needed to slow down Tx transmission
  • new boiler: Nefit proline hrc 24 cw4 thermostat and Nefit Enviline heatpump
  • new boiler: Buderus Logamax plus
  • new thermostat: Buderus RC300 and RC310 thermostats, read-only (issue 37)
  • new thermostat: Junkers FR10, read-only (issue 98)
  • new devices: Buderus Web Gateway KM200, Buderus Solar Module SM100

Changed

  • types renamed to devices to also show all detected devices
  • renamed silent_mode to listen_mode
  • increased Tx queue to 100

[1.6.0] 2019-03-24

Added

  • system command to show ESP8266 stats
  • crash command to see stack of last system crash, with .py files to track stack dump (compile with -DCRASH)
  • publish dallas external temp sensors to MQTT (thanks @JewelZB)
  • shower timer and shower alert options available via set commands
  • added support for warm water modes Hot, Comfort and Intelligent (issue 67)
  • added set publish_time to set how often to force a publish of MQTT
  • support for SM10 Solar Module including MQTT (issue 77)
  • refresh command to force a fetch of all known data from the connected EMS devices

Fixed

  • incorrect rendering of null temperature values (the -3200 degrees issue)
  • OTA is more stable
  • Added a hack to overcome WiFi power issues in arduino core 2.5.0 libraries causing constant wifi re-connects
  • Performance issues with telnet output

Changed

  • included various fixes and suggestions from @nomis
  • upgraded MyESP library with many optimizations
  • test_mode renamed to silent_mode
  • set wifi replaced with set wifi_ssid and set wifi_password to allow values with spaces
  • EMS values are stored in the raw format and only converted to strings when displayed or published, removing the need for parsing floats
  • All floating point temperatures are to one decimal place (issue 79)

[1.5.6] 2019-03-09

Added

  • test_mode option

Changed

  • upgraded MyESP library
  • minor changes

[1.5.5] 2019-03-07

Fixed

  • Support the latest ArduinoJson v6 and espressif8266 2.0.4 libraries (in PlatformIO do a pio lib update and pio update)

Changed

  • MQTT keep alive to 2 minutes (60 seconds was just too short for slower networks)
  • Improved MQTT startup time
  • Setting wifi or mqtt settings are immediate, no need to restart the ESP
  • Text changes in the help

Added

  • Show if MQTT is connected
  • Show version of MyESP (the custom MQTT, Wifi, OTA, MDNS, Telnet library)
  • EMS-OT OpenTherm connector

[1.5.4] 2019-03-03

Changed

  • MQTT keep alive changed from 5 minutes to 1 minute

Added

  • Callback for OTA. This is used to disable EMS bus during a firmware OTA update, which caused problems with the latest ESP89266 core libraries
  • Added rough estimate of WiFi signal strength to info page
  • Added the build time & date to the info page (optional in platformio.ini)

[1.5.3] 2019-02-22

Changed

  • Support for latest esp8266 arduino core version 2.5.0 and platform espressif8266 version 2.0.0
  • Added board type to the info screen

Added

  • Improved MQTT LWT (Last Will Testament). Uses payload called 'online' and 'offline'. See emsesp#57
  • Added ESP32 support to MyESP library
  • Added Bosch Easy thermostat, Buderus Logamax U122
  • Support for changing boiler wwtemp via MQTT (merge #58 from egrekov). thanks!

Removed

  • Custom MDNS support. Now handled much better in the new esp core under OTA

[1.5.2] 2019-02-04

Changed

  • Change wifi settings using the set wifi <ssid> <password> command

Added

  • Added incoming MQTT "TOPIC_BOILER_WWACTIVATED" to set the warm water on/off. Payload is 1 or 0. See issue.
  • Added the list of all MQTT topics to the README file

[1.5.1] 2019-02-03

Fixed

  • issue with Serial monitoring conflicting with UART when both running
  • Fixed typo with -D settings in the example platformio.ini

Changed

  • thermostat temp now except floats (e.g. 20.5). Some thermostats may round up or down if they use 0.5 intervals.

[1.5.0] 2019-02-03

Added

  • Support for RC10 thermostat
  • New command set serial

Changed

  • Improved Tx logic. Retries are more efficient and startup is faster and less error prone.
  • "# Rx telegrams" and "# Tx telegrams" show number of successful Reads and Writes initiated by the user or automatically by the code. This makes it easy to see if the Tx is working.
  • Some refactoring in preparation for the EMS+ support coming soon

Removed

  • Removed the poll and tx commands
  • DEBUG_SUPPORT. Now controlled with the 'set serial' command
  • removed MQTT and WIFI settings from my_config.h. These have to be set either within the application (using set) or hardcoded in platformio.ini You can now check in my_config.h without everyone seeing your passwords!
  • TxCapable removed from info

[1.4.1] 2019-01-29

Added

  • The led pin, dallas pin and both thermostat and boiler type IDs can be set with the application, and stored.

Changed

  • some minor improvements to autodetect

[1.4.0] 2019-01-27

Changed

  • last will MQTT topic prefixed with a header like the rest of the topics
  • All double and float numbers rendered to 2 decimal places (precision = 2)
  • Default logging set to None when starting a telnet session

Added

  • Added support for external Dallas sensors (DS1822, DS18S20, DS18B20, DS1825). See readme
  • Added UBAParametersMessage type to fetch boiler modulation min & max values
  • Report shows system load average

[1.3.2] 2019-01-23

Fixed

  • Handle thermostats that don't have builtin temperature sensors when showing current temperature (emsesp#18 (comment))

Changed

  • Improved way to identify if the EMS bus is connected
  • Improved 'types' command to show more details
  • Improved auto detect of thermostat types

Added

  • Some more devices like the Nefit Topline & RC310 thermostat recognition
  • Added a check to see Tx is possible. See 'Tx Capable' under the 'info' screen

Removed

  • Removed MY_BOILER_MODELID from my_config.h. It's always hardcoded.

[1.3.1] 2019-01-12

Fixed

  • telnet commands with set are no longer forced to lower case

Changed

  • Custom settings (e.g set led) moved outside MyESP
  • Moved all MQTT to my_config.h making it independent from Home Assistant

Added

  • MQTT keep alive, last will testament and other settings all configurable in my_config.h
  • RC35: MQTT day/night/auto mode; sets setpoint temperature in type 0x3D depends on current night/day Mode (@SpaceTeddy) #33

[1.3.0] 2019-01-09

Changed

  • Renamed project from EMS-ESP-Boiler to EMS-ESP since it's kinda EMS generic now
  • Support for RC20RF and RFM20 (emsesp#18)
  • Moved all EMS device information into a separate file ems_devices.h so no longer need to touch ems.h
  • Telnet commands can be strings now and output is suspended when typing

Removed

  • Removed SHOWER_TEST
  • Removed WIFI and MQTT credentials from the platformio.ini file

Added

  • Settings are saved and loaded from the ESP8266's file system (SPIFFS). Can be set using the 'set' command
  • Improved support when in Access Point mode (192.168.4.1)
  • pre-built firmwares are back

[1.2.4] 2019-01-04

Changed

  • Scanning known EMS Devices now ignores duplicates (emsesp#30)
  • ServiceCode stored as a two byte char
  • Support for RC20RF and RFM20 (emsesp#18)

[1.2.3] 2019-01-03

Fixed

  • Can now hardcode Boiler and Thermostat types in my_config.h to bypass auto-detection
  • Fixed MQTT subscribing to Heating and Hot Water active topics
  • Fixed for listening to incoming MQTT topics (emsesp#27)
  • Fixed handling of current temperature on an RC35-type thermostat that doesn't have a sensor (emsesp#18)

[1.2.2] 2019-01-02

Fixed

  • Issues in 1.2.1 (see emsesp#25)
  • Logic for determining if there is activity on the EMS bus and using the onboard LEDs properly

[1.2.1] 2019-01-02

Fixed

  • Only process broadcast messages if the offset (byte 4) is 0. (emsesp#23)
  • Improved checking for duplicate sent Tx telegrams by comparing CRCs
  • Removed distiquishing between noise on the line and corrupt telegrams (emsesp#24)

[1.2.0] 2019-01-01

Fixed

  • Incorrect indenting in climate.yaml (thanks @mrfixit1)
  • Improved support for slower WiFi connections
  • Fixed issue with OTA not always giving back a completion response to platformio
  • Fixed issue with repeating reads after a raw mode send
  • Fixed handling of long integers (thanks @SpaceTeddy)

Added

  • added 'dout' flashmode to platformio.ini so OTA works now when uploading to a Wemos D1 Pro's or any other board with larger flash's
  • added un tested supporting RC35 type of thermostats
  • Try and discover and set Boiler and Thermostat types automatically
  • Fetch UBATotalUptimeMessage from Boiler to get total working minutes
  • Added check to see if bus is connected. Shown in stats page
  • If no Wifi connection can be made, start up as a WiFi Access Point (AP)
  • Report out service codes and water-flow pull-request. Thanks @Bonusbartus

Changed

  • Build option is called DEBUG_SUPPORT (was USE_SERIAL)
  • Replaced old ESPHelper with my own MyESP library to handle Wifi, MQTT, MDNS and Telnet handlers. Supports asynchronous TCP and has smaller memory footprint. And moved to libs directory.
  • Simplified LED error checking. If enabled (by default), solid means connected and flashing means error. Uses either an external pull-up or the onboard ESP8266 LED.
  • Improved Telnet debugging which uses TelnetSpy to keep a buffer of previous output
  • Optimized memory usage & heap conflicts, removing nasty things like strcpy, sprintf where possible
  • Improved checking for tap water on/off (thanks @Bonusbartus)

Removed

  • Time and TimeLib's. Not used in code.
  • Removed build option MQTT_MAX_PACKAGE_SIZE as not using the PubSubClient library any more
  • Removed all of Espurna's pre-built firmwares and instructions to build. Keeping it simple.

[1.1.1] 2018-12-23

Removed

  • Espurna build notes and ready made firmware

[1.1.0] 2018-12-22

Fixed

Added

Changed

  • Improved overall formatting of logging
  • Include app name and version in telnet help
  • Improved method to switch off hot tap water in Shower Alert
  • Telnet P and M commands have changed
  • Enabling Logging in telnet is now the 'l' command
  • Logging is set back to None when telnet session closes
  • Improved fetching of initial boiler values to post to MQTT at startup
  • Improved handling and retrying of write/Tx commands

Removed

  • Hid access from telnet to the Experimental custom function command 'x'
  • Tx and Rx stats have gone from the stats page, as they were pretty meaningless
  • Removed NO_TX define in platformio and replaced with system parameter 'command X'
  • Removed -DDEBUG option in build
  • Removed wwtemp MQTT messages to set the boiler temp. You'll never miss it.
  • Removed LEDs for Tx, Rx and Err. Too many flashing lights and it drains the current.
  • Removed capturing of last Rx and Tx times
  • Support for older RC20 thermostats

Known Issues

  • There's a nasty memory leek when in telnet's verbose mode with sending which causes the EMS to reset when running for a while.

[1.0.1] 2018-09-24

  • Initial stable version

[0.1.0] 2018-05-14

  • Initial development version