diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -33,6 +33,23 @@ This repo contains files for the PLF10 Power Monitoring Smart Plug. ***kauf-plug-factory.yaml*** - The yaml file to build the factory bin file. Generally not useful to end users. +## Advanced Settings +When using kauf-bulb.yaml as a package in the ESPHome dashboard, you can configure the following aspects by adding substitutions. The substitutions section of kauf-bulb.yaml has comments with more explanation as well. + +***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. + +***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) + +***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_, _sub_on_release_, _sub_on_release_quick_, and _sub_on_release_short_ can all be used to define scripts that will run based on button press/release/hold if you want something different than the default actions to happen. + +***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. + +## Factory Reset +Going to the plug's URL in a web browser and adding /reset will completely wipe all settings from flash memory. + + ## Troubleshooting Any build errors can usually be resolved by upgrading the ESPHome dashboard to the latest version. On the days when ESPHome updates are released, it may take us up to 24 hours to make necessary changes to our custom components during which time you may see build errors. Please be patient. |