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

Improve README.md and Details.md

Browse source
This commit is contained in:
swevictor 2023-08-16 15:01:31 +02:00
parent 5b7490a8bd
commit f60ef88efc
2 changed files with 12 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

19
plejd/Details.md
View file

@ -1,22 +1,18 @@
# Details regarding installation # Details regarding installation
If you can reach your Home Assistant at [http://homeassistant.local:8123](http://homeassistant.local:8123) the links below should work.
## Mosquitto ## Mosquitto
Head over to Supervisor -> Add-on Store and search for `mosquitto broker`. Head over to [Supervisor -> Add-on Store](https://my.home-assistant.io/redirect/supervisor_store/) and find the `Mosquitto broker`.
Install it and then start [mosquito addon link](http://homeassistant.local:8123/hassio/addon/core_mosquitto/info) Install and start it.
## Add api user for Mosquito ## Add api user for Mosquitto
Add a Home Assistant user for the Plejd addon to be able to connect to Mosquito [Configuration -> Users](http://homeassistant.local:8123/config/users) Add a Home Assistant user for the Plejd addon to be able to connect to Mosquitto [Configuration -> Users](https://my.home-assistant.io/redirect/users/)
Call the user e.g. `mqtt-api-user`, set a password and save Call the user e.g. `mqtt-api-user`, set a password and save
## Plejd ## Plejd
Follow the `Easy Installation` in [README.MD](plejd/README.md) Follow the `Easy Installation` in [README.MD](./README.md)And `Configuration Parameters` on the same page.The only parameters needing a value are
And `Configuration Parameters` on the same page.
The only parameters needing a value are
- site - site
- username (typically email address) - username (typically email address)
@ -28,9 +24,8 @@ 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](https://my.home-assistant.io/redirect/integrations/) and the [Configure MQTT](https://my.home-assistant.io/redirect/config_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 Mosquitto broker `core-mosquitto` should appear on the [MQTT Page](https://my.home-assistant.io/redirect/integration/?domain=mqtt). If everything was setup correctly. It will list your lights under devices/entities subheading.
`1 entity`/`n entities`
## Running the Plejd add-on in VirtualBox on Windows ## Running the Plejd add-on in VirtualBox on Windows

12
plejd/README.md
View file

@ -8,11 +8,9 @@ Thanks to [ha-plejd](https://github.com/klali/ha-plejd) for inspiration.
Disclaimer: Disclaimer:
I am in no way affiliated with Plejd and am solely doing this as a hobby project. I am in no way affiliated with Plejd and am solely doing this as a hobby project.
**Did you like this? Consider helping me continue the development:** **Did you like this? Consider helping me continue the development:**
[Buy me a coffee](https://www.buymeacoffee.com/w1ANTUb) [Buy me a coffee](https://www.buymeacoffee.com/w1ANTUb)
[![Gitter](https://badges.gitter.im/hassio-plejd/community.svg)](https://gitter.im/hassio-plejd/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## Getting started ## Getting started
To get started, make sure that the following requirements are met: To get started, make sure that the following requirements are met:
@ -85,8 +83,8 @@ However, the add-on still works as expected and this is something I'm looking in
### 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 Create a user in [Configuration -> Users](https://my.home-assistant.io/redirect/users/) named e.g. mqtt-api-user
| Parameter | Value | | Parameter | Value |
| ------------ | ------------------------------------------------ | | ------------ | ------------------------------------------------ |
@ -116,7 +114,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 | Email/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 |
@ -132,7 +130,7 @@ The plugin needs you to configure some settings before working. You find these o
Plejd output devices typically appears as either lights or switches in Home Assistant depending on how they are configured. Plejd output devices typically appears as either lights or switches in Home Assistant depending on how they are configured.
| Device | Plejd Configuration | Home Assistant Role | Comment | | Device | Plejd Configuration | Home Assistant Role | Comment |
| ------ | ------------------- | ------------------- | --------------------------------------------------------------------- | | --------- | ------------------- | ------------------- | --------------------------------------------------------------------- |
| CTR-01 | Relay, Light | Light | | | CTR-01 | Relay, Light | Light | |
| CTR-01 | Relay, Other | Switch | | | CTR-01 | Relay, Other | Switch | |
| REL-01 | Relay, Light | Light | | | REL-01 | Relay, Light | Light | |