116 lines
3.6 KiB
Python
116 lines
3.6 KiB
Python
"""
|
|
Support for openexchangerates.org exchange rates service.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.openexchangerates/
|
|
"""
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (CONF_API_KEY, CONF_NAME, CONF_PAYLOAD)
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.util import Throttle
|
|
|
|
_RESOURCE = 'https://openexchangerates.org/api/latest.json'
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_BASE = 'base'
|
|
CONF_QUOTE = 'quote'
|
|
|
|
DEFAULT_NAME = 'Exchange Rate Sensor'
|
|
DEFAULT_BASE = 'USD'
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_API_KEY): cv.string,
|
|
vol.Required(CONF_QUOTE): cv.string,
|
|
vol.Optional(CONF_BASE, default=DEFAULT_BASE): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
})
|
|
|
|
# Return cached results if last scan was less then this time ago.
|
|
MIN_TIME_BETWEEN_UPDATES = timedelta(hours=2)
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Setup the Open Exchange Rates sensor."""
|
|
name = config.get(CONF_NAME)
|
|
api_key = config.get(CONF_API_KEY)
|
|
base = config.get(CONF_BASE)
|
|
quote = config.get(CONF_QUOTE)
|
|
payload = config.get(CONF_PAYLOAD)
|
|
|
|
rest = OpenexchangeratesData(_RESOURCE, api_key, base, quote, payload)
|
|
response = requests.get(_RESOURCE, params={'base': base,
|
|
'app_id': api_key},
|
|
timeout=10)
|
|
if response.status_code != 200:
|
|
_LOGGER.error("Check your OpenExchangeRates API key")
|
|
return False
|
|
rest.update()
|
|
add_devices([OpenexchangeratesSensor(rest, name, quote)])
|
|
|
|
|
|
class OpenexchangeratesSensor(Entity):
|
|
"""Representation of an Open Exchange Rates sensor."""
|
|
|
|
def __init__(self, rest, name, quote):
|
|
"""Initialize the sensor."""
|
|
self.rest = rest
|
|
self._name = name
|
|
self._quote = quote
|
|
self.update()
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return other attributes of the sensor."""
|
|
return self.rest.data
|
|
|
|
def update(self):
|
|
"""Update current conditions."""
|
|
self.rest.update()
|
|
value = self.rest.data
|
|
self._state = round(value[str(self._quote)], 4)
|
|
|
|
|
|
# pylint: disable=too-few-public-methods
|
|
class OpenexchangeratesData(object):
|
|
"""Get data from Openexchangerates.org."""
|
|
|
|
# pylint: disable=too-many-arguments
|
|
def __init__(self, resource, api_key, base, quote, data):
|
|
"""Initialize the data object."""
|
|
self._resource = resource
|
|
self._api_key = api_key
|
|
self._base = base
|
|
self._quote = quote
|
|
self.data = None
|
|
|
|
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
|
def update(self):
|
|
"""Get the latest data from openexchangerates.org."""
|
|
try:
|
|
result = requests.get(self._resource, params={'base': self._base,
|
|
'app_id':
|
|
self._api_key},
|
|
timeout=10)
|
|
self.data = result.json()['rates']
|
|
except requests.exceptions.HTTPError:
|
|
_LOGGER.error("Check the Openexchangerates API Key")
|
|
self.data = None
|
|
return False
|