Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add Interlogix Ultrasync Alarm System Integration #15588

Closed
wants to merge 2 commits into from
Closed

Add Interlogix Ultrasync Alarm System Integration #15588

wants to merge 2 commits into from

Conversation

caronc
Copy link
Contributor

@caronc caronc commented Nov 9, 2020 •
edited
Loading

Proposed change

Added documentation for new integration: Interlogix ZeroWire and Hills ComNav UltraSync Hub's

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: core/42549
  • Link to parent pull request in the Brands repository: brands/1994
  • This PR fixes or closes issue: n/a

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@probot-home-assistant probot-home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Nov 9, 2020
@caronc
Copy link
Contributor Author

caronc commented Nov 9, 2020

I originally had this ticket here which closed for some reason when i pushed up my change upon recomendation of @frenck . I'm not sure if i lose out on the OctoberFest thing; that's not a problem really, but i definitely don't want my code to get missed or closed off 🙂

This was referenced Nov 9, 2020
Closed
Closed
@frenck
Copy link
Member

frenck commented Nov 9, 2020

Ouch! What happened there 😓 The right labels are on the previous PR, so it should count correctly towards Hacktoberfest 😉

@frenck frenck added the new-integration This PR adds documentation for a new Home Assistant integration label Nov 9, 2020
@caronc
Copy link
Contributor Author

caronc commented Nov 9, 2020

Thanks for such a quick reply; i went ahead and updated the brand and core PR to point to this one instead if that's easier. You can leave the other one closed.

frenck
frenck requested changes Feb 18, 2022
View reviewed changes
source/_integrations/ultrasync.markdown
ha_domain: ultrasync
---

The `ultrasync` platform will allow you to monitor and control your Interlogix and/or ComNav NX-595E UltraSync Hub from within Home Assistant and setup automation.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The `ultrasync` platform will allow you to monitor and control your Interlogix and/or ComNav NX-595E UltraSync Hub from within Home Assistant and setup automation.
The Interlogix UltraSync Hub integration will allow you to monitor and control your Interlogix or ComNav NX-595E UltraSync Hub from within Home Assistant.

source/_integrations/ultrasync.markdown
Comment on lines +16 to +18
## Configuration

Go to the integrations page in your configuration and click on new integration -> UltraSync.
Copy link
Member

Choose a reason for hiding this comment

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

We have a nice little include for this, that handles this all 🤘

Suggested change
## Configuration
Go to the integrations page in your configuration and click on new integration -> UltraSync.
{% include integrations/config_flow.md %}

source/_integrations/ultrasync.markdown

Go to the integrations page in your configuration and click on new integration -> UltraSync.

**Note**: You can only be logged into the ZeroWire/UltraSync hub with the same user once; a subsequent login with the same user logs out the other. Since Home Assistant (HA) actively polls and maintains a login session to this Hub, it can prevent you from being able to log into at the same time elsewhere (via it's website). It is strongly recommended that you create a second user account on your Hub dedicated for just HA.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Note**: You can only be logged into the ZeroWire/UltraSync hub with the same user once; a subsequent login with the same user logs out the other. Since Home Assistant (HA) actively polls and maintains a login session to this Hub, it can prevent you from being able to log into at the same time elsewhere (via it's website). It is strongly recommended that you create a second user account on your Hub dedicated for just HA.
**Note**: You can only be logged into the ZeroWire/UltraSync hub with the same user once; a subsequent login with the same user logs out the other. Since Home Assistant (HA) actively polls and maintains a login session to this Hub, it can prevent you from being able to log in at the same time elsewhere (via its website). It is strongly recommended that you create a second user account on your Hub dedicated to just HA.

source/_integrations/ultrasync.markdown

## Sensor

This component will create these sensors in the format of `{ultrasync_hubname}_{sensor}`; The below example assumes you accept the default name of `UltraSync` (which is still represented in lowercase):
Copy link
Member

Choose a reason for hiding this comment

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

It sounds like you are trying to describe the resulting entity IDs, however, those are not guaranteed.

Instead, you could just describe the type of sensors created (without using entity IDs).

source/_integrations/ultrasync.markdown
- `ultrasync_area3state`: The Area 3 State
- `ultrasync_area4state`: The Area 4 State

There are several states each sensor can be at, but usually they will be one of the following: `Unknown`, `Ready`, `Not Ready`, `Armed Stay`, and `Armed Away`. The `Unknown` state is assigned to sensors that are not reporting; they usually sit in the spots of the Area's you're not monitoring.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
There are several states each sensor can be at, but usually they will be one of the following: `Unknown`, `Ready`, `Not Ready`, `Armed Stay`, and `Armed Away`. The `Unknown` state is assigned to sensors that are not reporting; they usually sit in the spots of the Area's you're not monitoring.
There are several states each sensor can be at, but usually, they will be one of the following: `Unknown`, `Ready`, `Not Ready`, `Armed Stay`, and `Armed Away`. The `Unknown` state is assigned to sensors that are not reporting; they usually sit in the spots of the areas you're not monitoring.

Copy link
Member

Choose a reason for hiding this comment

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

Additionally, those are states as shown in the UI, they are not the actual state.

source/_integrations/ultrasync.markdown

## Event Automation

When an Zone or Sensor changes it's state an event usable for automation is triggered on the Home Assistant Bus.
Copy link
Member

Choose a reason for hiding this comment

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

I like this section, it helps users. However, have you considered adding support for device automations? That would make this all available via the UI (without needing the know the actual events and other technical details).

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
When an Zone or Sensor changes it's state an event usable for automation is triggered on the Home Assistant Bus.
When a Zone or Sensor changes its state an event usable for automation is triggered on the Home Assistant bus.

source/_integrations/ultrasync.markdown
- `ultrasync_sensor_update`: The event includes the sensor no, name, and new status it changed to.
- `ultrasync_area_update`: The event includes the area no, name, and new status it changed to (if it did). **Note**: Area's are sent periodic heartbeats in which case the state will not change at all.

Example automation to send a message via [Apprise](https://www.home-assistant.io/integrations/apprise/) on a sensor change in your home:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Example automation to send a message via [Apprise](https://www.home-assistant.io/integrations/apprise/) on a sensor change in your home:
Example automation to send a message via [Apprise](/integrations/apprise/) on a sensor change in your home:

source/_integrations/ultrasync.markdown
Comment on lines +62 to +64
- `stay`: Set alarm scene to Stay Mode
- `away`: Set alarm scene to Away Mode (fully activate Alarm)
- `disarm`: Disarm the alarm
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be implementing the standard services of the alarm_control_panel?

@frenck frenck added the in-progress This PR/Issue is currently being worked on label Feb 18, 2022
@frenck
Copy link
Member

frenck commented May 16, 2022

Closing PR as the parent PR has been closed.

@frenck frenck closed this May 16, 2022
@probot-home-assistant probot-home-assistant bot removed the in-progress This PR/Issue is currently being worked on label May 16, 2022
@github-actions github-actions bot locked and limited conversation to collaborators May 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck requested changes

Assignees

@caronc caronc

Labels
has-parent This PR has a parent PR in a other repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@caronc @frenck