Skip to content

Add RelayAddr/Chan to Alarmdecoder#5645

Merged
frenck merged 4 commits intohome-assistant:nextfrom
digiblur:next
Jul 21, 2018
Merged

Add RelayAddr/Chan to Alarmdecoder#5645
frenck merged 4 commits intohome-assistant:nextfrom
digiblur:next

Conversation

@digiblur
Copy link
Copy Markdown
Contributor

@digiblur digiblur commented Jul 1, 2018

Description:

Adds the two optional configuration options referenced in the PR to the component.
home-assistant/core#15242

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

Checklist:

  • 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.

@ghost ghost added the to-do label Jul 1, 2018
@frenck frenck added new-feature This PR adds documentation for a new Home Assistant feature to an existing integration ready-for-review This PR needs to be reviewed next This PR goes into the next branch has-parent This PR has a parent PR in another repo and removed to-do labels Jul 2, 2018
02:
name: 'Front Door'
type: 'opening'
03:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We try to keep all configuration samples minimal. Thus, no optional requirement in the default sample. This helps a user to get started quickly by copy-&-paste the sample without worrying about optional parameters which they most likely not need. If required, insert a full configuration sample later that covers special setups or alike.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I do agree with the changes. To follow with this the rule rfid should also be removed from zone 1 that is not part of my current proposed changes.

- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off`
- **zones** (*Optional*): AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **rfid** (*Optional*): The RF serial-number associated with RF zones. Providing this field allows Home Assistant to associate raw sensor data to a given zone, allowing direct monitoring of the state, battery, and supervision status.
- **relayaddr** (*Optional*): Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion based automated lights while the system is armed with the motion sensor bypassed.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

motion based -> motion-based

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

All sounds good, new to the whole PR process/procedures with HA, how do you accept these changes? Do I make them on my side and commit them?

@frenck
Copy link
Copy Markdown
Member

frenck commented Jul 2, 2018

Thank you, @digiblur for this PR.
I've left 2 comments (of 1 is a typo). Could you take a look? 👍

@frenck frenck added in-progress This PR/Issue is currently being worked on and removed ready-for-review This PR needs to be reviewed labels Jul 2, 2018
@digiblur
Copy link
Copy Markdown
Contributor Author

digiblur commented Jul 2, 2018

Corrections done.

frenck
frenck previously approved these changes Jul 2, 2018
@frenck
Copy link
Copy Markdown
Member

frenck commented Jul 2, 2018

Thanks for the quick actions @digiblur!

✅ Approved. Can be merged as soon as the parent PR gets merged.

@frenck frenck added awaits-parent Awaits the merge of an parent PR and removed in-progress This PR/Issue is currently being worked on labels Jul 2, 2018
@digiblur
Copy link
Copy Markdown
Contributor Author

digiblur commented Jul 2, 2018

Thanks for the review and help with my first PR of this project @frenck !

- **panel_display** (*Optional*): Create a sensor called sensor.alarm_display to match the Alarm Keypad display. Default: `off`
- **zones** (*Optional*): AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **rfid** (*Optional*): The RF serial-number associated with RF zones. Providing this field allows Home Assistant to associate raw sensor data to a given zone, allowing direct monitoring of the state, battery, and supervision status.
- **relayaddr** (*Optional*): Address of the relay expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks like there are two spaces between "this." and "Alarmdecoder can emulate".

@frenck frenck self-assigned this Jul 21, 2018
@digiblur
Copy link
Copy Markdown
Contributor Author

digiblur commented Jul 21, 2018

Fixed the line above it too as I noticed the double space there as well.

@frenck frenck merged commit 4a3a21b into home-assistant:next Jul 21, 2018
@ghost ghost removed the awaits-parent Awaits the merge of an parent PR label Jul 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

has-parent This PR has a parent PR in another repo new-feature This PR adds documentation for a new Home Assistant feature to an existing integration next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants