aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorKaufman Home Automation <[email protected]>2022-05-18 13:02:52 -0700
committerGitHub <[email protected]>2022-05-18 13:02:52 -0700
commit64d25b5e35986d0c6f96a54152d190646cdecfd9 (patch)
treedaaee93c23f170f5b9aa37a52341baf588008a49
parent1e3edb7e8ee41bb3b614feeacfcb5efed209f097 (diff)
downloadPLF10-64d25b5e35986d0c6f96a54152d190646cdecfd9.tar.gz
PLF10-64d25b5e35986d0c6f96a54152d190646cdecfd9.zip
Update README.md
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index e548f2d..60c748c 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,9 @@ If using the precompiled binary or kauf-plug.yaml as a package in the ESPHome da
***Red LED Config*** select entity - Same as the Blue LED select entity, but for the Red LED. Defaults to *Error Status*.
-***Button Config*** select entity - Defines when the button toggles the relay. To disable the button toggling the relay, select the *Disable Button* option. The other options start with a description of when the relay toggles and then an amount of time that the button must be held to toggle the relay (20ms, 100ms, 250ms, or 1s). The relay will either *Toggle if Pressed For* the time period, meaning that the relay will toggle after the specified amount of time while the button is still being held, or *Toggle if Released After* the time period, meaning that the relay will only toggle once the button is released after being held for at least the specified amount of time. For the precompiled binaries, an *on release* option should be selected so that the fallback Wi-Fi hotspot can be re-enabled without toggling the relay. The purpose of increasing the time period is to eliminate spurious toggles that may happen when the button circuitry receives interference.
+***Button Config*** select entity - Defines when the button toggles the relay. To disable the button toggling the relay, select the *Don't Toggle* option. Otherwise, you can select the relay to toggle either on press or on release of the button. Toggle on release might be desired in order to have a different action performed when the button is held for certain amount of time. For instance, the precompiled binary defaults to toggling on release so that the toggle can be blocked in case the button is held for 5 seconds to reenable the Wi-Fi AP.
+
+***Debounce Time*** number entity - Defines an amount of time that the button needs to be held before toggling the relay.
***Monitoring Mode*** select entity - Disabled by default. Modifies the frequency and mode of power monitoring sensors. Defaults to *10s P / 40s V,I*.
- *10s P / 40s V,I* - Power is measured and reported every 10 seconds. Current and voltage are each reported every 40 seconds, alternating such that one is reported every 20 seconds.