Merge remote-tracking branch 'origin/dev' into main

.github/ISSUE_TEMPLATE/bug_report.md

@@ -17,7 +17,7 @@ assignees: ''
 *You can now remove this line and the above ones. Text in italic is meant to be replaced by your own words. If any of the sections below are not relevant to the issue (for instance, the screenshots) then you can delete them.*
 
 **Bug description**
-*A clear and concise description of what the bug is.*
+*A clear and concise description of what the bug is. Mention which EMS-ESP version you're using.*
 
 **Steps to reproduce**
 *Steps to reproduce the behavior.*
@@ -29,7 +29,7 @@ assignees: ''
 *If applicable, add screenshots to help explain your problem.*
 
 **Device information**
-*Copy-paste here the information as it is outputted by the device. You can get this information by from http://ems-esp.local/api?device=system&cmd=report.*
+*Copy-paste here the information as it is outputted by the device. You can get this information by from http://ems-esp.local/api?device=system&cmd=info*
 
 **Additional context**
 *Add any other context about the problem here.*

.github/ISSUE_TEMPLATE/questions---troubleshooting.md

@@ -23,7 +23,7 @@ assignees: ''
 *If applicable, add screenshots to help explain your problem.*
 
 **Device information**
-*Copy-paste here the information as it is outputted by the device. You can get this information from http://ems-esp.local/api?device=system&cmd=report.*
+*Copy-paste here the information as it is outputted by the device. You can get this information from http://ems-esp.local/api?device=system&cmd=info*
 
 **Additional context**
 *Add any other context about the problem here.*

.github/workflows/build_firmware.yml

@@ -41,8 +41,8 @@ jobs:
 
       - name: Build images
         run: |
-          platformio run -e esp8266
-          platformio run -e esp32
+          platformio run -e esp8266-ci
+          platformio run -e esp32-ci
           
       - name: Delete
         uses: dev-drprasad/delete-tag-and-release@v0.1.2

.github/workflows/release_main.yml

@@ -36,8 +36,8 @@ jobs:
 
       - name: Build images
         run: |
-          platformio run -e esp8266
-          platformio run -e esp32
+          platformio run -e esp8266-ci
+          platformio run -e esp32-ci
           
       - name: Changelog
         run: cat RELEASENOTES.md CHANGELOG_LATEST.md > BODY.txt 

.gitignore

@@ -2,23 +2,25 @@
 .vscode
 
 # build
-/build/
+build/
 .clang_complete
 .gcc-flags.json
+cppcheck.out.xml
+debug.log
 
 # platformio
 .pio
 pio_local.ini
+.VSCodeCounter/
 
 # OS specific
 .DS_Store
 *Thumbs.db
 
 # project specfic
-/scripts/stackdmp.txt
+scripts/stackdmp.txt
 emsesp
-firmware
-/data/www/
-/lib/framework/WWWData.h
-/interface/build/
-/interface/node_modules/
+data/www/
+lib/framework/WWWData.h
+interface/build/
+interface/node_modules/

CHANGELOG.md

@@ -5,6 +5,51 @@ 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).
 
+## [2.2.0] December 28 2020
+
+### Added
+- function keys in editor: cursor, del, home, end. F1=help, F2=show, and other shortcuts
+- SM100 pump working time and energy units
+- heating curve parameters and commands for RC300
+- `wwonetime` for RC300 thermostat
+- expose test framework via api (#611)
+- SysLog has enable/disable flag in WebUI
+- Add solar configuration telegrams (#616) [thanks @hpanther]
+- `log trace` shows decoded or optional raw telegrams, `watch unknown` for only unknown telegrams
+- WM10 switch telegrams
+- boiler information (#633), pumpmod min/max commands
+- maintenance message and command
+- thermostat program, reducemode, controlmode
+- optional delayed start for sending tx-telegrams to prevent conflicts with KM200
+- RC35 holiday setting with `+` for 'at home'
+
+### Fixed
+- mixer IPM pumpstatus
+- mixer devices in HA were incorrectly named
+- Prevent HA MQTT config messages for thermostat that has no 'currtemp' (#582)
+- serviceCodeNumber, 3-char serviceCode, exhausttemp and heating_active for newer ems+ boilers
+- prevent MQTT publish messages from sending twice
+- repeated output on read commands
+- heating_active for ems+
+
+### Changed
+- optimized MQTT for HA to reduce heap fragmentation issues
+- change syslog settings without reboot
+- HA-config split in smaller blocks
+- commands `fetch` and `publish [ha]` as call
+- mqtt json package sizes
+- renamed the command system info (which showed settings) to `settings`
+- renamed the command system report (Which dumped debug info) to `info`
+- Changing settings via web restarts only selected services
+- renamed pio targets (esp8266-ci and esp32-ci for GitHub CI)
+- telnet default settings `log info`, timeout 60 min
+- `log debug` not showing telegram names, use `log trace` or `watch on` to show the telegrams
+- optimized how console and web display device data ([#632](https://github.com/proddy/EMS-ESP/issues/632))
+
+### Removed
+- old shell and python build scripts
+
+
 ## [2.1.0] October 31 2020
 
 ### Added
@@ -39,7 +84,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix writing to the Junkers FR120 thermostat
 - support for changing summermode
 - added missing `heatingtype` to thermostat data
-- handle incomming ems+ read requests, ignore F7 telegrams with 3byte-id
+- handle incoming ems+ read requests, ignore F7 telegrams with 3byte-id
 - fix month for setting clock from NTP
 
 ### Changed

CHANGELOG_LATEST.md

@@ -1,51 +1,9 @@
 # Changelog
 
 ### Added
-- boiler `heatingactivated`, automatic select parameter telegrams for write
-- boiler `wWType` parameter, in Console and MQTT
-- support for uploading compressed firmware binaries in web UI
-- setting to manually override the MQTT retain flag
-- New API via HTTP REST API to read and set values. See https://emsesp.github.io/docs/#/API
-- `show commands` command
-- exporting of system settings using the `system info` command in Web and Console. Added link into the Web's Settings page.
-- setting to change how booleans are rendered in MQTT (on/off, true/false, 1/0)
-- enable ADC setting, add boiler circulation commands, add thermostat RC300 summermodes
-- Added all device info to web UI for Thermostat and Boiler
-- Added all device values to Home Assistant MQTT Discovery under separate devices and entities
-- Show Rx and Tx quality in Console and Web UI
-- Added button and tooltip to EMS Devices in Web
-- wwtemp and wwtemplow to MQTT, Console and Web
-- summer, winter modes for the CW400 thermostat
-- new command under system called `report`. http://ems-esp/api?device=system&cmd=report to generate a report log for troubleshooting
-- thermostat error codes
-- Console command `publish ha` to also force the creation of the Home Assistant MQTT Discovery topics
-- Heat pump values (dew temperature and relative air humidity)
-- Console up key to repeat last command
-- added RC300 floordrying, building, damped temperature 
 
 ### Fixed
-- fix wwontime readback
-- fixed support for RC300 via MQTT commands (#505)
-- Some minor optimizations to memory handling in the MQTT service
-- Prevent MQTT from publishing empty json payloads
-- Accurate detection of warm water and heating (#515)
-- Fix writing to the Junkers FR120 thermostat
-- support for changing summermode
-- added missing `heatingtype` to thermostat data
-- handle incomming ems+ read requests, ignore F7 telegrams with 3byte-id
-- fix month for setting clock from NTP
 
 ### Changed
-- renamed wWCircPumpType to wWChargeType
-- Installation and Configuration notes moved to the official EMS-ESP documentation site
-- `call` commands can be done from the Console root for all devices
-- Updated EMS-ESP official documentation (https://emsesp.github.io/docs/#/)
-- JWT Secret renamed to Super User Password
-- EMS Devices in Web UI shows button and tooltip to remind users they can click on a device
-- MQTT topic name changes (see doc)
-- Mixing renamed to Mixer
 
 ### Removed
-- Console contexts for thermostat and boiler
-- Removed option to enable/disable the MQTT Heartbeat. It's always on.
-

README.md

@@ -6,7 +6,7 @@
 [![release-date](https://img.shields.io/github/release-date/proddy/EMS-ESP.svg?label=Released)](https://github.com/proddy/EMS-ESP/commits/master)
 [![license](https://img.shields.io/github/license/proddy/EMS-ESP.svg)](LICENSE)
 ![Build Firmware](https://github.com/proddy/EMS-ESP/workflows/Build%20Firmware/badge.svg?branch=dev)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b8880625bdf841d4adb2829732030887)](https://app.codacy.com/app/proddy/EMS-ESP?utm_source=github.com&utm_medium=referral&utm_content=proddy/EMS-ESP&utm_campaign=Badge_Grade_Settings)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/a37be4d45e5f47749b6e356c8e738a80)](https://www.codacy.com/gh/proddy/EMS-ESP/dashboard?utm_source=github.com&utm_medium=referral&utm_content=proddy/EMS-ESP&utm_campaign=Badge_Grade)
 [![downloads](https://img.shields.io/github/downloads/proddy/EMS-ESP/total.svg)](https://github.com/proddy/EMS-ESP/releases)
 [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/proddy/EMS-ESP.svg)](http://isitmaintained.com/project/proddy/EMS-ESP "Average time to resolve an issue")
 [![Percentage of issues still open](http://isitmaintained.com/badge/open/proddy/EMS-ESP.svg)](http://isitmaintained.com/project/proddy/EMS-ESP "Percentage of issues still open")
@@ -82,17 +82,18 @@ If you're looking for support on **EMS-ESP** there are some options available:
 ## **Contributing**
 
 You can contribute to EMS-ESP by
-- providing Pull Requests (Features, Fixes, suggestions).
-- testing new released features and report issues on your EMS equipment.
-- contributing to missing [Documentation](https://emsesp.github.io/docs).
+- providing Pull Requests (Features, Fixes, suggestions)
+- testing new released features and report issues on your EMS equipment
+- contributing to missing [Documentation](https://emsesp.github.io/docs)
 
 ## **Credits**
 
 A shout out to the people helping EMS-ESP get to where it is today...
 - **@MichaelDvP** for all his amazing contributions and patience. Specifically for the improved uart library, thermostat and mixer logic.
 - **@BBQKees** for his endless testing and building the awesome circuit boards
-- **@susisstrolch** for writing a first working version of the EMS bridge circuit which I used to design EMS-ESP version 0.1 back in August 2017
-- plus everyone else providing suggestions, PRs and the odd donation that keep us motivated. Thanks!
+- **@rjwats** for his [esp8266-react](https://github.com/rjwats/esp8266-react) framework that provides the new Web UI
+- **@nomis** for his core [console](https://github.com/nomis/mcu-uuid-console), telnet and syslog core libraries  
+- plus everyone else providing suggestions, PRs and the odd donation that keeps this project open source. Thanks!
 
 ## **License**
 

RELEASENOTES.md

@@ -2,5 +2,5 @@
 
 # Firmware Installation
 
-Follow the instructions in the [documentation](https://emsesp.github.io/docs) on how to install the firmware binaries in the Assets below.
+Follow the instructions in the [documentation](https://emsesp.github.io/docs) on how to install the firmware binaries from the Assets below.
 

RELEASENOTES_DEV.md

@@ -4,5 +4,5 @@ This is a snapshot of the current "beta" development code and firmware binaries
 
 # Firmware Installation
 
-Follow the instructions in the [documentation](https://emsesp.github.io/docs) on how to install the firmware binaries in the Assets below.
+Follow the instructions in the [documentation](https://emsesp.github.io/docs) on how to install the firmware binaries from the Assets below.
 

debug_esp32_pio_local.ini

@@ -0,0 +1,28 @@
+; ESP32 with debugger
+; do not build web
+; builds with DEBUG and TEST
+
+[platformio]
+default_envs = esp32
+
+[env]
+upload_port = COM3
+
+; upload_protocol = espota
+; upload_flags = 
+;   --port=8266
+;   --auth=ems-esp-neo
+; upload_port = ems-esp.local
+
+[common]
+debug_flags = -DEMSESP_DEBUG -DEMSESP_TEST -DEMSESP_FORCE_SERIAL
+
+[env:esp32]
+monitor_filters = esp32_exception_decoder
+debug_tool = esp-prog
+debug_init_break = tbreak setup
+build_type = debug
+extra_scripts =
+  ; pre:scripts/build_interface.py
+  scripts/rename_fw.py
+