180 lines
5.3 KiB
Python
180 lines
5.3 KiB
Python
"""
|
|
Support for Vera sensors.
|
|
|
|
Configuration:
|
|
To use the Vera sensors you will need to add something like the following to
|
|
your config/configuration.yaml
|
|
|
|
sensor:
|
|
platform: vera
|
|
vera_controller_url: http://YOUR_VERA_IP:3480/
|
|
device_data:
|
|
-
|
|
vera_id: 12
|
|
name: My awesome sensor
|
|
exclude: true
|
|
-
|
|
vera_id: 13
|
|
name: Another sensor
|
|
|
|
VARIABLES:
|
|
|
|
vera_controller_url
|
|
*Required
|
|
This is the base URL of your vera controller including the port number if not
|
|
running on 80
|
|
Example: http://192.168.1.21:3480/
|
|
|
|
|
|
device_data
|
|
*Optional
|
|
This contains an array additional device info for your Vera devices. It is not
|
|
required and if not specified all sensors configured in your Vera controller
|
|
will be added with default values.
|
|
|
|
|
|
These are the variables for the device_data array:
|
|
|
|
vera_id
|
|
*Required
|
|
The Vera device id you wish these configuration options to be applied to
|
|
|
|
|
|
name
|
|
*Optional
|
|
This parameter allows you to override the name of your Vera device in the HA
|
|
interface, if not specified the value configured for the device in your Vera
|
|
will be used
|
|
|
|
|
|
exclude
|
|
*Optional
|
|
This parameter allows you to exclude the specified device from homeassistant,
|
|
it should be set to "true" if you want this device excluded
|
|
|
|
"""
|
|
import logging
|
|
import time
|
|
|
|
from homeassistant.helpers import Device
|
|
from homeassistant.const import ATTR_BATTERY_LEVEL
|
|
# pylint: disable=no-name-in-module, import-error
|
|
import homeassistant.external.vera.vera as veraApi
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def get_devices(hass, config):
|
|
""" Find and return Vera Sensors. """
|
|
|
|
base_url = config.get('vera_controller_url')
|
|
if not base_url:
|
|
_LOGGER.error(
|
|
"The required parameter 'vera_controller_url'"
|
|
" was not found in config"
|
|
)
|
|
return False
|
|
|
|
device_data = config.get('device_data', None)
|
|
|
|
vera_controller = veraApi.VeraController(base_url)
|
|
categories = ['Temperature Sensor', 'Light Sensor', 'Sensor']
|
|
devices = []
|
|
try:
|
|
devices = vera_controller.get_devices(categories)
|
|
# pylint: disable=broad-except
|
|
except Exception as inst:
|
|
_LOGGER.error("Could not find Vera sensors: %s", inst)
|
|
return False
|
|
|
|
vera_sensors = []
|
|
for device in devices:
|
|
extra_data = get_extra_device_data(device_data, device.deviceId)
|
|
exclude = False
|
|
if extra_data:
|
|
exclude = extra_data.get('exclude', False)
|
|
|
|
if exclude is not True:
|
|
vera_sensors.append(VeraSensor(device, extra_data))
|
|
|
|
return vera_sensors
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
""" Performs setup for Vera controller devices """
|
|
add_devices(get_devices(hass, config))
|
|
|
|
|
|
def get_extra_device_data(device_data, device_id):
|
|
""" Gets the additional configuration data by Vera device Id """
|
|
if not device_data:
|
|
return None
|
|
|
|
for item in device_data:
|
|
if item.get('vera_id') == device_id:
|
|
return item
|
|
return None
|
|
|
|
|
|
class VeraSensor(Device):
|
|
""" Represents a Vera Sensor """
|
|
extra_data = None
|
|
current_value = ''
|
|
|
|
def __init__(self, vera_device, extra_data=None):
|
|
self.vera_device = vera_device
|
|
self.extra_data = extra_data
|
|
|
|
def __str__(self):
|
|
return "%s %s %s" % (self.name, self.vera_device.deviceId, self.state)
|
|
|
|
@property
|
|
def state(self):
|
|
return self.current_value
|
|
|
|
@property
|
|
def name(self):
|
|
""" Get the mame of the sensor. """
|
|
if self.extra_data and self.extra_data.get('name'):
|
|
return self.extra_data.get('name')
|
|
return self.vera_device.name
|
|
|
|
@property
|
|
def state_attributes(self):
|
|
attr = super().state_attributes
|
|
if self.vera_device.has_battery:
|
|
attr[ATTR_BATTERY_LEVEL] = self.vera_device.battery_level + '%'
|
|
|
|
if self.vera_device.is_armable:
|
|
armed = self.vera_device.refresh_value('Armed')
|
|
attr['Armed'] = 'True' if armed == '1' else 'False'
|
|
|
|
if self.vera_device.is_trippable:
|
|
last_tripped = self.vera_device.refresh_value('LastTrip')
|
|
trip_time_str = time.strftime(
|
|
"%Y-%m-%d %H:%M",
|
|
time.localtime(int(last_tripped))
|
|
)
|
|
attr['Last Tripped'] = trip_time_str
|
|
tripped = self.vera_device.refresh_value('Tripped')
|
|
attr['Tripped'] = 'True' if tripped == '1' else 'False'
|
|
|
|
attr['Vera Device Id'] = self.vera_device.vera_device_id
|
|
return attr
|
|
|
|
def update(self):
|
|
if self.vera_device.category == "Temperature Sensor":
|
|
self.vera_device.refresh_value('CurrentTemperature')
|
|
current_temp = self.vera_device.get_value('CurrentTemperature')
|
|
vera_temp_units = self.vera_device.veraController.temperature_units
|
|
self.current_value = current_temp + '°' + vera_temp_units
|
|
elif self.vera_device.category == "Light Sensor":
|
|
self.vera_device.refresh_value('CurrentLevel')
|
|
self.current_value = self.vera_device.get_value('CurrentLevel')
|
|
elif self.vera_device.category == "Sensor":
|
|
tripped = self.vera_device.refresh_value('Tripped')
|
|
self.current_value = 'Tripped' if tripped == '1' else 'Not Tripped'
|
|
else:
|
|
self.current_value = 'Unknown'
|