jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-05-03 05:29:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove discovered MQTT fan device when discovery topic is cleared (#16858)

Browse Source
This commit is contained in:
emontnemery 2018-09-25 19:32:31 +02:00 committed by Paulus Schoutsen
parent c3f58b8c74
commit 4a265f37e0
2 changed files with 40 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
homeassistant/components/fan/mqtt.py
View File

@ -14,9 +14,9 @@ from homeassistant.const import (
CONF_NAME, CONF_OPTIMISTIC, CONF_STATE, STATE_ON, STATE_OFF, CONF_NAME, CONF_OPTIMISTIC, CONF_STATE, STATE_ON, STATE_OFF,
CONF_PAYLOAD_OFF, CONF_PAYLOAD_ON) CONF_PAYLOAD_OFF, CONF_PAYLOAD_ON)
from homeassistant.components.mqtt import ( from homeassistant.components.mqtt import (
CONF_AVAILABILITY_TOPIC, CONF_STATE_TOPIC, CONF_COMMAND_TOPIC, ATTR_DISCOVERY_HASH, CONF_AVAILABILITY_TOPIC, CONF_STATE_TOPIC,
CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE, CONF_QOS, CONF_RETAIN, CONF_COMMAND_TOPIC, CONF_PAYLOAD_AVAILABLE, CONF_PAYLOAD_NOT_AVAILABLE,
MqttAvailability) CONF_QOS, CONF_RETAIN, MqttAvailability, MqttDiscoveryUpdate)
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.typing import HomeAssistantType, ConfigType from homeassistant.helpers.typing import HomeAssistantType, ConfigType
from homeassistant.components.fan import (SPEED_LOW, SPEED_MEDIUM, from homeassistant.components.fan import (SPEED_LOW, SPEED_MEDIUM,
@ -83,6 +83,10 @@ async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
if discovery_info is not None: if discovery_info is not None:
config = PLATFORM_SCHEMA(discovery_info) config = PLATFORM_SCHEMA(discovery_info)
discovery_hash = None
if discovery_info is not None and ATTR_DISCOVERY_HASH in discovery_info:
discovery_hash = discovery_info[ATTR_DISCOVERY_HASH]
async_add_entities([MqttFan( async_add_entities([MqttFan(
config.get(CONF_NAME), config.get(CONF_NAME),
{ {
@ -116,18 +120,20 @@ async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
config.get(CONF_AVAILABILITY_TOPIC), config.get(CONF_AVAILABILITY_TOPIC),
config.get(CONF_PAYLOAD_AVAILABLE), config.get(CONF_PAYLOAD_AVAILABLE),
config.get(CONF_PAYLOAD_NOT_AVAILABLE), config.get(CONF_PAYLOAD_NOT_AVAILABLE),
discovery_hash,
)]) )])
class MqttFan(MqttAvailability, FanEntity): class MqttFan(MqttAvailability, MqttDiscoveryUpdate, FanEntity):
"""A MQTT fan component.""" """A MQTT fan component."""
def __init__(self, name, topic, templates, qos, retain, payload, def __init__(self, name, topic, templates, qos, retain, payload,
speed_list, optimistic, availability_topic, payload_available, speed_list, optimistic, availability_topic, payload_available,
payload_not_available): payload_not_available, discovery_hash):
"""Initialize the MQTT fan.""" """Initialize the MQTT fan."""
super().__init__(availability_topic, qos, payload_available, MqttAvailability.__init__(self, availability_topic, qos,
payload_not_available) payload_available, payload_not_available)
MqttDiscoveryUpdate.__init__(self, discovery_hash)
self._name = name self._name = name
self._topic = topic self._topic = topic
self._qos = qos self._qos = qos
@ -148,10 +154,12 @@ class MqttFan(MqttAvailability, FanEntity):
is not None and SUPPORT_OSCILLATE) is not None and SUPPORT_OSCILLATE)
self._supported_features |= (topic[CONF_SPEED_STATE_TOPIC] self._supported_features |= (topic[CONF_SPEED_STATE_TOPIC]
is not None and SUPPORT_SET_SPEED) is not None and SUPPORT_SET_SPEED)
self._discovery_hash = discovery_hash
async def async_added_to_hass(self): async def async_added_to_hass(self):
"""Subscribe to MQTT events.""" """Subscribe to MQTT events."""
await super().async_added_to_hass() await MqttAvailability.async_added_to_hass(self)
await MqttDiscoveryUpdate.async_added_to_hass(self)
templates = {} templates = {}
for key, tpl in list(self._templates.items()): for key, tpl in list(self._templates.items()):

25
tests/components/fan/test_mqtt.py
View File

@ -3,10 +3,12 @@ import unittest
from homeassistant.setup import setup_component from homeassistant.setup import setup_component
from homeassistant.components import fan from homeassistant.components import fan
from homeassistant.components.mqtt.discovery import async_start
from homeassistant.const import ATTR_ASSUMED_STATE, STATE_UNAVAILABLE from homeassistant.const import ATTR_ASSUMED_STATE, STATE_UNAVAILABLE
from tests.common import ( from tests.common import (
mock_mqtt_component, fire_mqtt_message, get_test_home_assistant) mock_mqtt_component, async_fire_mqtt_message, fire_mqtt_message,
get_test_home_assistant)
class TestMqttFan(unittest.TestCase): class TestMqttFan(unittest.TestCase):
@ -102,3 +104,24 @@ class TestMqttFan(unittest.TestCase):
state = self.hass.states.get('fan.test') state = self.hass.states.get('fan.test')
self.assertNotEqual(STATE_UNAVAILABLE, state.state) self.assertNotEqual(STATE_UNAVAILABLE, state.state)
async def test_discovery_removal_fan(hass, mqtt_mock, caplog):
"""Test removal of discovered fan."""
await async_start(hass, 'homeassistant', {})
data = (
'{ "name": "Beer",'
' "command_topic": "test_topic" }'
)
async_fire_mqtt_message(hass, 'homeassistant/fan/bla/config',
data)
await hass.async_block_till_done()
state = hass.states.get('fan.beer')
assert state is not None
assert state.name == 'Beer'
async_fire_mqtt_message(hass, 'homeassistant/fan/bla/config',
'')
await hass.async_block_till_done()
await hass.async_block_till_done()
state = hass.states.get('fan.beer')
assert state is None