Skip to content

Update alarm_control_panel.egardia.markdown #4282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 29, 2017
Merged

Update alarm_control_panel.egardia.markdown #4282

merged 2 commits into from
Dec 29, 2017

Conversation

jeroenterheerdt
Copy link
Contributor

@jeroenterheerdt jeroenterheerdt commented Dec 27, 2017

Description:
Updating docs reflecting changes in egardia component no longer requiring separate egardiaserver install.

Pull request in home-assistant (if applicable): home-assistant/core#11344

Checklist:

  • X ] Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

- **report_server_codes** list (*Optional*): List of codes for the different states.

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.
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. Also, update the port number 85 or to anything you like. The provided software that you will set up in the next steps runs on port 85 by default. **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'.
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, because it removes the need to pay for their subscription. Make sure to save your settings by selecting 'OK'.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we should mention the subscription. Maybe we should leave it out to stay neutral?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's kind of the whole purpose of the component, but sure, I am fine with leaving it out. I expect people to be able to read between the lines.

@jeroenterheerdt
Copy link
Contributor Author

I removed the mention of the subscription.

@jeroenterheerdt
Copy link
Contributor Author

Should this not be on the current branch since it is docs for an existing component? I thought the next branch was only for new components and current for updates for docs for existing components..

@MartinHjelmare
Copy link
Member

Since the PR with the code changes will go in the next release, ie 0.61, this PR should target next branch. If this PR would have contained fixes of the description of current behavior it should have targeted current branch.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MartinHjelmare MartinHjelmare merged commit 22e7578 into home-assistant:next Dec 29, 2017
@jeroenterheerdt
Copy link
Contributor Author

jeroenterheerdt commented Dec 29, 2017

@MartinHjelmare then the docs on the HA site are not entirely in line with this. Have a look at the documentation on docs:

Create a Pull Request (PR) against the next branch of home-assistant.github.io if your documentation is a new feature, platform, or component.
Create a Pull Request (PR) against the current branch of home-assistant.github.io if you fix stuff, create Cookbook entries, or expand existing documentation.

To me I was fixing things and expanding existing documentation, hence the current branch.

@MartinHjelmare
Copy link
Member

A fix to the documentation, would be if something is wrong with the documentation and no code has changed. Since you have changed code, you're not fixing the documentation, you're updating it to match the added code.

@jeroenterheerdt jeroenterheerdt deleted the current branch December 31, 2017 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants