149 lines
4.4 KiB
Python
149 lines
4.4 KiB
Python
"""
|
|
Support for exposing NX584 elements as sensors.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/binary_sensor.nx584/
|
|
"""
|
|
import logging
|
|
import threading
|
|
import time
|
|
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.binary_sensor import (
|
|
DEVICE_CLASSES, BinarySensorDevice, PLATFORM_SCHEMA)
|
|
from homeassistant.const import (CONF_HOST, CONF_PORT)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
REQUIREMENTS = ['pynx584==0.4']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_EXCLUDE_ZONES = 'exclude_zones'
|
|
CONF_ZONE_TYPES = 'zone_types'
|
|
|
|
DEFAULT_HOST = 'localhost'
|
|
DEFAULT_PORT = '5007'
|
|
DEFAULT_SSL = False
|
|
|
|
ZONE_TYPES_SCHEMA = vol.Schema({
|
|
cv.positive_int: vol.In(DEVICE_CLASSES),
|
|
})
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_EXCLUDE_ZONES, default=[]):
|
|
vol.All(cv.ensure_list, [cv.positive_int]),
|
|
vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
|
|
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
|
|
vol.Optional(CONF_ZONE_TYPES, default={}): ZONE_TYPES_SCHEMA,
|
|
})
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up the NX584 binary sensor platform."""
|
|
from nx584 import client as nx584_client
|
|
|
|
host = config.get(CONF_HOST)
|
|
port = config.get(CONF_PORT)
|
|
exclude = config.get(CONF_EXCLUDE_ZONES)
|
|
zone_types = config.get(CONF_ZONE_TYPES)
|
|
|
|
try:
|
|
client = nx584_client.Client('http://{}:{}'.format(host, port))
|
|
zones = client.list_zones()
|
|
except requests.exceptions.ConnectionError as ex:
|
|
_LOGGER.error("Unable to connect to NX584: %s", str(ex))
|
|
return False
|
|
|
|
version = [int(v) for v in client.get_version().split('.')]
|
|
if version < [1, 1]:
|
|
_LOGGER.error("NX584 is too old to use for sensors (>=0.2 required)")
|
|
return False
|
|
|
|
zone_sensors = {
|
|
zone['number']: NX584ZoneSensor(
|
|
zone,
|
|
zone_types.get(zone['number'], 'opening'))
|
|
for zone in zones
|
|
if zone['number'] not in exclude}
|
|
if zone_sensors:
|
|
add_devices(zone_sensors.values())
|
|
watcher = NX584Watcher(client, zone_sensors)
|
|
watcher.start()
|
|
else:
|
|
_LOGGER.warning("No zones found on NX584")
|
|
return True
|
|
|
|
|
|
class NX584ZoneSensor(BinarySensorDevice):
|
|
"""Representation of a NX584 zone as a sensor."""
|
|
|
|
def __init__(self, zone, zone_type):
|
|
"""Initialize the nx594 binary sensor."""
|
|
self._zone = zone
|
|
self._zone_type = zone_type
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the class of this sensor, from DEVICE_CLASSES."""
|
|
return self._zone_type
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed."""
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the binary sensor."""
|
|
return self._zone['name']
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if the binary sensor is on."""
|
|
# True means "faulted" or "open" or "abnormal state"
|
|
return self._zone['state']
|
|
|
|
|
|
class NX584Watcher(threading.Thread):
|
|
"""Event listener thread to process NX584 events."""
|
|
|
|
def __init__(self, client, zone_sensors):
|
|
"""Initialize NX584 watcher thread."""
|
|
super(NX584Watcher, self).__init__()
|
|
self.daemon = True
|
|
self._client = client
|
|
self._zone_sensors = zone_sensors
|
|
|
|
def _process_zone_event(self, event):
|
|
zone = event['zone']
|
|
zone_sensor = self._zone_sensors.get(zone)
|
|
# pylint: disable=protected-access
|
|
if not zone_sensor:
|
|
return
|
|
zone_sensor._zone['state'] = event['zone_state']
|
|
zone_sensor.schedule_update_ha_state()
|
|
|
|
def _process_events(self, events):
|
|
for event in events:
|
|
if event.get('type') == 'zone_status':
|
|
self._process_zone_event(event)
|
|
|
|
def _run(self):
|
|
"""Throw away any existing events so we don't replay history."""
|
|
self._client.get_events()
|
|
while True:
|
|
events = self._client.get_events()
|
|
if events:
|
|
self._process_events(events)
|
|
|
|
def run(self):
|
|
"""Run the watcher."""
|
|
while True:
|
|
try:
|
|
self._run()
|
|
except requests.exceptions.ConnectionError:
|
|
_LOGGER.error("Failed to reach NX584 server")
|
|
time.sleep(10)
|