More support for availability reporting on MQTT components #11336

DanNixon · 2017-12-27T23:45:49Z

Description:

Adds the ability to use alive and LWT messages to set the availability of the majority of MQTT devices and abstracts the logic for handling availability topics to a mixin MqttAvailability.

The following components now support availability:

Switch (previously supported)
Binary sensor (previously supported)
Cover (previously supported)
Light
JSON light
Template light
Lock
Fan
HVAC
Sensor
Vacuum
Alarm control panel

Breaking changes:

The default availability payloads for the MQTT Switch platform have changed from "ON" and "OFF" to "online" and "offline" (in order to match the majority of MQTT platforms that already supported availability reporting).

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

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

binary_sensor:
  - platform: mqtt
    state_topic: "home-assistant/window/contact"
    availability_topic: "availability_topic"
    payload_available: "good"
    payload_not_available: "nogood"

The last three variables are the important ones, they can be added to the configuration of any of the components mentioned above.

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

houndci-bot · 2017-12-27T23:46:06Z

tests/components/fan/test_mqtt.py

+
+from homeassistant.setup import setup_component
+from homeassistant.components import fan
+from homeassistant.const import (


'homeassistant.const.STATE_ON' imported but unused
'homeassistant.const.STATE_OFF' imported but unused

MartinHjelmare · 2017-12-27T23:59:43Z

homeassistant/components/alarm_control_panel/mqtt.py

        """Init the MQTT Alarm Control Panel."""
+        super(MqttAlarm, self).__init__(


Please use python 3 style call:

super().__init__(...)

MartinHjelmare · 2017-12-28T00:02:29Z

homeassistant/components/alarm_control_panel/mqtt.py

@@ -89,7 +99,7 @@ def message_received(topic, payload, qos):
            self._state = payload
            self.async_schedule_update_ha_state()

-        return mqtt.async_subscribe(
+        yield from mqtt.async_subscribe(


Was this a bug?

No, but it is required now as multiple topics can be subscribed (status and availability).

Ok, for clarity I think we should add the @asyncio.coroutine annotation to all async_added_to_hass methods in the entity classes affected by this PR. I think that should have been done previously, so if you can do that it's 👍.

Also update the docstrings for these methods. Ie they don't return a coroutine object anymore.

My last comment came out weird, of course the coroutine function will still return a coroutine object but it doesn't explicitly return something, so I think we can remove the last sentence in the docstring.

MartinHjelmare · 2017-12-28T00:07:37Z

homeassistant/components/mqtt/__init__.py

+                 payload_not_available):
+        """Initialize the MQTT binary sensor."""
+        self._availability_topic = availability_topic
+        self._available = True if availability_topic is None else False


self._available = availability_topic is None

- Moved availability topic and payloads to MQTT base schema. - Updated components that already report availability: - Switch - Binary sensor - Cover

- Light - JSON light - Template light - Lock - Fan - HVAC - Sensor - Vacuum - Alarm control panel

MartinHjelmare · 2017-12-28T10:37:23Z

Please don't squash after PR review has started. It makes it harder to follow changes.

MartinHjelmare

This looks good to me. I think we can merge when tests pass.

DanNixon · 2017-12-28T12:23:01Z

@MartinHjelmare Cool, I'm just getting the documentation ready now.

Also this changes the default values for availability payloads for the MQTT Switch platform, would that be enough to warrant this being a breaking change?

MartinHjelmare · 2017-12-28T12:33:43Z

Great!

Yes, let's add the breaking change tag to be clear. Please add a paragraph in the description what has changed that is breaking.

To accompany changes from: home-assistant/core#11336 Updated platforms: - Switch (previously supported) - Binary sensor (previously supported) - Cover (previously supported) - Light - JSON light - Template light - Sensor - Alarm control panel - Lock - HVAC - Fan - Vacuum

Diaoul · 2018-01-20T14:06:11Z

homeassistant/components/alarm_control_panel/mqtt.py

+        config.get(CONF_CODE),
+        config.get(CONF_AVAILABILITY_TOPIC),
+        config.get(CONF_PAYLOAD_AVAILABLE),
+        config.get(CONF_PAYLOAD_NOT_AVAILABLE))])


Trying it right now, my alarm is always showing as unavailable. I think you missed the .extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema). Can you confirm?

Yes, it is missing (added in #11829).

Not sure why the unit test didn't complain about this, and since it didn't why it is not working for you.

Yes I saw the unit test, this is very surprising. I will test this further but it seems it sees the availability_topic in my config (as it shows the alarm as unavailable) but doesn't get the value from it (which is "online"). The message is properly retained, checked with mosquitto_sub.

Here is my config:

alarm_control_panel: platform: mqtt state_topic: home/alarm command_topic: home/alarm/set availability_topic: home/alarm/availability

Maybe the unit test somehow bypass some config validation? /cc @balloob

So I've tested with this config:

alarm_control_panel: platform: mqtt state_topic: home/alarm command_topic: home/alarm/set availability_topic: home/alarm/availability payload_available: online payload_not_available: offline

And it works perfectly.

My guess is that without the schema extension, the component isn't able to get default values for the config variables.

Ah, yes. That makes sense. Without the schema the values for the payloads will both be None.

For the sake of completeness I'll add some extra tests for the default payloads in #11829.

Thanks for your quick response and fixes!

OttoWinter · 2018-01-26T15:59:54Z

@DanNixon Please correct me if I'm wrong, but I believe you forgot to delete the availability topic subscription in the cover component. See https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/mqtt.py#L218 and line 235.

DanNixon · 2018-01-26T17:44:13Z

@OttoWinter Yes, it looks that way. Thanks for spotting.

I'm a little busy for the time being but I can have a look and correct it in a couple of days.

DanNixon requested a review from a team as a code owner December 27, 2017 23:45

homeassistant added the cla-signed label Dec 27, 2017

balloobbot added core platform labels Dec 27, 2017

houndci-bot reviewed Dec 27, 2017

View reviewed changes

DanNixon changed the title ~~Mqtt availability all components~~ More support for availability reporting on MQTT components Dec 27, 2017

DanNixon force-pushed the mqtt_availability_all_components branch from 72d92d1 to 1761cd7 Compare December 27, 2017 23:49

homeassistant added the cla-signed label Dec 27, 2017

MartinHjelmare requested changes Dec 28, 2017

View reviewed changes

DanNixon added 2 commits December 28, 2017 09:24

Abstract MQTT availability from individual components

a29388e

- Moved availability topic and payloads to MQTT base schema. - Updated components that already report availability: - Switch - Binary sensor - Cover

Add availability reporting to additional MQTT components

e22ff6c

- Light - JSON light - Template light - Lock - Fan - HVAC - Sensor - Vacuum - Alarm control panel

DanNixon force-pushed the mqtt_availability_all_components branch from 1761cd7 to e22ff6c Compare December 28, 2017 09:33

homeassistant added the cla-signed label Dec 28, 2017

Annotate MQTT platform coroutines

af0545c

MartinHjelmare approved these changes Dec 28, 2017

View reviewed changes

MartinHjelmare added the breaking-change label Dec 28, 2017

DanNixon mentioned this pull request Dec 28, 2017

Update MQTT platforms that now support availablity home-assistant/home-assistant.io#4293

Merged

2 tasks

balloob merged commit f0bf7b0 into home-assistant:dev Jan 2, 2018

balloob mentioned this pull request Jan 11, 2018

0.61 #11589

Merged

parberge mentioned this pull request Jan 19, 2018

Question: Does this change apply to emqtt wicol/emqtt#4

Closed

Diaoul reviewed Jan 20, 2018

View reviewed changes

Diaoul mentioned this pull request Jan 20, 2018

Add missing availability schema to MQTT alarm panel #11829

Merged

6 tasks

DanNixon deleted the mqtt_availability_all_components branch January 20, 2018 15:02

OttoWinter mentioned this pull request Jan 29, 2018

Fix MQTT cover availability subscription #12036

Merged

3 tasks

mkfink mentioned this pull request May 16, 2018

Add availability (LWT) to all the MQTT things i3detroit/homeassistant-config#12

Closed

home-assistant locked and limited conversation to collaborators May 29, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More support for availability reporting on MQTT components #11336

More support for availability reporting on MQTT components #11336

DanNixon commented Dec 27, 2017 •

edited

Loading

houndci-bot Dec 27, 2017

MartinHjelmare Dec 27, 2017

MartinHjelmare Dec 28, 2017

DanNixon Dec 28, 2017

MartinHjelmare Dec 28, 2017

MartinHjelmare Dec 28, 2017

MartinHjelmare Dec 28, 2017

MartinHjelmare Dec 28, 2017

MartinHjelmare commented Dec 28, 2017

MartinHjelmare left a comment

DanNixon commented Dec 28, 2017

MartinHjelmare commented Dec 28, 2017

Diaoul Jan 20, 2018

DanNixon Jan 20, 2018

Diaoul Jan 20, 2018 •

edited

Loading

Diaoul Jan 20, 2018 •

edited

Loading

DanNixon Jan 20, 2018

Diaoul Jan 20, 2018

OttoWinter commented Jan 26, 2018

DanNixon commented Jan 26, 2018

		"""Init the MQTT Alarm Control Panel."""
		super(MqttAlarm, self).__init__(

More support for availability reporting on MQTT components #11336

More support for availability reporting on MQTT components #11336

Conversation

DanNixon commented Dec 27, 2017 • edited Loading

Description:

Breaking changes:

Example entry for configuration.yaml (if applicable):

Checklist:

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 28, 2017

MartinHjelmare left a comment

Choose a reason for hiding this comment

DanNixon commented Dec 28, 2017

MartinHjelmare commented Dec 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Diaoul Jan 20, 2018 • edited Loading

Choose a reason for hiding this comment

Diaoul Jan 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OttoWinter commented Jan 26, 2018

DanNixon commented Jan 26, 2018

DanNixon commented Dec 27, 2017 •

edited

Loading

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

Diaoul Jan 20, 2018 •

edited

Loading

Diaoul Jan 20, 2018 •

edited

Loading