Crash_Override/ESP32_ChinaDieselHeater_Control
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update JSON dictionary

Ray Jones 2019-07-13 04:23:08 +00:00
parent fdf5fbd4cc
commit 4a866571a7
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
JSON-dictionary.md

@ -19,8 +19,6 @@ Certain commands are used to alter the non volatile settings stored by the contr
| CyclicTemp | integer | 8-35 | To/From ESP | no | set point temperature **always**| | CyclicTemp | integer | 8-35 | To/From ESP | no | set point temperature **always**|
| CyclicOff | integer | 0,2..10 | To/From ESP | **YES** | cyclic off threshold (1 is invalid) 0=disabled | | CyclicOff | integer | 0,2..10 | To/From ESP | **YES** | cyclic off threshold (1 is invalid) 0=disabled |
| CyclicOn | integer | -20..0 | To/From ESP | **YES** | cyclic restart threshold | | CyclicOn | integer | -20..0 | To/From ESP | **YES** | cyclic restart threshold |
| Date | string | dd/mm/yyyy | To ESP | no | |
| DateTime | string | dd/mm/yyyy HH:mm:ss | To ESP | no | |
| ErrorState | integer | 0..11 | From ESP | n/a | | | ErrorState | integer | 0..11 | From ESP | n/a | |
| ErrorString | string | "verbose description" | From ESP | n/a | | | ErrorString | string | "verbose description" | From ESP | n/a | |
| FanMax | float | RPM | To/From ESP | **YES** | | | FanMax | float | RPM | To/From ESP | **YES** | |
@ -58,7 +56,6 @@ Certain commands are used to alter the non volatile settings stored by the contr
| ThermostatOvertemp | int | 0, 2..10 | To/From ESP | **YES** | Cyclic mode <BR>Shutdown (suspend) heater if this much over set point. <BR>0 => disabled <BR>**Deprecated**| | ThermostatOvertemp | int | 0, 2..10 | To/From ESP | **YES** | Cyclic mode <BR>Shutdown (suspend) heater if this much over set point. <BR>0 => disabled <BR>**Deprecated**|
| ThermostatUndertemp | int | -20..0 | To/From ESP | **YES** | Cyclic mode <BR>Restart heater if this much below set point <BR>**Deprecated**| | ThermostatUndertemp | int | -20..0 | To/From ESP | **YES** | Cyclic mode <BR>Restart heater if this much below set point <BR>**Deprecated**|
| ThermostatWindow | float| 0.2 ... 10.0 | To/From ESP | **YES** | degC span of thermostat window | | ThermostatWindow | float| 0.2 ... 10.0 | To/From ESP | **YES** | degC span of thermostat window |
| Time | string | HH:mm:ss | To ESP | no | |
| TimerConflict | integer | timer ID | To/From ESP | | TO: test nominated timer<BR>FROM: timer in conflict | | TimerConflict | integer | timer ID | To/From ESP | | TO: test nominated timer<BR>FROM: timer in conflict |
| TimerDays | string | # Mon,Tue,Wed,Thu,Fri,Sat,Sun,Next | To/From ESP | **YES** | # = index 1..14 | | TimerDays | string | # Mon,Tue,Wed,Thu,Fri,Sat,Sun,Next | To/From ESP | **YES** | # = index 1..14 |
| TimerRefresh | integer | 1 | To/From ESP | | req/set timer info | | TimerRefresh | integer | 1 | To/From ESP | | req/set timer info |
@ -95,6 +92,20 @@ Certain commands are used to alter the non volatile settings stored by the contr
| IP_STASSID | string | var | From ESP | STA mode host AP name | | IP_STASSID | string | var | From ESP | STA mode host AP name |
| IP_OTA | int | 0,1 | From ESP | OTA mode enabled | | IP_OTA | int | 0,1 | From ESP | OTA mode enabled |
## MQTT
| **Name** | **Value Type** | **Typical Values** | **Direction** | **Require NVsave** | **Note** |
| ------ | ------ | ------ | ------ | :------: | ------ |
| SQuery | int | 1 | To ESP | n/a | request system information from ESP |
| **Name** | **Value Type** | **Typical Values** | **Direction** | **Require NVsave** | **Note** |
| ------ | ------ | ------ | ------ | :------: | ------ |
| Time | string | HH:mm:ss | To/From ESP | no | |
| Date | string | dd/mm/yyyy | To/From ESP | no | |
| DateTime | string | dd/mm/yyyy HH:mm:ss | To/From ESP | no | |
| Uptime | integer | var | From ESP | | seconds since last reboot |
| SysVer | string | var | From ESP | | Release version stamp |
| SysDate | string | var | From ESP | | Build date of release |
| SysFreeMem | integer | var | From ESP | | free memory, bytes |
## System Query ## System Query
## Notes on timer commands ## Notes on timer commands