Add Chime status and control to Alarm Decoder component #11271

mririgoyen · 2017-12-22T02:09:48Z

Description:

Add the method alarmdecoder_alarm_toggle_chime in the Alarm Decoder component only. Doing so allows this service method to be called in the Home Assistant UI Services tab, the REST API, or the Websocket API with an alarm code that sends the command to toggle the alarm's chime function on or off.

This PR also includes the changes from #11155 done by @hawk259, which exposes additional attributes on the Alarm Decoder alarm panel. The chime and ready attributes in particular are required to round out this feature.

- Added a new `alarmdecoder_alarm_toggle_chime` method in the Alarm Decoder component. (@goyney)
- Added new status attributes to the Alarm Decoder alarm panel: `ac_power`,
  `backlight_on`, `battery_low`, `check_zone`, `chime`, `entry_delay_off`,
  `programming_mode`, `ready`, `zone_bypassed` (@hawk259)

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#4277

Example entry for `configuration.yaml` (if applicable):

With these changes, you can easily add a template switch to show status and control your chime.

- platform: template
  switches:
    alarm_chime:
      friendly_name: Chime
      value_template: "{{ is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) }}"
      turn_on:
        service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
        data:
          code: !secret alarm_code
      turn_off:
        service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
        data:
          code: !secret alarm_code
      icon_template: >-
          {% if is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) %}
            mdi:bell-ring
          {% else %}
            mdi:bell-off
          {% endif %}

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

…y status

houndci-bot · 2017-12-22T02:09:55Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

 from homeassistant.components.alarmdecoder import (
    DATA_AD, SIGNAL_PANEL_MESSAGE)
 from homeassistant.const import (
-    STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED,
+    ATTR_CODE, STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED,


line too long (84 > 79 characters)

mririgoyen · 2017-12-22T02:48:13Z

Can a reviewer please be assigned to this PR?

MartinHjelmare · 2017-12-22T06:49:38Z

As this PR is based on changes in #11155 we have to wait until that is merged or closed.

hawk259 · 2017-12-24T20:24:09Z

👍 Thanks @goyney

mririgoyen · 2017-12-24T20:25:27Z

@MartinHjelmare #11155 has been closed in favor of this one. Ready for review for merge!

MartinHjelmare

I've added some comments to old code. It would be great if you can fix those too.

MartinHjelmare · 2017-12-24T21:00:34Z

homeassistant/components/alarm_control_panel/alarmdecoder.py


 _LOGGER = logging.getLogger(__name__)

 DEPENDENCIES = ['alarmdecoder']

+SERVICE_ALARM_TOGGLE_CHIME = 'alarm_toggle_chime'


Prefix the string with the platform name, ie 'alarmdecoder_alarm_toggle_chime' .

MartinHjelmare · 2017-12-24T21:02:38Z

homeassistant/components/alarm_control_panel/alarmdecoder.py


 _LOGGER = logging.getLogger(__name__)

 DEPENDENCIES = ['alarmdecoder']

+SERVICE_ALARM_TOGGLE_CHIME = 'alarm_toggle_chime'
+ALARM_TOGGLE_CHIME_SCHEMA = vol.Schema({
+    vol.Optional(ATTR_CODE): cv.string,


Change to Required.

MartinHjelmare · 2017-12-24T21:04:18Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

+    device = AlarmDecoderAlarmPanel()
+    add_devices([device])
+
+    @callback


Remove this, as the method called will perform I/O.

MartinHjelmare · 2017-12-24T21:07:03Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

+
+    hass.services.register(
+        alarm.DOMAIN, SERVICE_ALARM_TOGGLE_CHIME, alarm_toggle_chime_handler,
+        description=None, schema=ALARM_TOGGLE_CHIME_SCHEMA)


Please add a description.

MartinHjelmare · 2017-12-24T21:08:46Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

+
+    hass.services.register(
+        alarm.DOMAIN, SERVICE_ALARM_TOGGLE_CHIME, alarm_toggle_chime_handler,
+        description=None, schema=ALARM_TOGGLE_CHIME_SCHEMA)

    return True


Old code, but please remove. This function shouldn't return anything.

MartinHjelmare · 2017-12-24T21:17:27Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

@@ -42,22 +71,63 @@ def async_added_to_hass(self):
            SIGNAL_PANEL_MESSAGE, self._message_callback)

    def _message_callback(self, message):
+        do_update = False
+
        if message.alarm_sounding or message.fire_alarm:
            if self._state != STATE_ALARM_TRIGGERED:


You can remove all these checks of the old state. They don't add any value. Also remove the check if an update should be scheduled. Just schedule the update. There will only be a state update if the state has changed anyway.

MartinHjelmare · 2017-12-24T21:18:21Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

@@ -42,22 +71,63 @@ def async_added_to_hass(self):
            SIGNAL_PANEL_MESSAGE, self._message_callback)

    def _message_callback(self, message):
+        do_update = False


Remove this, see comment below.

MartinHjelmare · 2017-12-24T21:20:23Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

+    def alarm_toggle_chime(self, code=None):
+        """Send toggle chime command."""
+        if code:
+            _LOGGER.debug("alarm_toggle_chime: sending %s9", str(code))


If this is the same code that disarms the alarm, we shouldn't log it.

MartinHjelmare · 2017-12-24T21:21:39Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

@@ -96,3 +181,9 @@ def alarm_arm_home(self, code=None):
        if code:
            _LOGGER.debug("alarm_arm_home: sending %s3", str(code))


Please remove the code from the log.

MartinHjelmare · 2017-12-24T21:31:17Z

Please also link to a docs PR describing the new service and maybe the attributes.

houndci-bot · 2017-12-25T03:07:13Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

+
+    hass.services.register(
+        alarm.DOMAIN, SERVICE_ALARM_TOGGLE_CHIME, alarm_toggle_chime_handler,
+        descriptions.get(SERVICE_ALARM_TOGGLE_CHIME), schema=ALARM_TOGGLE_CHIME_SCHEMA)


line too long (87 > 79 characters)

houndci-bot · 2017-12-25T03:07:14Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

-    return True
+    descriptions = yield from hass.async_add_job(
+        load_yaml_config_file, os.path.join(
+            os.path.dirname(__file__), 'services.yaml'))


undefined name 'os'

houndci-bot · 2017-12-25T03:07:14Z

homeassistant/components/alarm_control_panel/alarmdecoder.py


-    return True
+    descriptions = yield from hass.async_add_job(
+        load_yaml_config_file, os.path.join(


undefined name 'os'

houndci-bot · 2017-12-25T03:07:14Z

homeassistant/components/alarm_control_panel/alarmdecoder.py

@@ -7,23 +7,45 @@
 import asyncio
 import logging

+import voluptuous as vol
+
+from homeassistant.core import callback


'homeassistant.core.callback' imported but unused

mririgoyen · 2017-12-25T03:56:35Z

@MartinHjelmare All requested changes have been addressed and I have linked to the PR for the documentation update in the original post. Here it is as well: home-assistant/home-assistant.io#4277

MartinHjelmare

Great!

mririgoyen added 2 commits December 21, 2017 19:58

Enable more alarm decoder attributes, including chime status and read…

eea476d

…y status

Expose chime service in the alarm decoder component

b5027ca

homeassistant added platform: alarm_control_panel.alarmdecoder cla-signed labels Dec 22, 2017

houndci-bot reviewed Dec 22, 2017

View reviewed changes

mririgoyen added 2 commits December 21, 2017 21:11

Fix line length linting issue

deae698

Fix spacing lint issue

f5a41a4

balloobbot added the platform label Dec 22, 2017

This was referenced Dec 22, 2017

Add attributes to AlarmDecoder #11155

Closed

Alarm Decoder connections via socket or serial stop responding randomly #11157

Closed

MartinHjelmare requested changes Dec 24, 2017

View reviewed changes

Update PR based on reviewer requests

ed3998c

homeassistant added the cla-signed label Dec 25, 2017

houndci-bot reviewed Dec 25, 2017

View reviewed changes

mririgoyen added 2 commits December 24, 2017 22:08

Update based on linting catches

8fff91a

Fix descriptions include from async to sync

293e92e

mririgoyen mentioned this pull request Dec 25, 2017

Update the Alarm Decoder docs to outline the services and attributes home-assistant/home-assistant.io#4277

Merged

2 tasks

MartinHjelmare approved these changes Dec 25, 2017

View reviewed changes

MartinHjelmare merged commit a44181f into home-assistant:dev Dec 25, 2017

balloob mentioned this pull request Jan 11, 2018

0.61 #11589

Merged

mririgoyen mentioned this pull request Feb 18, 2018

Credit generation tool missing contributors home-assistant/home-assistant.io#4703

Closed

home-assistant locked and limited conversation to collaborators Mar 30, 2018

ghost added integration: alarmdecoder and removed platform: alarm_control_panel.alarmdecoder labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Chime status and control to Alarm Decoder component #11271

Add Chime status and control to Alarm Decoder component #11271

mririgoyen commented Dec 22, 2017 •

edited

houndci-bot Dec 22, 2017

mririgoyen commented Dec 22, 2017

MartinHjelmare commented Dec 22, 2017

hawk259 commented Dec 24, 2017

mririgoyen commented Dec 24, 2017

MartinHjelmare left a comment

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare Dec 24, 2017

MartinHjelmare commented Dec 24, 2017

houndci-bot Dec 25, 2017

houndci-bot Dec 25, 2017

houndci-bot Dec 25, 2017

houndci-bot Dec 25, 2017

mririgoyen commented Dec 25, 2017

MartinHjelmare left a comment

		@@ -96,3 +181,9 @@ def alarm_arm_home(self, code=None):
		if code:
		_LOGGER.debug("alarm_arm_home: sending %s3", str(code))

Add Chime status and control to Alarm Decoder component #11271

Add Chime status and control to Alarm Decoder component #11271

Conversation

mririgoyen commented Dec 22, 2017 • edited

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

mririgoyen commented Dec 22, 2017

MartinHjelmare commented Dec 22, 2017

hawk259 commented Dec 24, 2017

mririgoyen commented Dec 24, 2017

MartinHjelmare left a 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

Choose a reason for hiding this comment

MartinHjelmare commented Dec 24, 2017

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

mririgoyen commented Dec 25, 2017

MartinHjelmare left a comment

Choose a reason for hiding this comment

mririgoyen commented Dec 22, 2017 •

edited

Example entry for `configuration.yaml` (if applicable):