Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrwiwi authored Mar 25, 2020
1 parent 5690494 commit 5e48110
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,33 @@ Not based on a poll mechanism but on push from websocket, i.e. it constantly pin

Based initialy on https://github.com/cth35/tydom_python

You need a functional MQTT broker before using it.
PREREQ :

- You need a fully functional MQTT broker before using it (MQTT official addon, mosquitto on linux, etc.) and a user/pass to access it.



DOCKER USERS :

You need a functional Docker before using it.

You just need the install.sh to download, mod it with your credentials (Tydom and MQTT - MQTT_HOST and TYDOM_IP are optionals, defaulting to localhost and delta dore servers respectively.), then :

```
sh install.sh
```

HASSIO / HOME ASSISTANT CORE USERS :

- Addon repository : https://github.com/WiwiWillou/hassio_addons.git
-Use MQTT auto discovery, no further config necessary ! (Hassio docker install + MQTT addon on top of Ubuntu server is my personal setup.)
- Use MQTT auto discovery, no further config necessary !

NOT ON HASSIO :

- For other home automation systems, install docker version then you just add devices like any MQTT devices, check on the cover and alarm py files to see or modify the topics !


- For other home automation systems you just add devices like any MQTT devices, check on the cover and alarm py files to see or modify the topics !
ALL :
- To force a restart from your system, publish anything to hassio/tydom/kill, i will exit the script, systemd will restart it clean.

Alarm is readonly for now, (i've soldered a remote to optocouplers and an ESP8266 with esphome to set it from home assisant, a least it's very reliable !).
Expand Down

0 comments on commit 5e48110

Please sign in to comment.