Skip to content

Commit

Permalink
explain the API parameters a little better
Browse files Browse the repository at this point in the history
  • Loading branch information
proddy committed Jan 20, 2024
1 parent 2133e28 commit 6f345d4
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,17 +181,19 @@ Examples:

### Publishing Commands

EMS-ESP will subscribe to specific topics depending on the EMS devices attached. For example `boiler`, `thermostat` etc. Commands can be sent to EMS-ESP via these topics using the payload format:
EMS-ESP will MQTT 'subscribe' to specific topics depending on the EMS devices attached. For example `boiler`, `thermostat` etc.

Commands can be sent to EMS-ESP via these MQTT topics using the payload format:

```json
{"cmd":"<cmd>", "data":<data>, "id":<n>}
```

where

- `cmd` is one of the commands listed in the [Commands](Commands) and **_must_** be enclosed in quotes.
- `data` can be a string or numeric value.
- `id` can be replaced with `hc` for some devices that use heating circuits, and represented either as a string or a number.
- `cmd` is one of the commands listed in the [Commands](Commands) and **_must_** be enclosed in quotes as a String. The key `entity` may also be used instead of `cmd`.
- `data` (or `value`) holds the value for the command, and can be either a String or numeric value.
- `id` is used as an generic indicator. `hc`, `wwc`, `ahs` and `hs` are other suppoerted aliases. For example with `hc` it is used to indicated a specific Heating Circuit. A numeric value or String can be both used.

With Home Assistant, Thermostat commands can also be sent to control individual heating circuits via sending a mode string or temperature number to a topic `thermostat_hc<n>`.

Expand Down

0 comments on commit 6f345d4

Please sign in to comment.