Redesign of Egardia component and platform. #4803
Conversation
|
Travis build failed because of time-out. |
|
@MartinHjelmare here are the docs for HASS PR 11994. Any chance we can get them reviewed and merged so they are released in sync with the PR? |
| sharing: true | ||
| footer: true | ||
| logo: egardia.png | ||
| ha_release: 0.47 |
| logo: egardia.png | ||
| ha_release: 0.47 | ||
| ha_category: Binary Sensor | ||
| ha_iot_class: "Local Push" |
There was a problem hiding this comment.
This platform is polling.
source/_components/egardia.markdown
Outdated
| sharing: true | ||
| footer: true | ||
| ha_category: Hub | ||
| ha_release: 0.47 |
source/_components/egardia.markdown
Outdated
| Note that this basic configuration will only enable you to read the armed/armed away/disarmed status of your alarm and will **not** update the status if the alarm is triggered. This is because of how Egardia built their system. The alarm triggers normally go through their servers. | ||
| You can change this, however, using the following procedure. This is a more advanced configuration. | ||
|
|
||
| 1. Log in into your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. |
There was a problem hiding this comment.
"Log in to your alarm system's..."
source/_components/egardia.markdown
Outdated
|
|
||
| 1. Log in into your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. | ||
| 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. | ||
| 3. On your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. You will need the codes to include in your configuration.yaml. Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage. **Before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** |
There was a problem hiding this comment.
This step needs updating since we now start the server from home assistant.
There was a problem hiding this comment.
I do not agree - the egardiaserver.py script serves in this step to capture alarm codes. The user is asked here to run the script and capture the codes so they can be put into the config.
There was a problem hiding this comment.
Ok, then this needs to be clarified. Eg, for how long does the user need to have the script running. I'm guessing the user needs to actively shut the server down, by exiting the script.
There was a problem hiding this comment.
Fair enough, I tried to make it more clear. Hope this helps.
| password: YOUR_PASSWORD | ||
| ``` | ||
|
|
||
| Configuration variables: |
There was a problem hiding this comment.
Please update this to use the configuration tag:
https://home-assistant.io/developers/documentation/create_page/#configuration
There was a problem hiding this comment.
I want to do the release right now so going ahead and merge this. @jeroenterheerdt please address this comment in a new PR.
There was a problem hiding this comment.
Sure, will do.
* Updating docs related to PR #11994. * Update binary_sensor.egardia.markdown * Update binary_sensor.egardia.markdown * Update egardia.markdown * Update egardia.markdown
Description:
Updating docs related to the redesign of the Egardia component and platform.
Pull request in home-assistant (if applicable): home-assistant/core#11994
Checklist:
current. New documentation for platforms/components and features should go tonext.