""" Support for Yr.no weather service. For more details about this platform, please refer to the documentation at https://home-assistant.io/components/sensor.yr/ """ import asyncio import logging from random import randrange from xml.parsers.expat import ExpatError import aiohttp import async_timeout import voluptuous as vol import homeassistant.helpers.config_validation as cv from homeassistant.components.sensor import PLATFORM_SCHEMA from homeassistant.const import ( CONF_LATITUDE, CONF_LONGITUDE, CONF_ELEVATION, CONF_MONITORED_CONDITIONS, ATTR_ATTRIBUTION, CONF_NAME) from homeassistant.helpers.aiohttp_client import async_get_clientsession from homeassistant.helpers.entity import Entity from homeassistant.helpers.event import (async_track_utc_time_change, async_call_later) from homeassistant.util import dt as dt_util REQUIREMENTS = ['xmltodict==0.11.0'] _LOGGER = logging.getLogger(__name__) CONF_ATTRIBUTION = "Weather forecast from met.no, delivered " \ "by the Norwegian Meteorological Institute." # https://api.met.no/license_data.html SENSOR_TYPES = { 'symbol': ['Symbol', None], 'precipitation': ['Precipitation', 'mm'], 'temperature': ['Temperature', '°C'], 'windSpeed': ['Wind speed', 'm/s'], 'windGust': ['Wind gust', 'm/s'], 'pressure': ['Pressure', 'hPa'], 'windDirection': ['Wind direction', '°'], 'humidity': ['Humidity', '%'], 'fog': ['Fog', '%'], 'cloudiness': ['Cloudiness', '%'], 'lowClouds': ['Low clouds', '%'], 'mediumClouds': ['Medium clouds', '%'], 'highClouds': ['High clouds', '%'], 'dewpointTemperature': ['Dewpoint temperature', '°C'], } CONF_FORECAST = 'forecast' DEFAULT_FORECAST = 0 DEFAULT_NAME = 'yr' PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ vol.Optional(CONF_ELEVATION): vol.Coerce(int), vol.Optional(CONF_FORECAST, default=DEFAULT_FORECAST): vol.Coerce(int), vol.Optional(CONF_LATITUDE): cv.latitude, vol.Optional(CONF_LONGITUDE): cv.longitude, vol.Optional(CONF_MONITORED_CONDITIONS, default=['symbol']): vol.All(cv.ensure_list, vol.Length(min=1), [vol.In(SENSOR_TYPES)]), vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, }) @asyncio.coroutine def async_setup_platform(hass, config, async_add_devices, discovery_info=None): """Set up the Yr.no sensor.""" elevation = config.get(CONF_ELEVATION, hass.config.elevation or 0) forecast = config.get(CONF_FORECAST) latitude = config.get(CONF_LATITUDE, hass.config.latitude) longitude = config.get(CONF_LONGITUDE, hass.config.longitude) name = config.get(CONF_NAME) if None in (latitude, longitude): _LOGGER.error("Latitude or longitude not set in Home Assistant config") return False coordinates = { 'lat': str(latitude), 'lon': str(longitude), 'msl': str(elevation), } dev = [] for sensor_type in config[CONF_MONITORED_CONDITIONS]: dev.append(YrSensor(name, sensor_type)) async_add_devices(dev) weather = YrData(hass, coordinates, forecast, dev) async_track_utc_time_change(hass, weather.updating_devices, minute=31) yield from weather.fetching_data() class YrSensor(Entity): """Representation of an Yr.no sensor.""" def __init__(self, name, sensor_type): """Initialize the sensor.""" self.client_name = name self._name = SENSOR_TYPES[sensor_type][0] self.type = sensor_type self._state = None self._unit_of_measurement = SENSOR_TYPES[self.type][1] @property def name(self): """Return the name of the sensor.""" return '{} {}'.format(self.client_name, self._name) @property def state(self): """Return the state of the device.""" return self._state @property def should_poll(self): """No polling needed.""" return False @property def entity_picture(self): """Weather symbol if type is symbol.""" if self.type != 'symbol': return None return "https://api.met.no/weatherapi/weathericon/1.1/" \ "?symbol={0};content_type=image/png".format(self._state) @property def device_state_attributes(self): """Return the state attributes.""" return { ATTR_ATTRIBUTION: CONF_ATTRIBUTION, } @property def unit_of_measurement(self): """Return the unit of measurement of this entity, if any.""" return self._unit_of_measurement class YrData: """Get the latest data and updates the states.""" def __init__(self, hass, coordinates, forecast, devices): """Initialize the data object.""" self._url = 'https://aa015h6buqvih86i1.api.met.no/'\ 'weatherapi/locationforecast/1.9/' self._urlparams = coordinates self._forecast = forecast self.devices = devices self.data = {} self.hass = hass @asyncio.coroutine def fetching_data(self, *_): """Get the latest data from yr.no.""" import xmltodict def try_again(err: str): """Retry in 15 to 20 minutes.""" minutes = 15 + randrange(6) _LOGGER.error("Retrying in %i minutes: %s", minutes, err) async_call_later(self.hass, minutes*60, self.fetching_data) try: websession = async_get_clientsession(self.hass) with async_timeout.timeout(10, loop=self.hass.loop): resp = yield from websession.get( self._url, params=self._urlparams) if resp.status != 200: try_again('{} returned {}'.format(resp.url, resp.status)) return text = yield from resp.text() except (asyncio.TimeoutError, aiohttp.ClientError) as err: try_again(err) return try: self.data = xmltodict.parse(text)['weatherdata'] except (ExpatError, IndexError) as err: try_again(err) return yield from self.updating_devices() async_call_later(self.hass, 60*60, self.fetching_data) @asyncio.coroutine def updating_devices(self, *_): """Find the current data from self.data.""" if not self.data: return now = dt_util.utcnow() forecast_time = now + dt_util.dt.timedelta(hours=self._forecast) # Find the correct time entry. Since not all time entries contain all # types of data, we cannot just select one. Instead, we order them by # distance from the desired forecast_time, and for every device iterate # them in order of increasing distance, taking the first time_point # that contains the desired data. ordered_entries = [] for time_entry in self.data['product']['time']: valid_from = dt_util.parse_datetime(time_entry['@from']) valid_to = dt_util.parse_datetime(time_entry['@to']) if now >= valid_to: # Has already passed. Never select this. continue average_dist = (abs((valid_to - forecast_time).total_seconds()) + abs((valid_from - forecast_time).total_seconds())) ordered_entries.append((average_dist, time_entry)) ordered_entries.sort(key=lambda item: item[0]) # Update all devices tasks = [] if ordered_entries: for dev in self.devices: new_state = None for (_, selected_time_entry) in ordered_entries: loc_data = selected_time_entry['location'] if dev.type not in loc_data: continue if dev.type == 'precipitation': new_state = loc_data[dev.type]['@value'] elif dev.type == 'symbol': new_state = loc_data[dev.type]['@number'] elif dev.type in ('temperature', 'pressure', 'humidity', 'dewpointTemperature'): new_state = loc_data[dev.type]['@value'] elif dev.type in ('windSpeed', 'windGust'): new_state = loc_data[dev.type]['@mps'] elif dev.type == 'windDirection': new_state = float(loc_data[dev.type]['@deg']) elif dev.type in ('fog', 'cloudiness', 'lowClouds', 'mediumClouds', 'highClouds'): new_state = loc_data[dev.type]['@percent'] break # pylint: disable=protected-access if new_state != dev._state: dev._state = new_state tasks.append(dev.async_update_ha_state()) if tasks: yield from asyncio.wait(tasks, loop=self.hass.loop)