diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 69 |
1 files changed, 45 insertions, 24 deletions
@@ -1,9 +1,9 @@ # KAUF Power Monitoring Smart Plug (PLF10) -The recommended way to import a plug into your ESPHome dashboard is through the dashboard import feature. The plug will need to be updated to 1.83 or greater to be discovered by the ESPHome dashboard. You can accomplish the same thing without updating first by using the following yaml modified as desired. +The recommended way to import a plug into your ESPHome dashboard is through the dashboard import feature. The plug should show up in the ESPHome dashboard as being available to adopt. Below is the minimum necessary yaml, which can be used to manually add your device instead. Change the name and friendly_name substitutions to fit your use case. Adding a [`use_address:`](https://esphome.io/components/wifi.html?highlight=use_address#configuration-variables) under `wifi:` will allow you to point the ESPHome dashboard to the device on your network for flashing OTA. -The friendly_name substitution is recommended and will not be automatically created by the ESPHome dashboard import. +The friendly_name substitution is recommended and will not be automatically created by the ESPHome dashboard import. If you use the ESPHome dashboard adopt feature, we recommend that you add a friendly_name substitution to rename all of the entities in Home Assistant in one line of yaml. ``` substitutions: @@ -26,7 +26,7 @@ This repo contains files for the PLF10 Power Monitoring Smart Plug. ***kauf-plug-lite.yaml*** - A yaml file without any Kauf custom components but otherwise keeping as much functionality from kauf-plug.yaml as possible. -***kauf-plug-minimal.yaml*** - A yaml file to import a plug into your ESPHome dashboard with only basic power monitoring smart plug functionality. +***kauf-plug-minimal.yaml*** - A yaml file to import a plug into your ESPHome dashboard with only basic power monitoring smart plug functionality using stock ESPHome. ***kauf-plug-update.yaml*** - The yaml file to build the update bin file. Generally not useful to end users. @@ -34,13 +34,13 @@ This repo contains files for the PLF10 Power Monitoring Smart Plug. ## Configuration Entities -If using the precompiled binary or kauf-plug.yaml as a package in the ESPHome dashboard, the following configuration entities are automatically created. Entities listed as disabled by default can be enabled in Home Assistant, or simply modified through the web interface by clicking "Visit Device" in Home Assistant or typing the plug's IP address into a web browser. +If using the precompiled binary or kauf-plug.yaml as a package in the ESPHome dashboard, the following configuration entities are automatically created. Entities listed as disabled by default can be enabled in Home Assistant, or simply modified through the web interface by clicking "Visit Device" in Home Assistant or typing the plug's IP address into a web browser. Adding the substitution `disable_entities: "false"` in your yaml file will cause all entities to be automatically enabled in Home Assistant. -***Blue LED*** light entity - This is in the configuration section because the main intent is to control the blue LED's brightness. However, you can also directly control the blue LED in automations or manually. +***Blue LED*** light entity - This is in the configuration section because the main intent is to control the blue LED's brightness while the plug itself automatically turns the light on and off. However, you can also directly control the blue LED in automations or manually using this light entity. ***Blue LED Config*** select entity - Configures the behavior of the blue LED. Has the following options. Defaults to *Power Status*. - *Power Status*: LED follows relay state. -- *No Automation*: The plug will never automatically change the LED, but the LED can still be controlled via the light entity. +- *No Automation*: The plug will never automatically change the LED, but the LED can still be user-controlled via the light entity. - *Invert Power Status*: LED follows the inverse of the relay's state (LED on when relay is off). - *Error Status*: The LED will blink when an error is detected. The most common errors are being unable to connect to Wi-Fi or Home Assistant. - *Error and Power*: The LED will follow the relay state, but then also blink when an error is detected. @@ -50,18 +50,18 @@ 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 *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 30 seconds to reenable the Wi-Fi AP. +***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 a 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 30 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. +***Boot State*** select entity - Defines the relay's behavior on boot. +- *Restore Power Off State*: The relay will restore its state from the last time the plug was changed before power off or reboot. +- *Invert Power Off State*: The relay will toggle every time it is reboot or powered off and back on. +- *Always On*: The relay will always turn on when the plug boots. +- *Always Off*: The relay will always remain off when the plug boots. +- *YAML Configured*: The boot state is set using the `sub_restore_mode:` substitution to any valid value for a [GPIO switch's restore mode](https://esphome.io/components/switch/gpio.html?highlight=restore_mode#configuration-variables). -***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. -- *10s P,I Only* - Power and current are both reported every 10 seconds. Voltage is never reported. -- *10s P,V Only* - Power and voltage are both reported every 10 seconds. Current is never reported. -- *2s P,I Only* - Power and current are both reported every 2 seconds. Voltage is never reported. -- *2s P,V Only* - Power and voltage are both reported every 2 seconds. Current is never reported. -- *YAML Configured* - Uses the values defined by substitutions in YAML. For the precompiled binaries, this is the same as *10s P / 40s V,I*. See Power Monitoring Mode below for more information on customizing. -- *2s P / 8s V,I* - Power is measured and reported every 2 seconds. Current and voltage are each reported every 8 seconds, alternating such that one is reported every 4 seconds. +***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. + +***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. ***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. @@ -74,30 +74,51 @@ If using the precompiled binary or kauf-plug.yaml as a package in the ESPHome da ***Use Threshold*** number entity - Disabled by default. Sets a threshold for the *Device in Use* binary sensor. The binary sensor turns on if the power detected by the plug exceeds the threshold. -## Advanced Settings -When using kauf-plug.yaml as a package in the ESPHome dashboard, you can configure the following aspects by adding substitutions. The substitutions section of kauf-plug.yaml has comments with more explanation as well. +## Diagnostic Entities +If using the precompiled binary or kauf-plug.yaml as a package in the ESPHome dashboard, the following diagnostic entities are automatically created. All diagnostic entities are disabled by default. Adding the substitution `disable_entities: "false"` in your yaml file will cause all entities to be automatically enabled in Home Assistant. + +***Restart Firmware*** button entity - Press this button to reboot the plug. + +***Button Press Duration*** sensor entity - Indicates the amount of time in milliseconds that the button was last pressed for. Reads zero while the button is being pressed. + +***IP Address*** sensor entity - Gives the plug's IP address. + +***Uptime*** number entity - Gives the plug's uptime in seconds. + -***friendly_name*** - The friendly name will be used to name every entity in Home Assistant. Add a substitution to change this to something descriptive for each device. +## Advanced Settings (via YAML Substitutions) +When using kauf-plug.yaml as a package in the ESPHome dashboard, you can configure the following aspects by adding substitutions. The substitutions section of kauf-plug.yaml has comments with more explanation as well. Adding one of these in your local yaml will overwrite the corresponding value in kauf-plug.yaml. -***sub_restore_mode*** - defines the state of the relay on boot-up. See more about the options under restore_mode here: [GPIO Switch](https://esphome.io/components/switch/gpio.html) +***name*** - Defines the plug's name in the ESPHome dashboard, the device name in Home Assistant, mDNS URL, and other various aspects. The name should use only lower-case letters and dashes. Do not use spaces or underlines. + +***friendly_name*** - The friendly name will be used to name every entity in Home Assistant. Add a substitution to change this to something descriptive for each device. Capital letters and spaces are good for the friendly name. + +***sub_restore_mode*** - defines the state of the relay on boot-up. See more about the options under restore_mode here: [GPIO Switch](https://esphome.io/components/switch/gpio.html). The boot mode select entity must remain in the *YAML Configured* option for this substitution to be effective. ***disable_entities*** - Adding a substitution to redefine this to "false" will result in all entities being automatically enabled in Home Assistant. -***button actions*** - _sub_on_press_ and _sub_on_release_ can be used to define scripts that will run based on button press and release if you want something different than the default actions to happen. +***disable_webserver*** - Adding a substitution to redefine this to "true" will result in the plug's webserver not listening on port 80. + +***button actions*** - The *sub_on_press* and *sub_on_release* substitutions can be used to define scripts that will run based on button press and release if you want something different than the default actions to happen. -***sub_toggle_check*** - defines a script that, if running, will stop the button from toggling on release. Can be used to stop a button press action from occuring when a hold action executed instead. +***plug state actions*** - The *sub_on_turn_on* and *sub_on_turn_off* substitutions can be used to define scripts that will run when the plug's relay turns on and off, respectively. + +***sub_toggle_check*** - defines a script that, if running, will stop the button from toggling on release. Can be used to stop a button press action from occurring when a hold action executed instead. ***default_button_config*** - defines the default option for the button config select entity. ***power monitoring calibration*** - all of the values used to calibrate the power monitoring calibration can be overwritten using substitutions to make the calibration more accurate. -***power monitoring update interval*** (`sub_update_interval:`) - Defines the time delay between updates of the power monitoring sensors. The power monitoring update interval select entity needs to be set to "YAML Configured" for the substitutions to take effect. +***power monitoring update interval*** (`sub_update_interval:`) - Defines the time delay between updates of the power monitoring sensors. The power monitoring update interval select entity needs to be set to *YAML Configured* for this substitution to take effect. + +***sub_pm_initial_option*** - Defines the default option for the power monitoring update interval select entity. + ## Factory Reset Going to the plug's URL in a web browser and adding /reset will completely wipe all settings from flash memory. Note that this will wipe the plug's memory of whether the relay was on or off, and therefore the plug may turn off. ## Clearing Wi-Fi Credentials, Getting Wi-Fi AP to Reconfigure Credentials -Holding the plug's button for 30 seconds will clear any programmed Wi-Fi credentials, including any hard-coded via yaml configuration, and cause the plug to put its Wi-Fi AP back up. Going to the plug's URL in a web browser and adding /clear will do the same thing. No other setting will be lost. +Holding the plug's button for 30 seconds will clear any programmed Wi-Fi credentials, including any hard coded via yaml configuration, and cause the plug to put its Wi-Fi AP back up. Going to the plug's URL in a web browser and adding /clear will do the same thing. No other settings or data will be lost. ## Troubleshooting |