Skip to content

Commit

Permalink
Refactor rfxtrx code
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel authored and Daniel committed Apr 24, 2016
1 parent 55b51cb commit 2ca1f75
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 125 deletions.
113 changes: 64 additions & 49 deletions homeassistant/components/rfxtrx.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@
from homeassistant.util import slugify
from homeassistant.const import EVENT_HOMEASSISTANT_STOP
from homeassistant.helpers.entity import Entity
from homeassistant.const import ATTR_ENTITY_ID
from homeassistant.const import (ATTR_ENTITY_ID, TEMP_CELSIUS)

REQUIREMENTS = ['pyRFXtrx==0.6.5']

DOMAIN = "rfxtrx"

DEFAULT_SIGNAL_REPETITIONS = 1

ATTR_AUTOMATIC_ADD = 'automatic_add'
ATTR_DEVICE = 'device'
ATTR_DEBUG = 'debug'
Expand All @@ -28,55 +30,77 @@
ATTR_DUMMY = 'dummy'
CONF_SIGNAL_REPETITIONS = 'signal_repetitions'
CONF_DEVICES = 'devices'
DEFAULT_SIGNAL_REPETITIONS = 1

EVENT_BUTTON_PRESSED = 'button_pressed'

DATA_TYPES = OrderedDict([
('Temperature', TEMP_CELSIUS),
('Humidity', '%'),
('Barometer', ''),
('Wind direction', ''),
('Rain rate', ''),
('Energy usage', 'W'),
('Total usage', 'W')])

RECEIVED_EVT_SUBSCRIBERS = []
RFX_DEVICES = {}
_LOGGER = logging.getLogger(__name__)
RFXOBJECT = None


def validate_packetid(value):
"""Validate that value is a valid packet id for rfxtrx."""
if get_rfx_object(value):
return value
else:
raise vol.Invalid('invalid packet id for {}'.format(value))

DEVICE_SCHEMA = vol.Schema({
vol.Required(ATTR_NAME): cv.string,
vol.Optional(ATTR_FIREEVENT, default=False): cv.boolean,
})


def _valid_device(value):
def _valid_device(value, device_type):
"""Validate a dictionary of devices definitions."""
config = OrderedDict()
for key, device in value.items():

# Still accept old configuration
if 'packetid' in device.keys():
msg = 'You are using an outdated configuration of the rfxtrx ' +\
'devuce, {}. Your new config should be:\n{}: \n\t name:{}\n'\
.format(key, device.get('packetid'),
'device, {}.'.format(key) +\
' Your new config should be:\n {}: \n name: {}'\
.format(device.get('packetid'),
device.get(ATTR_NAME, 'deivce_name'))
_LOGGER.warning(msg)
key = device.get('packetid')
device.pop('packetid')
try:
key = validate_packetid(key)

if get_rfx_object(key) is None:
raise vol.Invalid('Rfxtrx device {} is invalid: '
'Invalid device id for {}'.format(key, value))

if device_type == 'sensor':
config[key] = DEVICE_SCHEMA_SENSOR(device)
elif device_type == 'light_switch':
config[key] = DEVICE_SCHEMA(device)
if not config[key][ATTR_NAME]:
config[key][ATTR_NAME] = key
except vol.MultipleInvalid as ex:
raise vol.Invalid('Rfxtrx deive {} is invalid: {}'
.format(key, ex))
else:
raise vol.Invalid('Rfxtrx device is invalid')

if not config[key][ATTR_NAME]:
config[key][ATTR_NAME] = key
return config


def valid_sensor(value):
"""Validate sensor configuration."""
return _valid_device(value, "sensor")


def _valid_light_switch(value):
return _valid_device(value, "light_switch")

DEVICE_SCHEMA = vol.Schema({
vol.Required(ATTR_NAME): cv.string,
vol.Optional(ATTR_FIREEVENT, default=False): cv.boolean,
})

DEVICE_SCHEMA_SENSOR = vol.Schema({
vol.Optional(ATTR_NAME, default=None): cv.string,
vol.Optional(ATTR_DATA_TYPE, default=[]):
vol.All(cv.ensure_list, [vol.In(DATA_TYPES.keys())]),
})

DEFAULT_SCHEMA = vol.Schema({
vol.Required("platform"): DOMAIN,
vol.Required(CONF_DEVICES): vol.All(dict, _valid_device),
vol.Optional(CONF_DEVICES, default={}): vol.All(dict, _valid_light_switch),
vol.Optional(ATTR_AUTOMATIC_ADD, default=False): cv.boolean,
vol.Optional(CONF_SIGNAL_REPETITIONS, default=DEFAULT_SIGNAL_REPETITIONS):
vol.Coerce(int),
Expand All @@ -99,11 +123,7 @@ def handle_receive(event):
# Log RFXCOM event
if not event.device.id_string:
return
entity_id = slugify(event.device.id_string.lower())
packet_id = "".join("{0:02x}".format(x) for x in event.data)
entity_name = "%s : %s" % (entity_id, packet_id)
_LOGGER.info("Receive RFXCOM event from %s => %s",
event.device, entity_name)
_LOGGER.info("Receive RFXCOM event from %s", event.device)

# Callback to HA registered components.
for subscriber in RECEIVED_EVT_SUBSCRIBERS:
Expand Down Expand Up @@ -138,19 +158,16 @@ def get_rfx_object(packetid):
import RFXtrx as rfxtrxmod

binarypacket = bytearray.fromhex(packetid)

pkt = rfxtrxmod.lowlevel.parse(binarypacket)
if pkt is not None:
if isinstance(pkt, rfxtrxmod.lowlevel.SensorPacket):
obj = rfxtrxmod.SensorEvent(pkt)
elif isinstance(pkt, rfxtrxmod.lowlevel.Status):
obj = rfxtrxmod.StatusEvent(pkt)
else:
obj = rfxtrxmod.ControlEvent(pkt)

return obj

return None
if pkt is None:
return None
if isinstance(pkt, rfxtrxmod.lowlevel.SensorPacket):
obj = rfxtrxmod.SensorEvent(pkt)
elif isinstance(pkt, rfxtrxmod.lowlevel.Status):
obj = rfxtrxmod.StatusEvent(pkt)
else:
obj = rfxtrxmod.ControlEvent(pkt)
return obj


def get_devices_from_config(config, device):
Expand Down Expand Up @@ -182,8 +199,7 @@ def get_new_device(event, config, device):
if device_id in RFX_DEVICES:
return

automatic_add = config[ATTR_AUTOMATIC_ADD]
if not automatic_add:
if not config[ATTR_AUTOMATIC_ADD]:
return

_LOGGER.info(
Expand All @@ -193,10 +209,9 @@ def get_new_device(event, config, device):
event.device.subtype
)
pkt_id = "".join("{0:02x}".format(x) for x in event.data)
entity_name = "%s : %s" % (device_id, pkt_id)
datas = {ATTR_STATE: False, ATTR_FIREEVENT: False}
signal_repetitions = config[CONF_SIGNAL_REPETITIONS]
new_device = device(entity_name, event, datas,
new_device = device(pkt_id, event, datas,
signal_repetitions)
RFX_DEVICES[device_id] = new_device
return new_device
Expand Down Expand Up @@ -244,7 +259,7 @@ def apply_received_command(event):
class RfxtrxDevice(Entity):
"""Represents a Rfxtrx device.
Contains the common logic for all Rfxtrx devices.
Contains the common logic for Rfxtrx lights and switches.
"""

Expand Down
95 changes: 28 additions & 67 deletions homeassistant/components/sensor/rfxtrx.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,87 +5,52 @@
https://home-assistant.io/components/sensor.rfxtrx/
"""
import logging
from collections import OrderedDict
import voluptuous as vol

import homeassistant.components.rfxtrx as rfxtrx
from homeassistant.const import TEMP_CELSIUS
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity import Entity
from homeassistant.util import slugify
from homeassistant.components.rfxtrx import (
ATTR_AUTOMATIC_ADD, ATTR_NAME,
CONF_DEVICES, ATTR_DATA_TYPE)
CONF_DEVICES, ATTR_DATA_TYPE, DATA_TYPES)

DEPENDENCIES = ['rfxtrx']

DATA_TYPES = OrderedDict([
('Temperature', TEMP_CELSIUS),
('Humidity', '%'),
('Barometer', ''),
('Wind direction', ''),
('Rain rate', ''),
('Energy usage', 'W'),
('Total usage', 'W')])
_LOGGER = logging.getLogger(__name__)

DEVICE_SCHEMA = vol.Schema({
vol.Optional(ATTR_NAME, default=None): cv.string,
vol.Optional(ATTR_DATA_TYPE, default=[]):
vol.All(cv.ensure_list, [vol.In(DATA_TYPES.keys())]),
})


def _valid_sensor(value):
"""Validate a dictionary of devices definitions."""
config = OrderedDict()
for key, device in value.items():
# Still accept old configuration
if 'packetid' in device.keys():
msg = 'You are using an outdated configuration of the rfxtrx ' +\
'sensor, {}. Your new config should be:\n{}: \n\t name:{}\n'\
.format(key, device.get('packetid'),
device.get(ATTR_NAME, 'sensor_name'))
_LOGGER.warning(msg)
key = device.get('packetid')
device.pop('packetid')
try:
key = rfxtrx.validate_packetid(key)
config[key] = DEVICE_SCHEMA(device)
if not config[key][ATTR_NAME]:
config[key][ATTR_NAME] = key
except vol.MultipleInvalid as ex:
raise vol.Invalid('Rfxtrx sensor {} is invalid: {}'
.format(key, ex))
return config


PLATFORM_SCHEMA = vol.Schema({
vol.Required("platform"): rfxtrx.DOMAIN,
vol.Required(CONF_DEVICES): vol.All(dict, _valid_sensor),
vol.Optional(CONF_DEVICES, default={}): vol.All(dict, rfxtrx.valid_sensor),
vol.Optional(ATTR_AUTOMATIC_ADD, default=False): cv.boolean,
}, extra=vol.ALLOW_EXTRA)


def setup_platform(hass, config, add_devices_callback, discovery_info=None):
"""Setup the RFXtrx platform."""
# pylint: disable=too-many-locals
from RFXtrx import SensorEvent

sensors = []
for packet_id, entity_info in config['devices'].items():
event = rfxtrx.get_rfx_object(packet_id)
device_id = "sensor_" + slugify(event.device.id_string.lower())

if device_id in rfxtrx.RFX_DEVICES:
continue
_LOGGER.info("Add %s rfxtrx.sensor", entity_info[ATTR_NAME])

sub_sensors = {}
for _data_type in cv.ensure_list(entity_info[ATTR_DATA_TYPE]):
data_types = entity_info[ATTR_DATA_TYPE]
if len(data_types) == 0:
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(event, entity_info[ATTR_NAME],
_data_type)
sensors.append(new_sensor)
sub_sensors[_data_type] = new_sensor
rfxtrx.RFX_DEVICES[slugify(device_id)] = sub_sensors
rfxtrx.RFX_DEVICES[device_id] = sub_sensors

add_devices_callback(sensors)

Expand All @@ -103,19 +68,21 @@ def sensor_update(event):
return

# Add entity if not exist and the automatic_add is True
if config[ATTR_AUTOMATIC_ADD]:
pkt_id = "".join("{0:02x}".format(x) for x in event.data)
entity_name = "%s : %s" % (device_id, pkt_id)
_LOGGER.info(
"Automatic add rfxtrx.sensor: (%s : %s)",
device_id,
pkt_id)

new_sensor = RfxtrxSensor(event, entity_name)
sub_sensors = {}
sub_sensors[new_sensor.data_type] = new_sensor
rfxtrx.RFX_DEVICES[device_id] = sub_sensors
add_devices_callback([new_sensor])
if not config[ATTR_AUTOMATIC_ADD]:
return

pkt_id = "".join("{0:02x}".format(x) for x in event.data)
_LOGGER.info("Automatic add rfxtrx.sensor: %s",
device_id)

for data_type in DATA_TYPES:
if data_type in event.values:
new_sensor = RfxtrxSensor(event, pkt_id, data_type)
break
sub_sensors = {}
sub_sensors[new_sensor.data_type] = new_sensor
rfxtrx.RFX_DEVICES[device_id] = sub_sensors
add_devices_callback([new_sensor])

if sensor_update not in rfxtrx.RECEIVED_EVT_SUBSCRIBERS:
rfxtrx.RECEIVED_EVT_SUBSCRIBERS.append(sensor_update)
Expand All @@ -124,7 +91,7 @@ def sensor_update(event):
class RfxtrxSensor(Entity):
"""Representation of a RFXtrx sensor."""

def __init__(self, event, name, data_type=None):
def __init__(self, event, name, data_type):
"""Initialize the sensor."""
self.event = event
self._unit_of_measurement = None
Expand All @@ -133,12 +100,6 @@ def __init__(self, event, name, data_type=None):
if data_type:
self.data_type = data_type
self._unit_of_measurement = DATA_TYPES[data_type]
return
for data_type in DATA_TYPES:
if data_type in self.event.values:
self._unit_of_measurement = DATA_TYPES[data_type]
self.data_type = data_type
break

def __str__(self):
"""Return the name of the sensor."""
Expand Down
4 changes: 2 additions & 2 deletions tests/components/light/test_rfxtrx.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ def test_discover_light(self):
rfxtrx_core.RECEIVED_EVT_SUBSCRIBERS[0](event)
entity = rfxtrx_core.RFX_DEVICES['0e611622']
self.assertEqual(1, len(rfxtrx_core.RFX_DEVICES))
self.assertEqual('<Entity 0e611622 : 0b11009e00e6116202020070: on>',
self.assertEqual('<Entity 0b11009e00e6116202020070: on>',
entity.__str__())

event = rfxtrx_core.get_rfx_object('0b11009e00e6116201010070')
Expand All @@ -210,7 +210,7 @@ def test_discover_light(self):
rfxtrx_core.RECEIVED_EVT_SUBSCRIBERS[0](event)
entity = rfxtrx_core.RFX_DEVICES['118cdea2']
self.assertEqual(2, len(rfxtrx_core.RFX_DEVICES))
self.assertEqual('<Entity 118cdea2 : 0b1100120118cdea02020070: on>',
self.assertEqual('<Entity 0b1100120118cdea02020070: on>',
entity.__str__())

# trying to add a sensor
Expand Down
Loading

0 comments on commit 2ca1f75

Please sign in to comment.