Add Interlogix Ultrasync Alarm System Integration #15482

caronc · 2020-10-30T01:22:40Z

Proposed change

Added documentation for new integration: Interlogix UltraSync Hub

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).
- I've opened up a PR to add logo's and icons in Brands repository.
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.

klaasnicolaas · 2020-10-30T01:57:21Z

Please rebase this pull request to the next branch

caronc · 2020-10-30T02:35:27Z

@klaasnicolaas Thanks for your feedback; done! 👍

klaasnicolaas · 2020-10-30T15:35:23Z

source/_integrations/ultrasync.markdown

+description: Instructions on how to integrate your Interlogix UltraSync Hub within Home Assistant.
+ha_category:
+  - Alarm
+logo: informix.png


Please add a logo to our brands repository, you can remove the line here

Done; updated comments. Here is a quick link to brands/1994
You also brought forth another bug, it shouldn't have read informix.png, but interlogix.png instead. Sorry about that; this is also fixed in latest push to this branch.

You'll need to remove the logo manifest from this PR.

frenck · 2020-11-06T20:41:49Z

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.


Don't abbreviate HA.

frenck · 2020-11-06T20:42:02Z

source/_integrations/ultrasync.markdown

+ha_domain: ultrasync
+---
+
+The `ultrasync` platform will allow you to monitor and control your Interlogix UltraSync Hub from within Home Assistant and setup automation.


Suggested change

The `ultrasync` platform will allow you to monitor and control your Interlogix UltraSync Hub from within Home Assistant and setup automation.

The Ultrasync integration will allow you to monitor and control your Interlogix UltraSync Hub from within Home Assistant and setup automation.

frenck · 2020-11-06T20:43:03Z

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):


The names entity names can be changed by the user, right? They are also visible in the device overview, right?

So the device entity name hint should not be needed.

frenck · 2020-11-06T20:43:19Z

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):


Additionally, we don't use double spacing.

frenck · 2020-11-06T20:43:33Z

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.


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.

frenck · 2020-11-06T20:44:24Z

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.


Suggestion: add support for device automations to the integration?

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 is triggered. Those events are usable for automations.

frenck · 2020-11-06T20:45:29Z

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:


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:

frenck · 2020-11-06T20:46:26Z

source/_integrations/ultrasync.markdown

+Available services:
+
+- `stay`: Set alarm scene to Stay Mode
+- `away`: Set alarm scene to Away Mode (fully activate Alarm)
+- `disarm`: Disarm the alarm


Aren't these services dictated by the alarm control panel entity component?

caronc · 2020-11-09T18:51:16Z

I pushed a new change and that some how triggered a close on this branch 🤷‍♂️

probot-home-assistant bot added has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Oct 30, 2020

probot-home-assistant bot assigned caronc Oct 30, 2020

probot-home-assistant bot added current This PR goes into the current branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Oct 30, 2020

caronc changed the title ~~Add Informix Ultrasync Alarm System Integration~~ Add Interlogix Ultrasync Alarm System Integration Oct 30, 2020

caronc mentioned this pull request Oct 30, 2020

Add Interlogix Ultrasync Alarm System Integration home-assistant/core#42549

Closed

21 tasks

caronc force-pushed the current branch from 04a3ec8 to 7151c19 Compare October 30, 2020 02:17

caronc changed the base branch from current to next October 30, 2020 02:20

caronc force-pushed the current branch 2 times, most recently from 9d367cd to 35dcdb3 Compare October 30, 2020 02:30

klaasnicolaas requested changes Oct 30, 2020

View reviewed changes

caronc mentioned this pull request Oct 30, 2020

UltraSync icons added home-assistant/brands#1994

Closed

11 tasks

probot-home-assistant bot unassigned caronc Oct 30, 2020

frenck added the hacktoberfest-accepted label Oct 31, 2020

caronc requested a review from klaasnicolaas November 2, 2020 16:21

frenck requested changes Nov 6, 2020

View reviewed changes

caronc closed this Nov 9, 2020

caronc force-pushed the current branch from da87d84 to c083522 Compare November 9, 2020 18:48

probot-home-assistant bot removed the in-progress This PR/Issue is currently being worked on label Nov 9, 2020

probot-home-assistant bot added Invalid and removed Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Nov 9, 2020

caronc mentioned this pull request Nov 9, 2020

Add Interlogix Ultrasync Alarm System Integration #15588

Closed

8 tasks

frenck removed the Invalid label Nov 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Interlogix Ultrasync Alarm System Integration #15482

Add Interlogix Ultrasync Alarm System Integration #15482

caronc commented Oct 30, 2020 •

edited

Loading

klaasnicolaas commented Oct 30, 2020

caronc commented Oct 30, 2020

klaasnicolaas Oct 30, 2020

caronc Oct 30, 2020 •

edited

Loading

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

frenck Nov 6, 2020

caronc commented Nov 9, 2020


		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.

	The `ultrasync` platform will allow you to monitor and control your Interlogix UltraSync Hub from within Home Assistant and setup automation.
	The Ultrasync integration will allow you to monitor and control your Interlogix UltraSync Hub from within Home Assistant and setup automation.


		## 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):

	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.


		## Event Automation

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

	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 is triggered. Those events are usable for automations.

	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:

Add Interlogix Ultrasync Alarm System Integration #15482

Add Interlogix Ultrasync Alarm System Integration #15482

Conversation

caronc commented Oct 30, 2020 • edited Loading

Proposed change

Type of change

Additional information

Checklist

klaasnicolaas commented Oct 30, 2020

caronc commented Oct 30, 2020

Choose a reason for hiding this comment

caronc Oct 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caronc commented Nov 9, 2020

caronc commented Oct 30, 2020 •

edited

Loading

caronc Oct 30, 2020 •

edited

Loading