rasperrypi-home/hassio-plejd
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation - clarify that username is normally email address

Browse source
This commit is contained in:
swevictor 2022-10-16 09:41:48 +02:00
parent 12a8f4e475
commit c76f8006b5
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
plejd/Details.md
View file

@ -19,7 +19,7 @@ And `Configuration Parameters` on the same page.
The only parameters needing a value are The only parameters needing a value are
- site - site
- username - username (typically email address)
- password - password
- mqttUsername e.g. `mqtt-api-user` - mqttUsername e.g. `mqtt-api-user`
- mqttPassword - mqttPassword
@ -28,7 +28,7 @@ Now you can start the Plejd add-on
## Where are the lights? ## 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 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` `1 entity`/`n entities`

2
plejd/README.md
View file

@ -116,7 +116,7 @@ The plugin needs you to configure some settings before working. You find these o
| Parameter | Value | | Parameter | Value |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| site | Name of your Plejd site, the name is displayed in the Plejd app (top bar). | | 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. | | 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:// | | mqttBroker | URL of the MQTT Broker, eg. mqtt:// |
| mqttUsername | Username of the MQTT broker | | mqttUsername | Username of the MQTT broker |