158 lines
5.0 KiB
Python
158 lines
5.0 KiB
Python
"""Support for RFXtrx sensors."""
|
|
import logging
|
|
|
|
from RFXtrx import SensorEvent
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import ATTR_ENTITY_ID, ATTR_NAME, CONF_NAME
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.util import slugify
|
|
|
|
from . import (
|
|
ATTR_DATA_TYPE,
|
|
ATTR_FIRE_EVENT,
|
|
CONF_AUTOMATIC_ADD,
|
|
CONF_DATA_TYPE,
|
|
CONF_DEVICES,
|
|
CONF_FIRE_EVENT,
|
|
DATA_TYPES,
|
|
RECEIVED_EVT_SUBSCRIBERS,
|
|
RFX_DEVICES,
|
|
get_rfx_object,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Optional(CONF_DEVICES, default={}): {
|
|
cv.string: vol.Schema(
|
|
{
|
|
vol.Optional(CONF_NAME): cv.string,
|
|
vol.Optional(CONF_FIRE_EVENT, default=False): cv.boolean,
|
|
vol.Optional(CONF_DATA_TYPE, default=[]): vol.All(
|
|
cv.ensure_list, [vol.In(DATA_TYPES.keys())]
|
|
),
|
|
}
|
|
)
|
|
},
|
|
vol.Optional(CONF_AUTOMATIC_ADD, default=False): cv.boolean,
|
|
},
|
|
extra=vol.ALLOW_EXTRA,
|
|
)
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the RFXtrx platform."""
|
|
sensors = []
|
|
for packet_id, entity_info in config[CONF_DEVICES].items():
|
|
event = get_rfx_object(packet_id)
|
|
device_id = "sensor_{}".format(slugify(event.device.id_string.lower()))
|
|
if device_id in RFX_DEVICES:
|
|
continue
|
|
_LOGGER.info("Add %s rfxtrx.sensor", entity_info[ATTR_NAME])
|
|
|
|
sub_sensors = {}
|
|
data_types = entity_info[ATTR_DATA_TYPE]
|
|
if not data_types:
|
|
data_types = [""]
|
|
for data_type in DATA_TYPES:
|
|
if data_type in event.values:
|
|
data_types = [data_type]
|
|
break
|
|
for _data_type in data_types:
|
|
new_sensor = RfxtrxSensor(
|
|
None, entity_info[ATTR_NAME], _data_type, entity_info[ATTR_FIRE_EVENT]
|
|
)
|
|
sensors.append(new_sensor)
|
|
sub_sensors[_data_type] = new_sensor
|
|
RFX_DEVICES[device_id] = sub_sensors
|
|
add_entities(sensors)
|
|
|
|
def sensor_update(event):
|
|
"""Handle sensor updates from the RFXtrx gateway."""
|
|
if not isinstance(event, SensorEvent):
|
|
return
|
|
|
|
device_id = f"sensor_{slugify(event.device.id_string.lower())}"
|
|
|
|
if device_id in RFX_DEVICES:
|
|
sensors = RFX_DEVICES[device_id]
|
|
for data_type in sensors:
|
|
# Some multi-sensor devices send individual messages for each
|
|
# of their sensors. Update only if event contains the
|
|
# right data_type for the sensor.
|
|
if data_type not in event.values:
|
|
continue
|
|
sensor = sensors[data_type]
|
|
sensor.event = event
|
|
# Fire event
|
|
if sensor.should_fire_event:
|
|
sensor.hass.bus.fire(
|
|
"signal_received", {ATTR_ENTITY_ID: sensor.entity_id}
|
|
)
|
|
return
|
|
|
|
# Add entity if not exist and the automatic_add is True
|
|
if not config[CONF_AUTOMATIC_ADD]:
|
|
return
|
|
|
|
pkt_id = "".join(f"{x:02x}" for x in event.data)
|
|
_LOGGER.info("Automatic add rfxtrx.sensor: %s", pkt_id)
|
|
|
|
data_type = ""
|
|
for _data_type in DATA_TYPES:
|
|
if _data_type in event.values:
|
|
data_type = _data_type
|
|
break
|
|
new_sensor = RfxtrxSensor(event, pkt_id, data_type)
|
|
sub_sensors = {}
|
|
sub_sensors[new_sensor.data_type] = new_sensor
|
|
RFX_DEVICES[device_id] = sub_sensors
|
|
add_entities([new_sensor])
|
|
|
|
if sensor_update not in RECEIVED_EVT_SUBSCRIBERS:
|
|
RECEIVED_EVT_SUBSCRIBERS.append(sensor_update)
|
|
|
|
|
|
class RfxtrxSensor(Entity):
|
|
"""Representation of a RFXtrx sensor."""
|
|
|
|
def __init__(self, event, name, data_type, should_fire_event=False):
|
|
"""Initialize the sensor."""
|
|
self.event = event
|
|
self._name = name
|
|
self.should_fire_event = should_fire_event
|
|
self.data_type = data_type
|
|
self._unit_of_measurement = DATA_TYPES.get(data_type, "")
|
|
|
|
def __str__(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
if not self.event:
|
|
return None
|
|
return self.event.values.get(self.data_type)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Get the name of the sensor."""
|
|
return f"{self._name} {self.data_type}"
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the device state attributes."""
|
|
if not self.event:
|
|
return None
|
|
return self.event.values
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit this state is expressed in."""
|
|
return self._unit_of_measurement
|