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

updated readme

Browse source
This commit is contained in:
Marcus Westin 2019-12-13 18:29:17 +01:00
parent dcf9be202c
commit 9e64fac963
1 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

19
plejd/README.md
View file

@ -48,7 +48,8 @@ Browse your Hass.io installation using a tool that allows you to manage files, f
* A new Local Add-on should appear named Plejd. Open that and install. * A new Local Add-on should appear named Plejd. Open that and install.
* Enjoy! * Enjoy!
You also need to add the following to your `configuration.yaml` file: ### Configuration
You need to add the following to your `configuration.yaml` file:
``` ```
mqtt: mqtt:
broker: [point to your broker IP] broker: [point to your broker IP]
@ -66,8 +67,7 @@ mqtt:
``` ```
The above is used to notify the add-on when Home Assistant has started successfully and let the add-on send the discovery response (containing all devices). The above is used to notify the add-on when Home Assistant has started successfully and let the add-on send the discovery response (containing all devices).
### Configuration The plugin needs you to configure some settings before working. You find these on the Add-on page after you've installed it.
The plugin needs you to configure some settings before working.
Parameter | Value Parameter | Value
--- | --- --- | ---
@ -77,7 +77,15 @@ password | Password of your Plejd account, this is used to fetch the crypto key
mqttBroker | URL of the MQTT Broker, eg. mqtt://localhost mqttBroker | URL of the MQTT Broker, eg. mqtt://localhost
mqttUsername | Username of the MQTT broker mqttUsername | Username of the MQTT broker
mqttPassword | Password of the MQTT broker mqttPassword | Password of the MQTT broker
includeRoomsAsLights | Adds all rooms as lights, making it possible to turn on/off lights by room instead. *Added in v. 5*. includeRoomsAsLights | Adds all rooms as lights, making it possible to turn on/off lights by room instead. Setting this to false will ignore all rooms. *Added in v. 5*.
## I want voice control!
With the Google Home integration in Home Assistant, you can get voice control for your Plejd lights right away, check this out for more information:
https://www.home-assistant.io/integrations/google_assistant/
### I don't want voice, I want HomeKit!
Check this out for more information on how you can get your Plejd lights controlled using HomeKit:
https://www.home-assistant.io/integrations/homekit/
## Changelog ## Changelog
*0.1.4*: *0.1.4*:
@ -86,9 +94,6 @@ includeRoomsAsLights | Adds all rooms as lights, making it possible to turn on/o
*0.1.3*: *0.1.3*:
* NEW: Added support for Plejd devices with multiple outputs (such as DIM-02) * NEW: Added support for Plejd devices with multiple outputs (such as DIM-02)
## Things to do
* I'm currently looking into adding support to import rooms, containing one or multiple devices, from Plejd as well.
## License ## License
``` ```