# EMS-ESP version 2.0 (beta) ## **New Features in v2** - A new web interface using React and TypeScript that's now secure as each URL endpoint is protected by issuing a JWT which is then sent using Bearer Authentication. Using a Captive Portal in AP mode or connecting to a local wifi network. ![settings](/media/web_settings.PNG) ![status](/media/web_status.PNG) - A new console. Like in version 1.9 it works with both Serial and Telnet but with a rich set of commands and more intuitive with behavior similar to a Linux-style shell. It supports multiple connections and commands that alter the settings or interact directly with EMS devices are secure behind an admin password. A full list of commands is below, here are the key ones: * `help` lists the commands and keywords * some commands take you into a new context, a bit like a sub-menu. e.g. `system`, `thermostat`. Use `help` to show which commands this context has and `exit` or CTRL-D to get back to the root. * To change a setting use the `set` command. Typing `set` shows the current settings. * `show` shows the data specific to the which context you're in. * `su` to switch to Admin which enables more commands such as most of the `set` commands. The default password is "ems-esp-neo" which can be changed with `passwd` from the system menu. When in Admin mode the command prompt switches from `$` to `#`. * `log` sets the logging level. `log off` disables logging. Use `log debug` for debugging commands and actions. * `watch` will output the incoming Rx telegrams to the console. You can also show these in its 'raw' data format and also watch a particular ID. * CTRL-D to exit, CTRL-U to remove line, TAB to auto-complete - There is no "serial mode" anymore like with version 1.9. When the Wifi cannot connect to the SSID it will automatically enter a "safe" mode where the Serial console is activated automatically (baud 115200). Note Serial is always available on the ESP32 because it has multiple UARTs. - The onboard LED behaves like in 1.9. A solid LED means good connection and EMS data is coming in. A slow pulse means either the WiFi or the EMS bus is not connected yet. A very fast pulse is when the system is booting up and configuring itself, which typically takes 5 seconds. - Built to work with both EMS8266 and ESP32 - Extended MQTT to use MQTT discovery on Home Assistant. - For debugging there is an offline mode where the code can be compiled and executed standalone without uploading to an ESP controller. Use `make` (based off GNUMakefile). ## **Uploading the firmware** - If you're not using PlatformIO, use the command-line and Python. You can download Python from https://www.python.org/downloads/. Make sure you also get: - `esptool`, install using the command `pip install esptool` - and for OTA updates later, `espota` from https://github.com/esp8266/Arduino/blob/master/tools/espota.py - Grab the latest firmware binary from https://github.com/proddy/EMS-ESP/releases/tag/travis-v2-build - Uploading directly via USB. For ESP8266: `esptool.py -p -b 921600 write_flash 0x00000 ` For ESP32: `esptool.py --chip esp32 --port "COM6" --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 40m --flash_size detect 0x1000 XX\.platformio\packages\framework-arduinoespressif32\tools\sdk\bin\bootloader_dio_40m.bin 0x8000 XX\.pio\build\esp32\partitions.bin 0xe000 XX\.platformio\packages\framework-arduinoespressif32\tools\partitions\boot_app0.bin 0x10000 ` - Uploading over WiFi: `espota.py --debug --progress --port 8266 --auth ems-esp-neo -i -f ` ## **Setting EMS-ESP up for the first time** - Connect to the Access Point called ems-esp. Login to the captive portal with admin/admin and set the WiFi credentials and restart the ESP. - When it connects to your network you can use the Web UI to configure the other settings or login using Telnet. See the console commands below for options. The password for `su` is the sames as the JWT secret which you can see from the WebUI. ## **List of console commands** ``` common commands available in all contexts: exit help log [level] watch [ID] su (from the root) set refresh system (enters a context) boiler (enters a context) thermostat (enters a context) scan devices [deep] send telegram <"XX XX ..."> set bus_id set tx_mode show show devices show ems show values system set show show mqtt passwd restart set wifi hostname set wifi password set wifi ssid boiler comfort flowtemp wwactive wwcirculation wwonetime wwtemp read thermostat set set master [device ID] mode [heating circuit] temp [heating circuit] read ``` ---------- ### **Basic Design Principles** - The core services like telnet, logging and shell are based off the libraries from @nomis. I also adopted his general design pattens such as making everything as asynchronous as possible so that no one operation should starve another operation of it's time to execute (https://isocpp.org/wiki/faq/ctors#static-init-order). - All EMS devices (e.g. boiler, thermostat, solar modules, mixing units etc) are derived from a factory base class and each class handles its own registering of telegram and mqtt handlers. This makes the EMS device code easier to manage and we can extend with new telegrams types and features. ### **Things to tidy up in code later** - Replace vectors of class objects with shared pointers and use emplace_back since it instantiates during construction. It may have a performance gain. - Add real unit tests using platformio's test bed (https://docs.platformio.org/en/latest/plus/pio-remote.html) - See if it's easier to use timers instead of millis() based timers, using https://github.com/esp8266/Arduino/blob/master/libraries/esp8266/examples/BlinkPolledTimeout/BlinkPolledTimeout.ino