aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorKaufman Home Automation <[email protected]>2022-01-21 17:04:33 -0700
committerGitHub <[email protected]>2022-01-21 17:04:33 -0700
commit194417e6a89a2836116342317e597b7e01d04518 (patch)
tree3e231093c5d8dd8efe8caaf9eba94116314165a0 /README.md
parent87ac3519bb3afd07de4cc32fa70c6857726a7819 (diff)
downloadPLF10-194417e6a89a2836116342317e597b7e01d04518.tar.gz
PLF10-194417e6a89a2836116342317e597b7e01d04518.zip
Update readme for dashboard import recommendation
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2078d3c..c4ebd97 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,27 @@
# PLF10
-Files for the PLF10 Power Monitoring Smart Plug
+
+
+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 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 friendly_name substitution is recommended and will not be automatically created by the ESPHome dashboard import.
+
+```
+substitutions:
+ name: bedroom-lamp
+ friendly_name: Bedroom Lamp
+
+packages:
+ kauf.plf10: github://KaufHA/PLF10/kauf-plug.yaml
+
+esphome:
+ name_add_mac_suffix: false
+
+wifi:
+ ssid: !secret wifi_ssid
+ password: !secret wifi_password
+```
+
+This repo contains files for the PLF10 Power Monitoring Smart Plug.
***components* directory** - external components written or edited by Kaufman Home Automation for compiling update and factory firmware files.