Skip to content

Commit

Permalink
Documentation update (#280, #290)
Browse files Browse the repository at this point in the history
  • Loading branch information
climategadgets committed Oct 11, 2023
1 parent 444145b commit ca79985
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/configuration/sensors-and-switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,20 @@ switches:
reversed: <boolean flag>
heartbeat: <Duration>
pace: <Duration>
optimistic: <boolean flag>
```

#### reversed
Set to true if the hardware switch state must be set to the opposite of the logical.

#### heartbeat
Send the command to hardware this often even if the logical state hasn't changed. Good for fault tolerance (yes, people yank power cords out by accident sometimes).
Optional. Send the command to hardware this often even if the logical state hasn't changed. Good for fault tolerance (yes, people yank power cords out by accident sometimes). Be careful with slow hardware (notably, [Zigbee](./zigbee2mqtt.md)).

#### pace
Send the same command to hardware no more often that this. Some bridges (notably `zigbee2mqtt`) are known to become unresponsive with no error indication when incoming traffic exceeds their bandwidth.
Optional. Send the same command to hardware no more often that this. Some bridges (notably `zigbee2mqtt`) are known to become unresponsive with no error indication when incoming traffic exceeds their bandwidth.

### optimistic
Optional. Send the command to hardware and don't wait for confirmation. Normally, you wouldn't have to do this, but some firmware (notably, [ESPHome](./esphome.md)) doesn't provide reliable confirmation so this may save the situation (and is a default for known hardware types). Use only if you must, and consider using [heartbeat](#heartbeat) to offset the risk.

### Property of
* [esphome](./esphome.md)
Expand Down

0 comments on commit ca79985

Please sign in to comment.