From ca79985e06444a250c48fe3532c0d23a60d609c1 Mon Sep 17 00:00:00 2001 From: Vadim Tkachenko Date: Wed, 11 Oct 2023 02:32:31 -0700 Subject: [PATCH] Documentation update (#280, #290) --- docs/configuration/sensors-and-switches.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/configuration/sensors-and-switches.md b/docs/configuration/sensors-and-switches.md index 67f8a2d73..326f15e16 100644 --- a/docs/configuration/sensors-and-switches.md +++ b/docs/configuration/sensors-and-switches.md @@ -61,16 +61,20 @@ switches: reversed: heartbeat: pace: + optimistic: ``` #### 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)