diff --git a/CHANGELOG.md b/CHANGELOG.md index 88993e790..1c8357d7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,93 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [3.7.0] 27 October 2024 + +## **IMPORTANT! BREAKING CHANGES with 3.6.5** + +- "ww" and "wwc" has been renamed to "dhw". It is nested JSON object in both the MQTT and API outputs. The old prefix has also been removed from MQTT topics ([#1634](https://github.com/emsesp/EMS-ESP32/issues/1634)). This will impact historical data in home automation systems like Home Assistant and IOBroker. To preserve the current value of dhw energy (was previously nrgww) refer to this issue [#1938](https://github.com/emsesp/EMS-ESP32/issues/1938). +- dhw entities from the MM100/SM100 have been moved under a new Device called 'water'. +- The automatically generated temperature sensor ID has replaced dashes (`-`) with underscores (`_`) to be compatible with Home Assistant. +- `api/system/info` has it's JSON key names changed to camelCase syntax. + +For more details go to [www.emsesp.org](https://www.emsesp.org/). + +## Added + +- some more entities for dhw with SM100 module +- thermostat second dhw circuit [#1634](https://github.com/emsesp/EMS-ESP32/issues/1634) +- remote thermostat emulation for RC100H, RC200 and FB10 [#1287](https://github.com/emsesp/EMS-ESP32/discussions/1287), [#1602](https://github.com/emsesp/EMS-ESP32/discussions/1602), [#1551](https://github.com/emsesp/EMS-ESP32/discussions/1551) +- heatpump dhw stop temperatures [#1624](https://github.com/emsesp/EMS-ESP32/issues/1624) +- reset history [#1695](https://github.com/emsesp/EMS-ESP32/issues/1695) +- heatpump entities `fan` and `shutdown` [#1690](https://github.com/emsesp/EMS-ESP32/discussions/1690) +- mqtt HA-mode 3 for v3.6 compatible HA entities, set on update v3.6->v3.7 +- HP input states [#1723](https://github.com/emsesp/EMS-ESP32/discussions/1723) +- holiday settings for rego 3000 [#1735](https://github.com/emsesp/EMS-ESP32/issues/1735) +- Added scripts for OTA (scripts/upload.py and upload_cli.py) [#1738](https://github.com/emsesp/EMS-ESP32/issues/1738) +- timeout for remote thermostat emulation [#1680](https://github.com/emsesp/EMS-ESP32/discussions/1680), [#1774](https://github.com/emsesp/EMS-ESP32/issues/1774) +- CR120 thermostat as own model() [#1779](https://github.com/emsesp/EMS-ESP32/discussions/1779) +- modules - external linkable module library [#1778](https://github.com/emsesp/EMS-ESP32/issues/1778) +- scheduler onChange and Conditions [#1806](https://github.com/emsesp/EMS-ESP32/issues/1806) +- make remote control timeout editable [#1774](https://github.com/emsesp/EMS-ESP32/issues/1774) +- added extra pump characteristics (mode and pressure for EMS+) by @SLTKA [#1802](https://github.com/emsesp/EMS-ESP32/pull/1802) +- allow device name to be customized [#1174](https://github.com/emsesp/EMS-ESP32/issues/1174) +- Modbus support by @mheyse [#1744](https://github.com/emsesp/EMS-ESP32/issues/1744) +- System Message command [#1854](https://github.com/emsesp/EMS-ESP32/issues/1854) +- scheduler can use web get/post for values and commands [#1806](https://github.com/emsesp/EMS-ESP32/issues/1806) +- RT800 remote emulation [#1867](https://github.com/emsesp/EMS-ESP32/issues/1867) +- RC310 cooling parameters [#1857](https://github.com/emsesp/EMS-ESP32/issues/1857) +- command `api/device/entities` [#1897](https://github.com/emsesp/EMS-ESP32/issues/1897) +- switchprogmode [#1903](https://github.com/emsesp/EMS-ESP32/discussions/1903) +- autodetect and download firmware upgrades via the WebUI +- command 'show log' that lists out the current weblog buffer, showing last messages. +- default web log buffer to 25 lines for ESP32s with no PSRAM +- try and determine correct board profile if none is set during boot +- auto Scroll in WebLog UI - reduced delay so incoming logs are faster +- uploading custom support info, shown to Guest users in Help page [#2054](https://github.com/emsesp/EMS-ESP32/issues/2054) +- feature: Dashboard showing all data (favorites, sensors, custom) [#1958](https://github.com/emsesp/EMS-ESP32/issues/1958) +- entity for low-temperature boilers pump start temp (pumpOnTemp) #2088 [#2088](https://github.com/emsesp/EMS-ESP32/issues/2088) +- internal ESP32 temperature sensor on the S3 [#2077](https://github.com/emsesp/EMS-ESP32/issues/2077) +- MQTT status topic (used in connect and last will) set to Retain [#2086](https://github.com/emsesp/EMS-ESP32/discussions/2086) +- Czech language [2096](https://github.com/emsesp/EMS-ESP32/issues/2096) +- Developer Mode and send EMS Read Commands from WebUI [#2116](https://github.com/emsesp/EMS-ESP32/issues/2116) +- Scheduler functions [#2115](https://github.com/emsesp/EMS-ESP32/issues/2115) +- Set device custom name from telegram 0x01 [#2073](https://github.com/emsesp/EMS-ESP32/issues/2073) + +## Fixed + +- remote thermostat emulation for RC200 on Rego2000/3000 thermostats [#1691](https://github.com/emsesp/EMS-ESP32/discussions/1691) +- log shows data for F7/F9 requests +- Detection of LittleFS for factory setting wasn't working +- Check for bad GPIOs with Ethernet before the ethernet is initialized +- Show values with factor 50 on webUI [#2064](https://github.com/emsesp/EMS-ESP32/issues/2064) +- Rendering of values between -1 and 0 +- Value for 32bit times not-set [#2109](https://github.com/emsesp/EMS-ESP32/issues/2109) + +## Changed + +- use flag for BC400 compatible thermostats, manage different mode settings +- use factory partition for 16M flash +- store digital out states to nvs +- Refresh UI - moving settings to one location [#1665](https://github.com/emsesp/EMS-ESP32/issues/1665) +- rename DeviceValueTypes, add UINT32 for custom entities +- dynamic register dhw circuits for thermostat +- removed OTA feature [#1738](https://github.com/emsesp/EMS-ESP32/issues/1738) +- added shower min duration [#1801](https://github.com/emsesp/EMS-ESP32/issues/1801) +- Include TXT file along with the generated CSV for Device Data export/download +- thermostat/remotetemp as command [#1835](https://github.com/emsesp/EMS-ESP32/discussions/1835) +- temperaturesensor id notation with underscore [#1794](https://github.com/emsesp/EMS-ESP32/discussions/1794) +- Change key-names in JSON to be compliant and consistent [#1860](https://github.com/emsesp/EMS-ESP32/issues/1860) +- Updates to webUI [#1920](https://github.com/emsesp/EMS-ESP32/issues/1920) +- Correct firmware naming #1933 [#1933](https://github.com/emsesp/EMS-ESP32/issues/1933) +- Don't start Serial console if not connected to a Serial port. Will initiate manually after a CTRL-C/CTRL-S +- WebLog UI matches color schema of the terminal console correctly +- Updated Web libraries, ArduinoJson +- Help page doesn't show detailed tech info if the user is not 'admin' role [#2054](https://github.com/emsesp/EMS-ESP32/issues/2054) +- removed system command `allvalues` and moved to an action called `export` +- Show ems-esp internal devices in device list of system/info +- Scheduler and mqtt run async on systems with psram +- Show IPv6 address type (local/global/ula) in log + ## [3.6.5] March 23 2024 ## **IMPORTANT! BREAKING CHANGES** diff --git a/CHANGELOG_LATEST.md b/CHANGELOG_LATEST.md index 0eeb3a948..02ccf8ebe 100644 --- a/CHANGELOG_LATEST.md +++ b/CHANGELOG_LATEST.md @@ -1,88 +1,13 @@ # Changelog -## [3.7.0] +## [3.7.1] -## **IMPORTANT! BREAKING CHANGES with 3.6.5** - -- "ww" and "wwc" has been renamed to "dhw". It is nested JSON object in both the MQTT and API outputs. The old prefix has also been removed from MQTT topics ([#1634](https://github.com/emsesp/EMS-ESP32/issues/1634)). This will impact historical data in home automation systems like Home Assistant and IOBroker. To preserve the current value of dhw energy (was previously nrgww) refer to this issue [#1938](https://github.com/emsesp/EMS-ESP32/issues/1938). -- dhw entities from the MM100/SM100 have been moved under a new Device called 'water'. -- The automatically generated temperature sensor ID has replaced dashes (`-`) with underscores (`_`) to be compatible with Home Assistant. -- `api/system/info` has it's JSON key names changed to camelCase syntax. +## **IMPORTANT! BREAKING CHANGES with 3.7.0** For more details go to [www.emsesp.org](https://www.emsesp.org/). ## Added -- some more entities for dhw with SM100 module -- thermostat second dhw circuit [#1634](https://github.com/emsesp/EMS-ESP32/issues/1634) -- remote thermostat emulation for RC100H, RC200 and FB10 [#1287](https://github.com/emsesp/EMS-ESP32/discussions/1287), [#1602](https://github.com/emsesp/EMS-ESP32/discussions/1602), [#1551](https://github.com/emsesp/EMS-ESP32/discussions/1551) -- heatpump dhw stop temperatures [#1624](https://github.com/emsesp/EMS-ESP32/issues/1624) -- reset history [#1695](https://github.com/emsesp/EMS-ESP32/issues/1695) -- heatpump entities `fan` and `shutdown` [#1690](https://github.com/emsesp/EMS-ESP32/discussions/1690) -- mqtt HA-mode 3 for v3.6 compatible HA entities, set on update v3.6->v3.7 -- HP input states [#1723](https://github.com/emsesp/EMS-ESP32/discussions/1723) -- holiday settings for rego 3000 [#1735](https://github.com/emsesp/EMS-ESP32/issues/1735) -- Added scripts for OTA (scripts/upload.py and upload_cli.py) [#1738](https://github.com/emsesp/EMS-ESP32/issues/1738) -- timeout for remote thermostat emulation [#1680](https://github.com/emsesp/EMS-ESP32/discussions/1680), [#1774](https://github.com/emsesp/EMS-ESP32/issues/1774) -- CR120 thermostat as own model() [#1779](https://github.com/emsesp/EMS-ESP32/discussions/1779) -- modules - external linkable module library [#1778](https://github.com/emsesp/EMS-ESP32/issues/1778) -- scheduler onChange and Conditions [#1806](https://github.com/emsesp/EMS-ESP32/issues/1806) -- make remote control timeout editable [#1774](https://github.com/emsesp/EMS-ESP32/issues/1774) -- added extra pump characteristics (mode and pressure for EMS+) by @SLTKA [#1802](https://github.com/emsesp/EMS-ESP32/pull/1802) -- allow device name to be customized [#1174](https://github.com/emsesp/EMS-ESP32/issues/1174) -- Modbus support by @mheyse [#1744](https://github.com/emsesp/EMS-ESP32/issues/1744) -- System Message command [#1854](https://github.com/emsesp/EMS-ESP32/issues/1854) -- scheduler can use web get/post for values and commands [#1806](https://github.com/emsesp/EMS-ESP32/issues/1806) -- RT800 remote emulation [#1867](https://github.com/emsesp/EMS-ESP32/issues/1867) -- RC310 cooling parameters [#1857](https://github.com/emsesp/EMS-ESP32/issues/1857) -- command `api/device/entities` [#1897](https://github.com/emsesp/EMS-ESP32/issues/1897) -- switchprogmode [#1903](https://github.com/emsesp/EMS-ESP32/discussions/1903) -- autodetect and download firmware upgrades via the WebUI -- command 'show log' that lists out the current weblog buffer, showing last messages. -- default web log buffer to 25 lines for ESP32s with no PSRAM -- try and determine correct board profile if none is set during boot -- auto Scroll in WebLog UI - reduced delay so incoming logs are faster -- uploading custom support info, shown to Guest users in Help page [#2054](https://github.com/emsesp/EMS-ESP32/issues/2054) -- feature: Dashboard showing all data (favorites, sensors, custom) [#1958](https://github.com/emsesp/EMS-ESP32/issues/1958) -- entity for low-temperature boilers pump start temp (pumpOnTemp) #2088 [#2088](https://github.com/emsesp/EMS-ESP32/issues/2088) -- internal ESP32 temperature sensor on the S3 [#2077](https://github.com/emsesp/EMS-ESP32/issues/2077) -- MQTT status topic (used in connect and last will) set to Retain [#2086](https://github.com/emsesp/EMS-ESP32/discussions/2086) -- Czech language [2096](https://github.com/emsesp/EMS-ESP32/issues/2096) -- Developer Mode and send EMS Read Commands from WebUI [#2116](https://github.com/emsesp/EMS-ESP32/issues/2116) -- Scheduler functions [#2115](https://github.com/emsesp/EMS-ESP32/issues/2115) -- Set device custom name from telegram 0x01 [#2073](https://github.com/emsesp/EMS-ESP32/issues/2073) - ## Fixed -- remote thermostat emulation for RC200 on Rego2000/3000 thermostats [#1691](https://github.com/emsesp/EMS-ESP32/discussions/1691) -- log shows data for F7/F9 requests -- Detection of LittleFS for factory setting wasn't working -- Check for bad GPIOs with Ethernet before the ethernet is initialized -- Show values with factor 50 on webUI [#2064](https://github.com/emsesp/EMS-ESP32/issues/2064) -- Rendering of values between -1 and 0 -- Value for 32bit times not-set [#2109](https://github.com/emsesp/EMS-ESP32/issues/2109) - ## Changed - -- use flag for BC400 compatible thermostats, manage different mode settings -- use factory partition for 16M flash -- store digital out states to nvs -- Refresh UI - moving settings to one location [#1665](https://github.com/emsesp/EMS-ESP32/issues/1665) -- rename DeviceValueTypes, add UINT32 for custom entities -- dynamic register dhw circuits for thermostat -- removed OTA feature [#1738](https://github.com/emsesp/EMS-ESP32/issues/1738) -- added shower min duration [#1801](https://github.com/emsesp/EMS-ESP32/issues/1801) -- Include TXT file along with the generated CSV for Device Data export/download -- thermostat/remotetemp as command [#1835](https://github.com/emsesp/EMS-ESP32/discussions/1835) -- temperaturesensor id notation with underscore [#1794](https://github.com/emsesp/EMS-ESP32/discussions/1794) -- Change key-names in JSON to be compliant and consistent [#1860](https://github.com/emsesp/EMS-ESP32/issues/1860) -- Updates to webUI [#1920](https://github.com/emsesp/EMS-ESP32/issues/1920) -- Correct firmware naming #1933 [#1933](https://github.com/emsesp/EMS-ESP32/issues/1933) -- Don't start Serial console if not connected to a Serial port. Will initiate manually after a CTRL-C/CTRL-S -- WebLog UI matches color schema of the terminal console correctly -- Updated Web libraries, ArduinoJson -- Help page doesn't show detailed tech info if the user is not 'admin' role [#2054](https://github.com/emsesp/EMS-ESP32/issues/2054) -- removed system command `allvalues` and moved to an action called `export` -- Show ems-esp internal devices in device list of system/info -- Scheduler and mqtt run async on systems with psram -- Show IPv6 address type (local/global/ula) in log diff --git a/src/version.h b/src/version.h index 6db2209bc..38000eeed 100644 --- a/src/version.h +++ b/src/version.h @@ -1 +1 @@ -#define EMSESP_APP_VERSION "3.7.0-dev.49" \ No newline at end of file +#define EMSESP_APP_VERSION "3.7.1-dev.0" \ No newline at end of file