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

Added more documentation to install steps

Browse source
This commit is contained in:
kopo 2021-05-31 14:38:12 +02:00
parent 8f15042a58
commit 67aa612f94
2 changed files with 43 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

28
Details.md Normal file
View file

@ -0,0 +1,28 @@
# Details for Home Assistant beginners
If you can reach your Home Assistant at [http://homeassistant.local:8123](http://homeassistant.local:8123) the links below should work.
## Mosquitto
Head over to Supervisor -> Add-on Store and search for `mosquitto broker`.
Install it and then start [mosquito addon link](http://homeassistant.local:8123/hassio/addon/core_mosquitto/info)
## Add api user for Mosquito
Add a Home Assistant user for the Plejd addon to be able to connect to Mosquito [Configuration -> Users](http://homeassistant.local:8123/config/users)
Call the user e.g. `mqtt-api-user`, set a password and save
## Plejd
Follow the `Easy Installation` in [README.MD](plejd/README.md)
And `Configuration Parameters` on the same page.
The only parameters needing a value are
* site
* username
* password
* mqttUsername e.g. `mqtt-api-user`
* mqttPassword
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
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`

25
plejd/README.md
View file

@ -69,13 +69,14 @@ The add-on has been tested on the following platforms:
### Easy Installation ### Easy Installation
Browse to your Home Assistant installation in a web browser and click on `Hass.io` in the navigation bar to the left. Browse to your Home Assistant installation in a web browser and click on `Supervisor` in the navigation bar to the left.
- Open the Home Assistant web console and click `Hass.io` in the menu on the left side. - Open the Home Assistant web console and click `Supervisor` in the menu on the left side.
- Click on `Add-on Store` in the top navigation bar of that page. - Click on `Add-on Store` in the top navigation bar of that page.
- Paste the URL to this repo https://github.com/icanos/hassio-plejd.git in the `Add new repository by URL` field and hit `Add`. - Click on the three vertical dots to the far right and chose `Repositories`
- Paste the URL to this repo https://github.com/icanos/hassio-plejd.git in the `Add` field and hit `Add`.
- Scroll down and you should find a Plejd add-on that can be installed. Open that and install. - Scroll down and you should find a Plejd add-on that can be installed. Open that and install.
- Configure hassio-plejd (see below) - Configure hassio-plejd (see below).
- Enjoy! - Enjoy!
### Manual Installation ### Manual Installation
@ -85,12 +86,15 @@ Browse your Hass.io installation using a tool that allows you to manage files, f
- Open the `/addon` directory - Open the `/addon` directory
- Create a new folder named `hassio-plejd` - Create a new folder named `hassio-plejd`
- Copy all files from this repository into that newly created one. - Copy all files from this repository into that newly created one.
- Open the Home Assistant web console and click `Hass.io` in the menu on the left side. - Open the Home Assistant web console and click `Supervisor` in the menu on the left side.
- Click on `Add-on Store` in the top navigation bar of that page. - Click on `Add-on Store` in the top navigation bar of that page.
- Click on the refresh button in the upper right corner. - Click on the refresh button in the upper right corner.
- 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!
### Detailed Home Assistant instructions
[The details](../Details.md)
### Install older versions or developemnt version ### Install older versions or developemnt version
To install older versions, follow the "Manual Installation" instructions above, but copy the code from [one of the releases](https://github.com/icanos/hassio-plejd/releases). To test new functionality you can download the development version, available in the [develop branch](https://github.com/icanos/hassio-plejd/tree/develop). To install older versions, follow the "Manual Installation" instructions above, but copy the code from [one of the releases](https://github.com/icanos/hassio-plejd/releases). To test new functionality you can download the development version, available in the [develop branch](https://github.com/icanos/hassio-plejd/tree/develop).
@ -134,13 +138,14 @@ If you restore a backup from a 32bit system to a new 64bit system, use the Rebui
#### Simple MQTT Configurations #### Simple MQTT Configurations
When you are using the official Mosquitto Broker from Home Assistant Add-on store, minimal configuration is required. When you are using the official Mosquitto Broker from Home Assistant Add-on store, minimal configuration is required.
Create a user in [Configuration -> Users](http://homeassistant.local:8123/config/users) named e.g. mqtt-api-user
| Parameter | Value | | Parameter | Value |
| ------------ | ---------------------------------------------------------------------------------------------------------------- | | ------------ | ---------------------------------------------------------------------------------------------------------------- |
| mqttBroker | mqtt://localhost | | mqttBroker | mqtt:// |
| mqttUsername | homeassistant | | mqttUsername | Arbitrary Home Assistant User e.g. mqtt-api-user |
| mqttPassword | Mosquitto password, fetched via Configuration->Integrations->Mosquitto broker->Configure->RE-CONFIGURE->Password | | mqttPassword | Users password |
#### Advanced MQTT Configurations #### Advanced MQTT Configurations
@ -166,7 +171,7 @@ The plugin needs you to configure some settings before working. You find these o
| 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 | 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://localhost | | mqttBroker | URL of the MQTT Broker, eg. mqtt:// |
| 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. Setting this to false will ignore all rooms. | | 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. |