Migrate to voluptuous (#3096)

This commit is contained in:
Fabian Affolter 2016-09-02 06:31:32 +02:00 committed by Teagan Glenn
parent a50205aedb
commit 177d8ef4ef
3 changed files with 75 additions and 60 deletions

View File

@ -6,32 +6,38 @@ https://home-assistant.io/components/binary_sensor.bloomsky/
""" """
import logging import logging
from homeassistant.components.binary_sensor import BinarySensorDevice import voluptuous as vol
from homeassistant.loader import get_component
DEPENDENCIES = ["bloomsky"] from homeassistant.components.binary_sensor import (
BinarySensorDevice, PLATFORM_SCHEMA)
from homeassistant.const import CONF_MONITORED_CONDITIONS
from homeassistant.loader import get_component
import homeassistant.helpers.config_validation as cv
_LOGGER = logging.getLogger(__name__)
DEPENDENCIES = ['bloomsky']
# These are the available sensors mapped to binary_sensor class # These are the available sensors mapped to binary_sensor class
SENSOR_TYPES = { SENSOR_TYPES = {
"Rain": "moisture", 'Rain': 'moisture',
"Night": None, 'Night': None,
} }
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_MONITORED_CONDITIONS, default=SENSOR_TYPES):
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
})
def setup_platform(hass, config, add_devices, discovery_info=None): def setup_platform(hass, config, add_devices, discovery_info=None):
"""Setup the available BloomSky weather binary sensors.""" """Setup the available BloomSky weather binary sensors."""
logger = logging.getLogger(__name__)
bloomsky = get_component('bloomsky') bloomsky = get_component('bloomsky')
sensors = config.get('monitored_conditions', SENSOR_TYPES) sensors = config.get(CONF_MONITORED_CONDITIONS)
for device in bloomsky.BLOOMSKY.devices.values(): for device in bloomsky.BLOOMSKY.devices.values():
for variable in sensors: for variable in sensors:
if variable in SENSOR_TYPES: add_devices([BloomSkySensor(bloomsky.BLOOMSKY, device, variable)])
add_devices([BloomSkySensor(bloomsky.BLOOMSKY,
device,
variable)])
else:
logger.error("Cannot find definition for device: %s", variable)
class BloomSkySensor(BinarySensorDevice): class BloomSkySensor(BinarySensorDevice):
@ -40,10 +46,10 @@ class BloomSkySensor(BinarySensorDevice):
def __init__(self, bs, device, sensor_name): def __init__(self, bs, device, sensor_name):
"""Initialize a BloomSky binary sensor.""" """Initialize a BloomSky binary sensor."""
self._bloomsky = bs self._bloomsky = bs
self._device_id = device["DeviceID"] self._device_id = device['DeviceID']
self._sensor_name = sensor_name self._sensor_name = sensor_name
self._name = "{} {}".format(device["DeviceName"], sensor_name) self._name = '{} {}'.format(device['DeviceName'], sensor_name)
self._unique_id = "bloomsky_binary_sensor {}".format(self._name) self._unique_id = 'bloomsky_binary_sensor {}'.format(self._name)
self.update() self.update()
@property @property
@ -71,4 +77,4 @@ class BloomSkySensor(BinarySensorDevice):
self._bloomsky.refresh_devices() self._bloomsky.refresh_devices()
self._state = \ self._state = \
self._bloomsky.devices[self._device_id]["Data"][self._sensor_name] self._bloomsky.devices[self._device_id]['Data'][self._sensor_name]

View File

@ -8,30 +8,34 @@ import logging
from datetime import timedelta from datetime import timedelta
import requests import requests
import voluptuous as vol
from homeassistant.const import CONF_API_KEY from homeassistant.const import CONF_API_KEY
from homeassistant.helpers import validate_config, discovery from homeassistant.helpers import discovery
from homeassistant.util import Throttle from homeassistant.util import Throttle
import homeassistant.helpers.config_validation as cv
DOMAIN = "bloomsky"
BLOOMSKY = None
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
BLOOMSKY = None
BLOOMSKY_TYPE = ['camera', 'binary_sensor', 'sensor']
DOMAIN = 'bloomsky'
# The BloomSky only updates every 5-8 minutes as per the API spec so there's # The BloomSky only updates every 5-8 minutes as per the API spec so there's
# no point in polling the API more frequently # no point in polling the API more frequently
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=300) MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=300)
CONFIG_SCHEMA = vol.Schema({
DOMAIN: vol.Schema({
vol.Required(CONF_API_KEY): cv.string,
}),
}, extra=vol.ALLOW_EXTRA)
# pylint: disable=unused-argument,too-few-public-methods # pylint: disable=unused-argument,too-few-public-methods
def setup(hass, config): def setup(hass, config):
"""Setup BloomSky component.""" """Setup BloomSky component."""
if not validate_config(
config,
{DOMAIN: [CONF_API_KEY]},
_LOGGER):
return False
api_key = config[DOMAIN][CONF_API_KEY] api_key = config[DOMAIN][CONF_API_KEY]
global BLOOMSKY global BLOOMSKY
@ -40,7 +44,7 @@ def setup(hass, config):
except RuntimeError: except RuntimeError:
return False return False
for component in 'camera', 'binary_sensor', 'sensor': for component in BLOOMSKY_TYPE:
discovery.load_platform(hass, component, DOMAIN, {}, config) discovery.load_platform(hass, component, DOMAIN, {}, config)
return True return True
@ -50,19 +54,19 @@ class BloomSky(object):
"""Handle all communication with the BloomSky API.""" """Handle all communication with the BloomSky API."""
# API documentation at http://weatherlution.com/bloomsky-api/ # API documentation at http://weatherlution.com/bloomsky-api/
API_URL = "https://api.bloomsky.com/api/skydata" API_URL = 'https://api.bloomsky.com/api/skydata'
def __init__(self, api_key): def __init__(self, api_key):
"""Initialize the BookSky.""" """Initialize the BookSky."""
self._api_key = api_key self._api_key = api_key
self.devices = {} self.devices = {}
_LOGGER.debug("Initial bloomsky device load...") _LOGGER.debug("Initial BloomSky device load...")
self.refresh_devices() self.refresh_devices()
@Throttle(MIN_TIME_BETWEEN_UPDATES) @Throttle(MIN_TIME_BETWEEN_UPDATES)
def refresh_devices(self): def refresh_devices(self):
"""Use the API to retreive a list of devices.""" """Use the API to retreive a list of devices."""
_LOGGER.debug("Fetching bloomsky update") _LOGGER.debug("Fetching BloomSky update")
response = requests.get(self.API_URL, response = requests.get(self.API_URL,
headers={"Authorization": self._api_key}, headers={"Authorization": self._api_key},
timeout=10) timeout=10)
@ -73,5 +77,5 @@ class BloomSky(object):
return return
# Create dictionary keyed off of the device unique id # Create dictionary keyed off of the device unique id
self.devices.update({ self.devices.update({
device["DeviceID"]: device for device in response.json() device['DeviceID']: device for device in response.json()
}) })

View File

@ -6,58 +6,63 @@ https://home-assistant.io/components/sensor.bloomsky/
""" """
import logging import logging
from homeassistant.const import TEMP_FAHRENHEIT import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (TEMP_FAHRENHEIT, CONF_MONITORED_CONDITIONS)
from homeassistant.helpers.entity import Entity from homeassistant.helpers.entity import Entity
from homeassistant.loader import get_component from homeassistant.loader import get_component
import homeassistant.helpers.config_validation as cv
DEPENDENCIES = ["bloomsky"] _LOGGER = logging.getLogger(__name__)
DEPENDENCIES = ['bloomsky']
# These are the available sensors # These are the available sensors
SENSOR_TYPES = ["Temperature", SENSOR_TYPES = ['Temperature',
"Humidity", 'Humidity',
"Pressure", 'Pressure',
"Luminance", 'Luminance',
"UVIndex", 'UVIndex',
"Voltage"] 'Voltage']
# Sensor units - these do not currently align with the API documentation # Sensor units - these do not currently align with the API documentation
SENSOR_UNITS = {"Temperature": TEMP_FAHRENHEIT, SENSOR_UNITS = {'Temperature': TEMP_FAHRENHEIT,
"Humidity": "%", 'Humidity': '%',
"Pressure": "inHg", 'Pressure': 'inHg',
"Luminance": "cd/m²", 'Luminance': 'cd/m²',
"Voltage": "mV"} 'Voltage': 'mV'}
# Which sensors to format numerically # Which sensors to format numerically
FORMAT_NUMBERS = ["Temperature", "Pressure", "Voltage"] FORMAT_NUMBERS = ['Temperature', 'Pressure', 'Voltage']
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_MONITORED_CONDITIONS, default=SENSOR_TYPES):
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
})
# pylint: disable=unused-argument # pylint: disable=unused-argument
def setup_platform(hass, config, add_devices, discovery_info=None): def setup_platform(hass, config, add_devices, discovery_info=None):
"""Setup the available BloomSky weather sensors.""" """Setup the available BloomSky weather sensors."""
logger = logging.getLogger(__name__)
bloomsky = get_component('bloomsky') bloomsky = get_component('bloomsky')
sensors = config.get('monitored_conditions', SENSOR_TYPES) sensors = config.get(CONF_MONITORED_CONDITIONS)
for device in bloomsky.BLOOMSKY.devices.values(): for device in bloomsky.BLOOMSKY.devices.values():
for variable in sensors: for variable in sensors:
if variable in SENSOR_TYPES: add_devices([BloomSkySensor(bloomsky.BLOOMSKY, device, variable)])
add_devices([BloomSkySensor(bloomsky.BLOOMSKY,
device,
variable)])
else:
logger.error("Cannot find definition for device: %s", variable)
class BloomSkySensor(Entity): class BloomSkySensor(Entity):
"""Representation of a single sensor in a BloomSky device.""" """Representation of a single sensor in a BloomSky device."""
def __init__(self, bs, device, sensor_name): def __init__(self, bs, device, sensor_name):
"""Initialize a bloomsky sensor.""" """Initialize a BloomSky sensor."""
self._bloomsky = bs self._bloomsky = bs
self._device_id = device["DeviceID"] self._device_id = device['DeviceID']
self._sensor_name = sensor_name self._sensor_name = sensor_name
self._name = "{} {}".format(device["DeviceName"], sensor_name) self._name = '{} {}'.format(device['DeviceName'], sensor_name)
self._unique_id = "bloomsky_sensor {}".format(self._name) self._unique_id = 'bloomsky_sensor {}'.format(self._name)
self.update() self.update()
@property @property
@ -85,9 +90,9 @@ class BloomSkySensor(Entity):
self._bloomsky.refresh_devices() self._bloomsky.refresh_devices()
state = \ state = \
self._bloomsky.devices[self._device_id]["Data"][self._sensor_name] self._bloomsky.devices[self._device_id]['Data'][self._sensor_name]
if self._sensor_name in FORMAT_NUMBERS: if self._sensor_name in FORMAT_NUMBERS:
self._state = "{0:.2f}".format(state) self._state = '{0:.2f}'.format(state)
else: else:
self._state = state self._state = state