a08539d88d
* Added support for multiple codes executed in a row now codes can be specified either by simply providing a single code, which will then be sent like usual, or multiple codes can be executed in a row, specified in a comma delimited format in the configuration.yaml. For example: 111111,222222,333333,444444 would mean 111111 would be sent first, followed by 222222 and 333333 and 444444. * rpi_rf: added line breaks to not exceed 79 characters per line * include validation for correct formatting of codes added regex which only allows either a single number (like 1252456245) or a sequence of commas followed by another number. * added line breaks to not exceed 79 characters per line * fix for 'continuation line under-indented for visual indent' * another try at 'continuation line under-indented for visual indent' * changed from regex to list for easier maintainability * removed unnecessary splitting of strings
123 lines
3.7 KiB
Python
123 lines
3.7 KiB
Python
"""
|
|
Allows to configure a switch using a 433MHz module via GPIO on a Raspberry Pi.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/switch.rpi_rf/
|
|
"""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.switch import (SwitchDevice, PLATFORM_SCHEMA)
|
|
from homeassistant.const import (CONF_NAME, CONF_SWITCHES)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
REQUIREMENTS = ['rpi-rf==0.9.6']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_CODE_OFF = 'code_off'
|
|
CONF_CODE_ON = 'code_on'
|
|
CONF_GPIO = 'gpio'
|
|
CONF_PROTOCOL = 'protocol'
|
|
CONF_PULSELENGTH = 'pulselength'
|
|
CONF_SIGNAL_REPETITIONS = 'signal_repetitions'
|
|
|
|
DEFAULT_PROTOCOL = 1
|
|
DEFAULT_SIGNAL_REPETITIONS = 10
|
|
|
|
SWITCH_SCHEMA = vol.Schema({
|
|
vol.Required(CONF_CODE_OFF):
|
|
vol.All(cv.ensure_list_csv, [cv.positive_int]),
|
|
vol.Required(CONF_CODE_ON):
|
|
vol.All(cv.ensure_list_csv, [cv.positive_int]),
|
|
vol.Optional(CONF_PULSELENGTH): cv.positive_int,
|
|
vol.Optional(CONF_SIGNAL_REPETITIONS,
|
|
default=DEFAULT_SIGNAL_REPETITIONS): cv.positive_int,
|
|
vol.Optional(CONF_PROTOCOL, default=DEFAULT_PROTOCOL): cv.positive_int,
|
|
})
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_GPIO): cv.positive_int,
|
|
vol.Required(CONF_SWITCHES): vol.Schema({cv.string: SWITCH_SCHEMA}),
|
|
})
|
|
|
|
|
|
# pylint: disable=unused-argument, import-error
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Find and return switches controlled by a generic RF device via GPIO."""
|
|
import rpi_rf
|
|
|
|
gpio = config.get(CONF_GPIO)
|
|
rfdevice = rpi_rf.RFDevice(gpio)
|
|
switches = config.get(CONF_SWITCHES)
|
|
|
|
devices = []
|
|
for dev_name, properties in switches.items():
|
|
devices.append(
|
|
RPiRFSwitch(
|
|
hass,
|
|
properties.get(CONF_NAME, dev_name),
|
|
rfdevice,
|
|
properties.get(CONF_PROTOCOL),
|
|
properties.get(CONF_PULSELENGTH),
|
|
properties.get(CONF_SIGNAL_REPETITIONS),
|
|
properties.get(CONF_CODE_ON),
|
|
properties.get(CONF_CODE_OFF)
|
|
)
|
|
)
|
|
if devices:
|
|
rfdevice.enable_tx()
|
|
|
|
add_devices(devices)
|
|
|
|
|
|
class RPiRFSwitch(SwitchDevice):
|
|
"""Representation of a GPIO RF switch."""
|
|
|
|
def __init__(self, hass, name, rfdevice, protocol, pulselength,
|
|
signal_repetitions, code_on, code_off):
|
|
"""Initialize the switch."""
|
|
self._hass = hass
|
|
self._name = name
|
|
self._state = False
|
|
self._rfdevice = rfdevice
|
|
self._protocol = protocol
|
|
self._pulselength = pulselength
|
|
self._code_on = code_on
|
|
self._code_off = code_off
|
|
self._rfdevice.tx_repeat = signal_repetitions
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed."""
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the switch."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if device is on."""
|
|
return self._state
|
|
|
|
def _send_code(self, code_list, protocol, pulselength):
|
|
"""Send the code(s) with a specified pulselength."""
|
|
_LOGGER.info("Sending code(s): %s", code_list)
|
|
for code in code_list:
|
|
self._rfdevice.tx_code(code, protocol, pulselength)
|
|
return True
|
|
|
|
def turn_on(self):
|
|
"""Turn the switch on."""
|
|
if self._send_code(self._code_on, self._protocol, self._pulselength):
|
|
self._state = True
|
|
self.update_ha_state()
|
|
|
|
def turn_off(self):
|
|
"""Turn the switch off."""
|
|
if self._send_code(self._code_off, self._protocol, self._pulselength):
|
|
self._state = False
|
|
self.update_ha_state()
|