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

Update JSON dictionary

Ray Jones 2019-07-11 10:28:47 +00:00
parent f7c3294d0e
commit 02d5be8d71
1 changed files with 28 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
JSON-dictionary.md

@ -37,12 +37,6 @@ Certain commands are used to alter the non volatile settings stored by the contr
| GPmodeIn | string | description | From ESP | no | GPIO input mode | | GPmodeIn | string | description | From ESP | no | GPIO input mode |
| GPmodeOut | string | description | From ESP | no | GPIO output mode | | GPmodeOut | string | description | From ESP | no | GPIO output mode |
| InputVoltage | float | 0.1V resolution | From ESP | n/a | | | InputVoltage | float | 0.1V resolution | From ESP | n/a | |
| MEn | int | 0,1 | To/From ESP | **YES** | MQTT enable |
| MHost | string | var | To/From ESP | **YES** | MQTT server address |
| MPasswd | string | var | To/From ESP | **YES** | MQTT password |
| MPort | int | var | To/From ESP | **YES** | MQTT server port |
| MQuery | int | 1 | To ESP | n/a | request MQTT params from ESP |
| MUser | string | var | To/From ESP | **YES** | MQTT username |
| NVsave | int | 8861 | To ESP | n/a | **must** be 8861 | | NVsave | int | 8861 | To ESP | n/a | **must** be 8861 |
| PumpActual | float | 0.1Hz resolution | From ESP | n/a | | | PumpActual | float | 0.1Hz resolution | From ESP | n/a | |
| PumpFixed | float | 0.1Hz resolution | From ESP | n/a | | | PumpFixed | float | 0.1Hz resolution | From ESP | n/a | |
@ -73,6 +67,34 @@ Certain commands are used to alter the non volatile settings stored by the contr
| TimerStop | string | # HH:MM | To/From ESP | **YES** | # = index 1..14 | | TimerStop | string | # HH:MM | To/From ESP | **YES** | # = index 1..14 |
| TQuery | integer | 1..14 | To ESP | no | ask for timer params for indicated timer | | TQuery | integer | 1..14 | To ESP | no | ask for timer params for indicated timer |
# Challenge/response sets
## MQTT
| **Name** | **Value Type** | **Typical Values** | **Direction** | **Require NVsave** | **Note** |
| ------ | ------ | ------ | ------ | :------: | ------ |
| MQuery | int | 1 | To ESP | n/a | request MQTT params from ESP |
| **Name** | **Value Type** | **Typical Values** | **Direction** | **Require NVsave** | **Note** |
| ------ | ------ | ------ | ------ | :------: | ------ |
| MEn | int | 0,1 | To/From ESP | **YES** | MQTT enable |
| MHost | string | var | To/From ESP | **YES** | MQTT server address |
| MPasswd | string | var | To/From ESP | **YES** | MQTT password |
| MPort | int | var | To/From ESP | **YES** | MQTT server port |
| MUser | string | var | To/From ESP | **YES** | MQTT username |
## IP communications
| **Name** | **Value Type** | **Typical Values** | **Direction** | **Note** |
| ------ | ------ | ------ | ------ | :------: | ------ |
| IQuery | int | 1 | To ESP | n/a | request IP related params from ESP |
| **Name** | **Value Type** | **Typical Values** | **Direction** | **Note** |
| ------ | ------ | ------ | ------ | :------: | ------ |
| IP_AP | string | var | From ESP | AP mode IP address |
| IP_APMAC | string | var | From ESP | AP mode MAC address |
| IP_STA | string | var | From ESP | STA mode IP address |
| IP_STAMAC | string | var | From ESP | STA mode MAC address |
| IP_STAhost | string | var | From ESP | STA mode host AP name |
| IP_OTA | int | 0,1 | From ESP | OTA mode enabled |
## Notes on timer commands ## Notes on timer commands
Up to 14 timers are allowed by the ESP32 firmware. Up to 14 timers are allowed by the ESP32 firmware.
There are however only simple JSON names used, not being adorned with numerics. There are however only simple JSON names used, not being adorned with numerics.