From c76f8006b52234c4b5e5f5bcfaf917dfd3a4e7d9 Mon Sep 17 00:00:00 2001 From: swevictor Date: Sun, 16 Oct 2022 09:41:48 +0200 Subject: [PATCH] Improve documentation - clarify that username is normally email address --- plejd/Details.md | 4 ++-- plejd/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/plejd/Details.md b/plejd/Details.md index ee49bfe..b6aefe8 100644 --- a/plejd/Details.md +++ b/plejd/Details.md @@ -19,7 +19,7 @@ And `Configuration Parameters` on the same page. The only parameters needing a value are - site -- username +- username (typically email address) - password - mqttUsername e.g. `mqtt-api-user` - mqttPassword @@ -28,7 +28,7 @@ Now you can start the Plejd add-on ## Where are the lights? -Head over to [Configuration -> Integrations](http://homeassistant.local:8123/config/integrations) and click Configure on MQTT +Head over to [Configuration -> Integrations](http://homeassistant.local:8123/config/integrations) and click Configure on MQTT After this step a new `Mosquito broker` should appear on the same page. If everything was setup correctly. It will list your lights under `1 entity`/`n entities` diff --git a/plejd/README.md b/plejd/README.md index 6eda56d..7b9353c 100644 --- a/plejd/README.md +++ b/plejd/README.md @@ -116,7 +116,7 @@ The plugin needs you to configure some settings before working. You find these o | Parameter | Value | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | site | Name of your Plejd site, the name is displayed in the Plejd app (top bar). | -| username | Username of your Plejd account, this is used to fetch the crypto key and devices from the Plejd API. | +| username | Email/username of your Plejd account, this is used to fetch the crypto key and devices from the Plejd API. | | password | Password of your Plejd account, this is used to fetch the crypto key and devices from the Plejd API. | | mqttBroker | URL of the MQTT Broker, eg. mqtt:// | | mqttUsername | Username of the MQTT broker |