Skip to content

Commit

Permalink
add troubleshooting for installation
Browse files Browse the repository at this point in the history
  • Loading branch information
proddy committed Nov 1, 2024
1 parent 78f4273 commit cc9bd99
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ EMS-ESP has a command API which can be used to read and write values to EMS devi

There are 3 methods commands can be invoked:

- via the [**Console**](#console) using Telnet CLI
- via [**HTTP**](#http) using RESTful HTTP calls
- via [**MQTT**](#mqtt) via topics their payloads
- via the [**Console**](#console) using Telnet or Serial
- via [**HTTP**](#http) using RESTful API calls
- via [**MQTT**](#mqtt) via topics and their payloads

## Definitions

Expand Down
5 changes: 2 additions & 3 deletions docs/MQTT.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ The table below list the topics being published. The format shown in the table b
| Topic | Format | Description | Payload Example |
| - | - | - | - |
| `status` | n/a | this is the MQTT will and testament messages | `online` or `offline` |
| `info` | n/a | for events | `{"event":"connected","version":"3.5.0-dev.14","boot time":"2022-12-30T13:50:54+0100","network":"ethernet","hostname":"ems-esp","MAC":"A9:03:3A:61:34:CE","IPv4 address":"192.168.1.134/255.255.255.0","IPv4 gateway":"192.168.1.1","IPv4 nameserver":"192.168.1.1"}` |
| `heartbeat` | all | system stats in JSON, default is every minute | `{"bus_status":"connected","uptime":"000+22:32:01.497","uptime_sec":81121,"ntp_status":"on","rxreceived":76970,"rxfails":28,"txreads":17587,"txwrites":0,"txfails":0,"mqttcount":42344,"mqttfails":0,"mqttconnects":1,"apicalls":0,"apifails":0,"sensorreads":16224,"sensorfails":0,"freemem":151}` |
| `info` | n/a | for events | `{"version":"3.7.1-dev.3","boot time":"2024-11-01T13:02:48+0100","network":"ethernet","hostname":"ems-esp"}`|
| `heartbeat` | all | system stats in JSON, default is every minute | `{"bus_status":"connected","uptime":"000+02:16:00.285","uptime_sec":8160,"ntp_status":"on","rxreceived":8153,"rxfails":3,"txreads":1942,"txwrites":0,"txfails":1,"mqttcount":2728,"mqttfails":0,"mqttconnects":1,"apicalls":0,"apifails":0,"sensorreads":1631,"sensorfails":0,"freemem":164,"max_alloc":107}` |
| `tapwater_active` | all | boolean to show if the hot tap water is running (DHW) | |
| `heating_active` | all | boolean to show if the heating is on | |
| `boiler_data` | all | non warm water data from the Boiler device | `{"heatingactive":"off","tapwateractive":"off","selflowtemp":0,"selburnpow":23,"heatingpumpmod":0,"curflowtemp":57.5,"rettemp":56.9,"syspress":1.5,"boiltemp":60.8,"burngas":"off","burngas2":"off","flamecurr":0.0,"heatingpump":"off","fanwork":"off","ignwork":"off","oilpreheat":"off","heatingactivated":"on","heatingtemp":65,"pumpmodmax":70,"pumpmodmin":30,"pumpdelay":1,"burnminperiod":10,"burnminpower":0,"burnmaxpower":50,"boilhyston":-6,"boilhystoff":6,"boil2hyston":0,"boil2hystoff":0,"curburnpow":0,"burnstarts":359634,"burnworkmin":620952,"burn2workmin":0,"heatworkmin":508794,"heatstarts":42076,"ubauptime":5166357,"servicecode":"0A","servicecodenumber":305,"maintenancemessage":"H00","maintenance":"manual","maintenancetime":6000,"maintenancedate":"01.01.2012"}` |
| `boiler_data_ww` | all | warm water data from the Boiler device | `{"wwtapactivated":"on","wwsettemp":62,"wwseltemp":60,"wwtype":"flow","wwcomfort":"hot","wwflowtempoffset":40,"wwmaxpower":100,"wwcircpump":"off","wwchargetype":"3-way valve","wwhyston":-5,"wwhystoff":0,"wwdisinfectiontemp":70,"wwcirc":"off","wwcurtemp":52.9,"wwcurflow":0.0,"wwstoragetemp1":52.9,"wwactivated":"on","wwonetime":"off","wwdisinfecting":"off","wwcharging":"off","wwrecharging":"on","wwtempok":"on","wwactive":"off","ww3wayvalve":"on","wwstarts":317558,"wwworkm":112158}` |
| `thermostat_data` | nested | data from the thermostat and for each of its Heating Circuits. | `{"datetime":"31.12.2022 12:25","hc1":{"seltemp":15.0,"currtemp":20.7,"mode":"auto","manualtemp":21.0,"daytemp2":20.5,"daytemp3":20.0,"daytemp4":20.5,"nighttemp":15.0,"switchtime":"00 mo 00:00 T1"}}` |
| `thermostat_data` | single | In single format each heating circuit is published with own topic | `{"datetime":"31.12.2022 12:25"}` |
| `thermostat_data_hc<id>` | single | hc in single format | `{"seltemp":15, "currtemp":20.6, "mode":"auto"}` |
Expand Down
24 changes: 18 additions & 6 deletions docs/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
Below are answers to some common problems.
Below are responses to some common problems.

## General
## Firmware Installation issues

### Can't connect to the WiFi
### Unable to upload via the Web interface

When uploading the firmware via the Web interface and you see the error "Invalid file extension or incompatible bin file", check that you are using the correct firmware binary file that matches your board and ESP32 chip set. If that is correct, it may be because the firmware is too large for the boot partition, which could be the case when moving from 3.6.5 to 3.7.0 in certain situations. The solution is to use one of the flash tools.

### Web Interface shows old data or errors in browser after an update

This is caused by the browser caching the old files. To fix this, clear the browser cache and reload the page. CTRL-R or CMD-R or F5 on most browsers.

## Stability

### EMS-ESP can not connect to the WiFi

The EMS-ESP is probably in Access Point mode. Look for a wifi SSID `ems-esp`, connect to this and open a browser to '<http://192.168.4.1>'. If you have configured a WiFi client your router would have appointed an IP address via DHCP. You should be able to then connect via <https://ems-esp> or <https://ems-esp.local>.

Expand Down Expand Up @@ -124,11 +134,11 @@ If you notice that certain values are displayed incorrectly, either in the WebUI

and then either a `read` or `watch`, e.g. `read 21 2D8` to show all the data from HC2 on a Mixing MM100.

## Dallas Sensors
## Temperature Sensors

### Unusual Dallas sensor readings
### Unusual sensor readings

If you're seeing unusual Dallas sensor readings (crazy negative temperatures, sudden spikes in readings etc.) check...
If you're seeing unusual Dallas sensor readings (crazy negative temperatures, sudden spikes in readings etc.) check the following:

- Wiring to the JST connector on the gateway.
- That you're in the right powering mode for your application : parasitic or non-parasitic
Expand Down Expand Up @@ -220,3 +230,5 @@ The thermostat needs a setting of day-of-week and daylight-saving. Bosch day-of-
If you have enabled NTP you can just enter "NTP" and the ntp time is set to the thermostat.

With NTP enabled the thermostat clock is also automatically set by EMS-ESP if it differs from the ntp time.

Pay attention to whether or not you want to enable daylight-saving time. This should be consistent with the setting on your thermostat.

0 comments on commit cc9bd99

Please sign in to comment.