From 19a20b3b130a5a8bb6f1725b67beb501b8d0bde3 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 7 Oct 2017 15:11:41 +0200 Subject: [PATCH] Move 'show_on_map' to const (#9727) --- homeassistant/components/binary_sensor/iss.py | 5 +- homeassistant/components/sensor/airvisual.py | 147 ++++++------------ homeassistant/const.py | 1 + 3 files changed, 52 insertions(+), 101 deletions(-) diff --git a/homeassistant/components/binary_sensor/iss.py b/homeassistant/components/binary_sensor/iss.py index 3b927853c00..d35c36a012e 100644 --- a/homeassistant/components/binary_sensor/iss.py +++ b/homeassistant/components/binary_sensor/iss.py @@ -13,7 +13,8 @@ import voluptuous as vol import homeassistant.helpers.config_validation as cv from homeassistant.components.binary_sensor import ( BinarySensorDevice, PLATFORM_SCHEMA) -from homeassistant.const import (CONF_NAME, ATTR_LONGITUDE, ATTR_LATITUDE) +from homeassistant.const import ( + CONF_NAME, ATTR_LONGITUDE, ATTR_LATITUDE, CONF_SHOW_ON_MAP) from homeassistant.util import Throttle REQUIREMENTS = ['pyiss==1.0.1'] @@ -23,8 +24,6 @@ _LOGGER = logging.getLogger(__name__) ATTR_ISS_NEXT_RISE = 'next_rise' ATTR_ISS_NUMBER_PEOPLE_SPACE = 'number_of_people_in_space' -CONF_SHOW_ON_MAP = 'show_on_map' - DEFAULT_NAME = 'ISS' DEFAULT_DEVICE_CLASS = 'visible' diff --git a/homeassistant/components/sensor/airvisual.py b/homeassistant/components/sensor/airvisual.py index 5fee3529eb3..10b57749741 100644 --- a/homeassistant/components/sensor/airvisual.py +++ b/homeassistant/components/sensor/airvisual.py @@ -4,7 +4,6 @@ Support for AirVisual air quality sensors. For more details about this platform, please refer to the documentation at https://home-assistant.io/components/sensor.airvisual/ """ - import asyncio from logging import getLogger from datetime import timedelta @@ -15,13 +14,15 @@ import homeassistant.helpers.config_validation as cv from homeassistant.components.sensor import PLATFORM_SCHEMA from homeassistant.const import ( ATTR_ATTRIBUTION, ATTR_LATITUDE, ATTR_LONGITUDE, CONF_API_KEY, - CONF_LATITUDE, CONF_LONGITUDE, CONF_MONITORED_CONDITIONS, CONF_STATE) + CONF_LATITUDE, CONF_LONGITUDE, CONF_MONITORED_CONDITIONS, CONF_STATE, + CONF_SHOW_ON_MAP) from homeassistant.helpers.entity import Entity from homeassistant.util import Throttle -_LOGGER = getLogger(__name__) REQUIREMENTS = ['pyairvisual==1.0.0'] +_LOGGER = getLogger(__name__) + ATTR_CITY = 'city' ATTR_COUNTRY = 'country' ATTR_POLLUTANT_SYMBOL = 'pollutant_symbol' @@ -32,7 +33,7 @@ ATTR_TIMESTAMP = 'timestamp' CONF_CITY = 'city' CONF_COUNTRY = 'country' CONF_RADIUS = 'radius' -CONF_SHOW_ON_MAP = 'show_on_map' +CONF_ATTRIBUTION = "Data provided by AirVisual" MASS_PARTS_PER_MILLION = 'ppm' MASS_PARTS_PER_BILLION = 'ppb' @@ -40,56 +41,22 @@ VOLUME_MICROGRAMS_PER_CUBIC_METER = 'µg/m3' MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=10) -POLLUTANT_LEVEL_MAPPING = [{ - 'label': 'Good', - 'minimum': 0, - 'maximum': 50 -}, { - 'label': 'Moderate', - 'minimum': 51, - 'maximum': 100 -}, { - 'label': 'Unhealthy for Sensitive Groups', - 'minimum': 101, - 'maximum': 150 -}, { - 'label': 'Unhealthy', - 'minimum': 151, - 'maximum': 200 -}, { - 'label': 'Very Unhealthy', - 'minimum': 201, - 'maximum': 300 -}, { - 'label': 'Hazardous', - 'minimum': 301, - 'maximum': 10000 -}] +POLLUTANT_LEVEL_MAPPING = [ + {'label': 'Good', 'minimum': 0, 'maximum': 50}, + {'label': 'Moderate', 'minimum': 51, 'maximum': 100}, + {'label': 'Unhealthy for sensitive group', 'minimum': 101, 'maximum': 150}, + {'label': 'Unhealthy', 'minimum': 151, 'maximum': 200}, + {'label': 'Very Unhealthy', 'minimum': 201, 'maximum': 300}, + {'label': 'Hazardous', 'minimum': 301, 'maximum': 10000} +] + POLLUTANT_MAPPING = { - 'co': { - 'label': 'Carbon Monoxide', - 'unit': MASS_PARTS_PER_MILLION - }, - 'n2': { - 'label': 'Nitrogen Dioxide', - 'unit': MASS_PARTS_PER_BILLION - }, - 'o3': { - 'label': 'Ozone', - 'unit': MASS_PARTS_PER_BILLION - }, - 'p1': { - 'label': 'PM10', - 'unit': VOLUME_MICROGRAMS_PER_CUBIC_METER - }, - 'p2': { - 'label': 'PM2.5', - 'unit': VOLUME_MICROGRAMS_PER_CUBIC_METER - }, - 's2': { - 'label': 'Sulfur Dioxide', - 'unit': MASS_PARTS_PER_BILLION - } + 'co': {'label': 'Carbon Monoxide', 'unit': MASS_PARTS_PER_MILLION}, + 'n2': {'label': 'Nitrogen Dioxide', 'unit': MASS_PARTS_PER_BILLION}, + 'o3': {'label': 'Ozone', 'unit': MASS_PARTS_PER_BILLION}, + 'p1': {'label': 'PM10', 'unit': VOLUME_MICROGRAMS_PER_CUBIC_METER}, + 'p2': {'label': 'PM2.5', 'unit': VOLUME_MICROGRAMS_PER_CUBIC_METER}, + 's2': {'label': 'Sulfur Dioxide', 'unit': MASS_PARTS_PER_BILLION}, } SENSOR_LOCALES = {'cn': 'Chinese', 'us': 'U.S.'} @@ -100,24 +67,16 @@ SENSOR_TYPES = [ ] PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ - vol.Required(CONF_API_KEY): - cv.string, + vol.Required(CONF_API_KEY): cv.string, vol.Required(CONF_MONITORED_CONDITIONS): - vol.All(cv.ensure_list, [vol.In(SENSOR_LOCALES)]), - vol.Optional(CONF_LATITUDE): - cv.latitude, - vol.Optional(CONF_LONGITUDE): - cv.longitude, - vol.Optional(CONF_RADIUS, default=1000): - cv.positive_int, - vol.Optional(CONF_CITY): - cv.string, - vol.Optional(CONF_STATE): - cv.string, - vol.Optional(CONF_COUNTRY): - cv.string, - vol.Optional(CONF_SHOW_ON_MAP, default=True): - cv.boolean + vol.All(cv.ensure_list, [vol.In(SENSOR_LOCALES)]), + vol.Optional(CONF_CITY): cv.string, + vol.Optional(CONF_COUNTRY): cv.string, + vol.Optional(CONF_LATITUDE): cv.latitude, + vol.Optional(CONF_LONGITUDE): cv.longitude, + vol.Optional(CONF_RADIUS, default=1000): cv.positive_int, + vol.Optional(CONF_SHOW_ON_MAP, default=True): cv.boolean, + vol.Optional(CONF_STATE): cv.string, }) @@ -126,8 +85,6 @@ def async_setup_platform(hass, config, async_add_devices, discovery_info=None): """Configure the platform and add the sensors.""" import pyairvisual as pav - _LOGGER.debug('Received configuration: %s', config) - api_key = config.get(CONF_API_KEY) monitored_locales = config.get(CONF_MONITORED_CONDITIONS) latitude = config.get(CONF_LATITUDE, hass.config.latitude) @@ -139,23 +96,17 @@ def async_setup_platform(hass, config, async_add_devices, discovery_info=None): show_on_map = config.get(CONF_SHOW_ON_MAP) if city and state and country: - _LOGGER.debug('Using city, state, and country: %s, %s, %s', city, - state, country) + _LOGGER.debug( + "Using city, state, and country: %s, %s, %s", city, state, country) data = AirVisualData( - pav.Client(api_key), - city=city, - state=state, - country=country, + pav.Client(api_key), city=city, state=state, country=country, show_on_map=show_on_map) else: - _LOGGER.debug('Using latitude and longitude: %s, %s', latitude, - longitude) + _LOGGER.debug( + "Using latitude and longitude: %s, %s", latitude, longitude) data = AirVisualData( - pav.Client(api_key), - latitude=latitude, - longitude=longitude, - radius=radius, - show_on_map=show_on_map) + pav.Client(api_key), latitude=latitude, longitude=longitude, + radius=radius, show_on_map=show_on_map) sensors = [] for locale in monitored_locales: @@ -176,7 +127,7 @@ class AirVisualBaseSensor(Entity): """Define a base class for all of our sensors.""" def __init__(self, data, name, icon, locale): - """Initialize.""" + """Initialize the sensor.""" self._data = data self._icon = icon self._locale = locale @@ -186,9 +137,9 @@ class AirVisualBaseSensor(Entity): @property def device_state_attributes(self): - """Return the state attributes.""" + """Return the device state attributes.""" attrs = { - ATTR_ATTRIBUTION: '©AirVisual', + ATTR_ATTRIBUTION: CONF_ATTRIBUTION, ATTR_CITY: self._data.city, ATTR_COUNTRY: self._data.country, ATTR_REGION: self._data.state, @@ -222,7 +173,7 @@ class AirVisualBaseSensor(Entity): @asyncio.coroutine def async_update(self): """Update the status of the sensor.""" - _LOGGER.debug('Updating sensor: %s', self._name) + _LOGGER.debug("Updating sensor: %s", self._name) self._data.update() @@ -267,14 +218,14 @@ class MainPollutantSensor(AirVisualBaseSensor): """Define a sensor to the main pollutant of an area.""" def __init__(self, data, name, icon, locale): - """Initialize.""" + """Initialize the sensor.""" super().__init__(data, name, icon, locale) self._symbol = None self._unit = None @property def device_state_attributes(self): - """Return the state attributes.""" + """Return the device state attributes.""" return merge_two_dicts(super().device_state_attributes, { ATTR_POLLUTANT_SYMBOL: self._symbol, ATTR_POLLUTANT_UNIT: self._unit @@ -295,7 +246,7 @@ class AirVisualData(object): """Define an object to hold sensor data.""" def __init__(self, client, **kwargs): - """Initialize.""" + """Initialize the AirVisual data element.""" self._client = client self.pollution_info = None @@ -316,12 +267,12 @@ class AirVisualData(object): try: if self.city and self.state and self.country: - resp = self._client.city(self.city, self.state, - self.country).get('data') + resp = self._client.city( + self.city, self.state, self.country).get('data') else: - resp = self._client.nearest_city(self.latitude, self.longitude, - self._radius).get('data') - _LOGGER.debug('New data retrieved: %s', resp) + resp = self._client.nearest_city( + self.latitude, self.longitude, self._radius).get('data') + _LOGGER.debug("New data retrieved: %s", resp) self.city = resp.get('city') self.state = resp.get('state') @@ -330,7 +281,7 @@ class AirVisualData(object): 'coordinates') self.pollution_info = resp.get('current', {}).get('pollution', {}) except exceptions.HTTPError as exc_info: - _LOGGER.error('Unable to retrieve data on this location: %s', + _LOGGER.error("Unable to retrieve data on this location: %s", self.__dict__) _LOGGER.debug(exc_info) self.pollution_info = {} diff --git a/homeassistant/const.py b/homeassistant/const.py index 01a28493e5e..41af2ab68dc 100644 --- a/homeassistant/const.py +++ b/homeassistant/const.py @@ -144,6 +144,7 @@ CONF_SCAN_INTERVAL = 'scan_interval' CONF_SENDER = 'sender' CONF_SENSOR_TYPE = 'sensor_type' CONF_SENSORS = 'sensors' +CONF_SHOW_ON_MAP = 'show_on_map' CONF_SLAVE = 'slave' CONF_SSL = 'ssl' CONF_STATE = 'state'