Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #18852 from emontnemery/mqtt_sensor_refactor 

Small refactoring of MQTT sensor
pull/18892/head^2
Daniel Høyer Iversen 2018-12-02 08:40:57 +01:00 committed by GitHub
parent 5b0c12b12b 1686f73749
commit d8c6cb1112
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -48,8 +48,8 @@ PLATFORM_SCHEMA = mqtt.MQTT_RO_PLATFORM_SCHEMA.extend({
vol.Optional(CONF_JSON_ATTRS, default=[]): cv.ensure_list_csv, vol.Optional(CONF_JSON_ATTRS, default=[]): cv.ensure_list_csv,
vol.Optional(CONF_EXPIRE_AFTER): cv.positive_int, vol.Optional(CONF_EXPIRE_AFTER): cv.positive_int,
vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean, vol.Optional(CONF_FORCE_UPDATE, default=DEFAULT_FORCE_UPDATE): cv.boolean,
# Integrations shouldn't never expose unique_id through configuration # Integrations should never expose unique_id through configuration.
# this here is an exception because MQTT is a msg transport, not a protocol # This is an exception because MQTT is a message transport, not a protocol.
vol.Optional(CONF_UNIQUE_ID): cv.string, vol.Optional(CONF_UNIQUE_ID): cv.string,
vol.Optional(CONF_DEVICE): mqtt.MQTT_ENTITY_DEVICE_INFO_SCHEMA, vol.Optional(CONF_DEVICE): mqtt.MQTT_ENTITY_DEVICE_INFO_SCHEMA,
}).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema) }).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema)
@ -86,32 +86,20 @@ class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
def __init__(self, config, discovery_hash): def __init__(self, config, discovery_hash):
"""Initialize the sensor.""" """Initialize the sensor."""
self._config = config
self._unique_id = config.get(CONF_UNIQUE_ID)
self._state = STATE_UNKNOWN self._state = STATE_UNKNOWN
self._sub_state = None self._sub_state = None
self._expiration_trigger = None self._expiration_trigger = None
self._attributes = None self._attributes = None
self._name = None
self._state_topic = None
self._qos = None
self._unit_of_measurement = None
self._force_update = None
self._template = None
self._expire_after = None
self._icon = None
self._device_class = None
self._json_attributes = None
self._unique_id = 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)
qos = config.get(CONF_QOS)
device_config = config.get(CONF_DEVICE) device_config = config.get(CONF_DEVICE)
MqttAvailability.__init__(self, availability_topic, self._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)
@ -125,35 +113,23 @@ class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
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._qos = config.get(CONF_QOS)
self._unit_of_measurement = config.get(CONF_UNIT_OF_MEASUREMENT)
self._force_update = config.get(CONF_FORCE_UPDATE)
self._expire_after = config.get(CONF_EXPIRE_AFTER)
self._icon = config.get(CONF_ICON)
self._device_class = config.get(CONF_DEVICE_CLASS)
self._template = config.get(CONF_VALUE_TEMPLATE)
self._json_attributes = set(config.get(CONF_JSON_ATTRS))
self._unique_id = config.get(CONF_UNIQUE_ID)
async def _subscribe_topics(self): async def _subscribe_topics(self):
"""(Re)Subscribe to topics.""" """(Re)Subscribe to topics."""
if self._template is not None: template = self._config.get(CONF_VALUE_TEMPLATE)
self._template.hass = self.hass if template is not None:
template.hass = self.hass
@callback @callback
def message_received(topic, payload, qos): def message_received(topic, payload, qos):
"""Handle new MQTT messages.""" """Handle new MQTT messages."""
# auto-expire enabled? # auto-expire enabled?
if self._expire_after is not None and self._expire_after > 0: expire_after = self._config.get(CONF_EXPIRE_AFTER)
if expire_after is not None and expire_after > 0:
# Reset old trigger # Reset old trigger
if self._expiration_trigger: if self._expiration_trigger:
self._expiration_trigger() self._expiration_trigger()
@ -161,18 +137,19 @@ class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
# Set new trigger # Set new trigger
expiration_at = ( expiration_at = (
dt_util.utcnow() + timedelta(seconds=self._expire_after)) dt_util.utcnow() + timedelta(seconds=expire_after))
self._expiration_trigger = async_track_point_in_utc_time( self._expiration_trigger = async_track_point_in_utc_time(
self.hass, self.value_is_expired, expiration_at) self.hass, self.value_is_expired, expiration_at)
if self._json_attributes: json_attributes = set(self._config.get(CONF_JSON_ATTRS))
if json_attributes:
self._attributes = {} self._attributes = {}
try: try:
json_dict = json.loads(payload) json_dict = json.loads(payload)
if isinstance(json_dict, dict): if isinstance(json_dict, dict):
attrs = {k: json_dict[k] for k in attrs = {k: json_dict[k] for k in
self._json_attributes & json_dict.keys()} json_attributes & json_dict.keys()}
self._attributes = attrs self._attributes = attrs
else: else:
_LOGGER.warning("JSON result was not a dictionary") _LOGGER.warning("JSON result was not a dictionary")
@ -180,17 +157,17 @@ class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
_LOGGER.warning("MQTT payload could not be parsed as JSON") _LOGGER.warning("MQTT payload could not be parsed as JSON")
_LOGGER.debug("Erroneous JSON: %s", payload) _LOGGER.debug("Erroneous JSON: %s", payload)
if self._template is not None: if template is not None:
payload = self._template.async_render_with_possible_json_value( payload = template.async_render_with_possible_json_value(
payload, self._state) payload, self._state)
self._state = payload self._state = payload
self.async_schedule_update_ha_state() self.async_schedule_update_ha_state()
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."""
@ -212,17 +189,17 @@ class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
@property @property
def name(self): def name(self):
"""Return the name of the sensor.""" """Return the name of the sensor."""
return self._name return self._config.get(CONF_NAME)
@property @property
def unit_of_measurement(self): def unit_of_measurement(self):
"""Return the unit this state is expressed in.""" """Return the unit this state is expressed in."""
return self._unit_of_measurement return self._config.get(CONF_UNIT_OF_MEASUREMENT)
@property @property
def force_update(self): def force_update(self):
"""Force update.""" """Force update."""
return self._force_update return self._config.get(CONF_FORCE_UPDATE)
@property @property
def state(self): def state(self):
@ -242,9 +219,9 @@ class MqttSensor(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,
@property @property
def icon(self): def icon(self):
"""Return the icon.""" """Return the icon."""
return self._icon return self._config.get(CONF_ICON)
@property @property
def device_class(self) -> Optional[str]: def device_class(self) -> Optional[str]:
"""Return the device class of the sensor.""" """Return the device class of the sensor."""
return self._device_class return self._config.get(CONF_DEVICE_CLASS)