jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-15 17:27:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small refactoring of MQTT alarm (#18813)

Browse Source
This commit is contained in:
emontnemery 2018-12-02 10:29:31 +01:00 committed by Paulus Schoutsen
parent db4a0e3244
commit 2e4e673bbe
1 changed files with 28 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
homeassistant/components/alarm_control_panel/mqtt.py
View File

@ -51,7 +51,7 @@ PLATFORM_SCHEMA = mqtt.MQTT_BASE_PLATFORM_SCHEMA.extend({
async def async_setup_platform(hass: HomeAssistantType, config: ConfigType, async def async_setup_platform(hass: HomeAssistantType, config: ConfigType,
async_add_entities, discovery_info=None): async_add_entities, discovery_info=None):
"""Set up MQTT alarm control panel through configuration.yaml.""" """Set up MQTT alarm control panel through configuration.yaml."""
await _async_setup_entity(hass, config, async_add_entities) await _async_setup_entity(config, async_add_entities)
async def async_setup_entry(hass, config_entry, async_add_entities): async def async_setup_entry(hass, config_entry, async_add_entities):
@ -59,7 +59,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
async def async_discover(discovery_payload): async def async_discover(discovery_payload):
"""Discover and add an MQTT alarm control panel.""" """Discover and add an MQTT alarm control panel."""
config = PLATFORM_SCHEMA(discovery_payload) config = PLATFORM_SCHEMA(discovery_payload)
await _async_setup_entity(hass, config, async_add_entities, await _async_setup_entity(config, async_add_entities,
discovery_payload[ATTR_DISCOVERY_HASH]) discovery_payload[ATTR_DISCOVERY_HASH])
async_dispatcher_connect( async_dispatcher_connect(
@ -67,12 +67,10 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
async_discover) async_discover)
async def _async_setup_entity(hass, config, async_add_entities, async def _async_setup_entity(config, async_add_entities,
discovery_hash=None): discovery_hash=None):
"""Set up the MQTT Alarm Control Panel platform.""" """Set up the MQTT Alarm Control Panel platform."""
async_add_entities([MqttAlarm( async_add_entities([MqttAlarm(config, discovery_hash)])
config,
discovery_hash,)])
class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate, class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
@ -85,23 +83,12 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
self._config = config self._config = config
self._sub_state = None self._sub_state = None
self._name = None
self._state_topic = None
self._command_topic = None
self._qos = None
self._retain = None
self._payload_disarm = None
self._payload_arm_home = None
self._payload_arm_away = None
self._code = None
# Load config
self._setup_from_config(config)
availability_topic = config.get(CONF_AVAILABILITY_TOPIC) availability_topic = config.get(CONF_AVAILABILITY_TOPIC)
payload_available = config.get(CONF_PAYLOAD_AVAILABLE) payload_available = config.get(CONF_PAYLOAD_AVAILABLE)
payload_not_available = config.get(CONF_PAYLOAD_NOT_AVAILABLE) payload_not_available = config.get(CONF_PAYLOAD_NOT_AVAILABLE)
MqttAvailability.__init__(self, availability_topic, self._qos, qos = config.get(CONF_QOS)
MqttAvailability.__init__(self, availability_topic, qos,
payload_available, payload_not_available) payload_available, payload_not_available)
MqttDiscoveryUpdate.__init__(self, discovery_hash, MqttDiscoveryUpdate.__init__(self, discovery_hash,
self.discovery_update) self.discovery_update)
@ -114,23 +101,11 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
async def discovery_update(self, discovery_payload): async def discovery_update(self, discovery_payload):
"""Handle updated discovery message.""" """Handle updated discovery message."""
config = PLATFORM_SCHEMA(discovery_payload) config = PLATFORM_SCHEMA(discovery_payload)
self._setup_from_config(config) self._config = config
await self.availability_discovery_update(config) await self.availability_discovery_update(config)
await self._subscribe_topics() await self._subscribe_topics()
self.async_schedule_update_ha_state() self.async_schedule_update_ha_state()
def _setup_from_config(self, config):
"""(Re)Setup the entity."""
self._name = config.get(CONF_NAME)
self._state_topic = config.get(CONF_STATE_TOPIC)
self._command_topic = config.get(CONF_COMMAND_TOPIC)
self._qos = config.get(CONF_QOS)
self._retain = config.get(CONF_RETAIN)
self._payload_disarm = config.get(CONF_PAYLOAD_DISARM)
self._payload_arm_home = config.get(CONF_PAYLOAD_ARM_HOME)
self._payload_arm_away = config.get(CONF_PAYLOAD_ARM_AWAY)
self._code = config.get(CONF_CODE)
async def _subscribe_topics(self): async def _subscribe_topics(self):
"""(Re)Subscribe to topics.""" """(Re)Subscribe to topics."""
@callback @callback
@ -146,9 +121,9 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
self._sub_state = await subscription.async_subscribe_topics( self._sub_state = await subscription.async_subscribe_topics(
self.hass, self._sub_state, self.hass, self._sub_state,
{'state_topic': {'topic': self._state_topic, {'state_topic': {'topic': self._config.get(CONF_STATE_TOPIC),
'msg_callback': message_received, 'msg_callback': message_received,
'qos': self._qos}}) 'qos': self._config.get(CONF_QOS)}})
async def async_will_remove_from_hass(self): async def async_will_remove_from_hass(self):
"""Unsubscribe when removed.""" """Unsubscribe when removed."""
@ -163,7 +138,7 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
@property @property
def name(self): def name(self):
"""Return the name of the device.""" """Return the name of the device."""
return self._name return self._config.get(CONF_NAME)
@property @property
def state(self): def state(self):
@ -173,9 +148,10 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
@property @property
def code_format(self): def code_format(self):
"""Return one or more digits/characters.""" """Return one or more digits/characters."""
if self._code is None: code = self._config.get(CONF_CODE)
if code is None:
return None return None
if isinstance(self._code, str) and re.search('^\\d+$', self._code): if isinstance(code, str) and re.search('^\\d+$', code):
return 'Number' return 'Number'
return 'Any' return 'Any'
@ -187,8 +163,10 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
if not self._validate_code(code, 'disarming'): if not self._validate_code(code, 'disarming'):
return return
mqtt.async_publish( mqtt.async_publish(
self.hass, self._command_topic, self._payload_disarm, self._qos, self.hass, self._config.get(CONF_COMMAND_TOPIC),
self._retain) self._config.get(CONF_PAYLOAD_DISARM),
self._config.get(CONF_QOS),
self._config.get(CONF_RETAIN))
async def async_alarm_arm_home(self, code=None): async def async_alarm_arm_home(self, code=None):
"""Send arm home command. """Send arm home command.
@ -198,8 +176,10 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
if not self._validate_code(code, 'arming home'): if not self._validate_code(code, 'arming home'):
return return
mqtt.async_publish( mqtt.async_publish(
self.hass, self._command_topic, self._payload_arm_home, self._qos, self.hass, self._config.get(CONF_COMMAND_TOPIC),
self._retain) self._config.get(CONF_PAYLOAD_ARM_HOME),
self._config.get(CONF_QOS),
self._config.get(CONF_RETAIN))
async def async_alarm_arm_away(self, code=None): async def async_alarm_arm_away(self, code=None):
"""Send arm away command. """Send arm away command.
@ -209,12 +189,15 @@ class MqttAlarm(MqttAvailability, MqttDiscoveryUpdate,
if not self._validate_code(code, 'arming away'): if not self._validate_code(code, 'arming away'):
return return
mqtt.async_publish( mqtt.async_publish(
self.hass, self._command_topic, self._payload_arm_away, self._qos, self.hass, self._config.get(CONF_COMMAND_TOPIC),
self._retain) self._config.get(CONF_PAYLOAD_ARM_AWAY),
self._config.get(CONF_QOS),
self._config.get(CONF_RETAIN))
def _validate_code(self, code, state): def _validate_code(self, code, state):
"""Validate given code.""" """Validate given code."""
check = self._code is None or code == self._code conf_code = self._config.get(CONF_CODE)
check = conf_code is None or code == conf_code
if not check: if not check:
_LOGGER.warning('Wrong code entered for %s', state) _LOGGER.warning('Wrong code entered for %s', state)
return check return check