aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorKaufman Home Automation <[email protected]>2023-07-01 16:57:39 -0700
committerGitHub <[email protected]>2023-07-01 16:57:39 -0700
commit68bc7f755df7892dd1ffbc0f127c09a05d2b156a (patch)
tree29944eca173bff9fb92159f388dfeafad2db5662
parent86f19f0e4ab567ff33d7ae3e632adf25ef481be0 (diff)
downloadPLF10-68bc7f755df7892dd1ffbc0f127c09a05d2b156a.tar.gz
PLF10-68bc7f755df7892dd1ffbc0f127c09a05d2b156a.zip
Update README.md for v2.05v2.05
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 66a4c13..c0feb08 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,8 @@ If using the precompiled binary or kauf-plug.yaml as a package in the ESPHome da
***Monitoring Update Interval*** select entity - Disabled by default. Defines the update frequency for the power monitoring sensor entities. Defaults to *10s*. Hard coded options are *2s*, *5s*, *10s*, *30s*, and *60s*. The *YAML Configured* option uses the value defined by the `sub_update_interval:` substitution in YAML. For the precompiled binaries, this is set to 20s to provide an additional option. Changing this value will cause the plug to automatically reboot to effect the change.
+***Early Publish*** switch entity - controls whether the plug will report power usage before the configured update interval if a change greater than configured thresholds is detected. Defaults to on. Default thresholds are +/- 3w or 25%.
+
***Debounce Time*** number entity - Disabled by default. Defines an amount of time that the button needs to be held before toggling the relay. Defaults to 100ms and has a minimum value of 50ms. The PLF10's button needs at least a minimum of 40ms debounce, but the actual necessary value depends on the amount of EMI in the environment where the plug is being used. Changing this value will cause the plug to automatically reboot to effect the change.
***No Hass*** switch entity - Disabled by default. Turn this switch on if not using Home Assistant with the plug. Prevents the plug from flashing an error due to no API connection and rebooting every 15 minutes.
@@ -130,6 +132,14 @@ When using kauf-plug.yaml as a package in the ESPHome dashboard, you can configu
***sub_early_publish_absolute*** - Defines an absolute power change after which the plug will ignore the configured update interval and update immediately. The unit for this is **NOT WATTS** but rather a raw value used under the hood for processing. To figure out what value you need here, you can enable verbose logging and the HLW component will output the needed raw value. For the PLF10 plug, 1W translates to 5.56. Defaults to 16.68, which is an approximately 3w change.
+***sub_hlw_timeout*** - sets an amount of time to wait for a signal from the power monitoring chip before assuming the power being used is 0w. Defaults to 3s.
+
+### Wi-Fi networks
+
+Multiple Wi-Fi networks can now be configured with the [`networks:`](https://esphome.io/components/wifi.html#connecting-to-multiple-networks) key under `wifi:`. By default, the configured `networks:` will be added in addition to the default initial_ap network. If you want to only include the `networks:` you added in your local yaml without initial_ap as well, then you need to set `only_networks: true` under `wifi:`. If you set your SSID/password without the `networks:` key, then that will automatically overwrite the default initial_ap network.
+
+**Note:** With multiple networks configured, you will need to disable fast_connect, which is on by default, with `fast_connect: false`.
+
## Additional Automations (set via YAML substitutions)
The following substitutions can be set to the name of a script to execute automatically in certain circumstances. You need to write the script in your yaml file.