Merge pull request #42 from icanos/dev

Update README.md
This commit is contained in:
Marcus Westin 2020-01-16 20:13:57 +01:00 committed by GitHub
commit 5a1438d7b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 5 deletions

View file

@ -98,6 +98,9 @@ Check this out for more information on how you can get your Plejd lights control
https://www.home-assistant.io/integrations/homekit/
## Changelog
*v 0.2.8*:
* FIX: Reset characteristic state on disconnect
*v 0.2.7*:
* FIX: Added exception handling to unsubscribing lastData characteristic if already disconnected

View file

@ -9,6 +9,9 @@ Thanks to [ha-plejd](https://github.com/klali/ha-plejd) for inspiration.
Disclaimer:
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:**
[Buy me a coffee](https://www.buymeacoffee.com/w1ANTUb)
## Getting started
To get started, make sure that the following requirements are met:
@ -33,7 +36,7 @@ The add-on has been tested on the following platforms:
Browse to your Home Assistant installation in a web browser and click on `Hass.io` in the navigation bar to the left.
* Open the Home Assistant web console and click `Hass.io` in the menu on the left side.
* 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/ in the `Add new repository by URL` field and hit `Add`.
* Paste the URL to this repo https://github.com/icanos/hassio-plejd.git in the `Add new repository by URL` field and hit `Add`.
* Scroll down and you should find a Plejd add-on that can be installed. Open that and install.
* Enjoy!
@ -48,11 +51,19 @@ 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.
* Enjoy!
### NOTE
When starting the add-on, the log displays this message:
```
parse error: Expected string key before ':' at line 1, column 4
[08:56:24] ERROR: Unknown HTTP error occured
```
However, the add-on still works as expected and this is something I'm looking into, but not with that much effort yet though.
### Configuration
You need to add the following to your `configuration.yaml` file:
```
mqtt:
broker: [point to your broker IP]
broker: [point to your broker IP eg. 'mqtt://localhost']
username: [username of mqtt broker]
password: !secret mqtt_password
discovery: true
@ -87,10 +98,43 @@ Check this out for more information on how you can get your Plejd lights control
https://www.home-assistant.io/integrations/homekit/
## Changelog
*0.1.4*:
* FIX: bug preventing add-on from building
*v 0.2.8*:
* FIX: Reset characteristic state on disconnect
*0.1.3*:
*v 0.2.7*:
* FIX: Added exception handling to unsubscribing lastData characteristic if already disconnected
*v 0.2.6*:
* FIX: Added null check to remove listeners for characteristics
*v 0.2.5*:
* FIX: Invalid scene id in events/scene message
*v 0.2.4*:
* Stability improvements
*v 0.2.3*:
* FIX: Container build error fix
*v 0.2.2*:
* Stability improvements
*v 0.2.1*:
* Stability improvements
*v 0.2.0*:
* Stability improvements
* Bugfixes
*v 0.1.1*:
* FIX: Fixed missing reference on startup, preventing add-on from starting
*v 0.1.0*:
* NEW: Rewrote the BLE integration for more stability
* FIX: discovery wasn't always sent
*previous*:
* FIX: bug preventing add-on from building
* NEW: Added support for Plejd devices with multiple outputs (such as DIM-02)
## License