mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
113 lines
3.4 KiB
Python
113 lines
3.4 KiB
Python
"""Support for currencylayer.com exchange rates service."""
|
|
from __future__ import annotations
|
|
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
|
from homeassistant.const import CONF_API_KEY, CONF_BASE, CONF_NAME, CONF_QUOTE
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
_RESOURCE = "http://apilayer.net/api/live"
|
|
|
|
DEFAULT_BASE = "USD"
|
|
DEFAULT_NAME = "CurrencyLayer Sensor"
|
|
|
|
|
|
SCAN_INTERVAL = timedelta(hours=4)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_API_KEY): cv.string,
|
|
vol.Required(CONF_QUOTE): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(CONF_BASE, default=DEFAULT_BASE): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
def setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the Currencylayer sensor."""
|
|
base = config[CONF_BASE]
|
|
api_key = config[CONF_API_KEY]
|
|
parameters = {"source": base, "access_key": api_key, "format": 1}
|
|
|
|
rest = CurrencylayerData(_RESOURCE, parameters)
|
|
|
|
response = requests.get(_RESOURCE, params=parameters, timeout=10)
|
|
sensors = []
|
|
for variable in config[CONF_QUOTE]:
|
|
sensors.append(CurrencylayerSensor(rest, base, variable))
|
|
if "error" in response.json():
|
|
return
|
|
add_entities(sensors, True)
|
|
|
|
|
|
class CurrencylayerSensor(SensorEntity):
|
|
"""Implementing the Currencylayer sensor."""
|
|
|
|
_attr_attribution = "Data provided by currencylayer.com"
|
|
_attr_icon = "mdi:currency"
|
|
|
|
def __init__(self, rest, base, quote):
|
|
"""Initialize the sensor."""
|
|
self.rest = rest
|
|
self._quote = quote
|
|
self._base = base
|
|
self._state = None
|
|
|
|
@property
|
|
def native_unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity, if any."""
|
|
return self._quote
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._base
|
|
|
|
@property
|
|
def native_value(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
def update(self) -> None:
|
|
"""Update current date."""
|
|
self.rest.update()
|
|
if (value := self.rest.data) is not None:
|
|
self._state = round(value[f"{self._base}{self._quote}"], 4)
|
|
|
|
|
|
class CurrencylayerData:
|
|
"""Get data from Currencylayer.org."""
|
|
|
|
def __init__(self, resource, parameters):
|
|
"""Initialize the data object."""
|
|
self._resource = resource
|
|
self._parameters = parameters
|
|
self.data = None
|
|
|
|
def update(self):
|
|
"""Get the latest data from Currencylayer."""
|
|
try:
|
|
result = requests.get(self._resource, params=self._parameters, timeout=10)
|
|
if "error" in result.json():
|
|
raise ValueError(result.json()["error"]["info"])
|
|
self.data = result.json()["quotes"]
|
|
_LOGGER.debug("Currencylayer data updated: %s", result.json()["timestamp"])
|
|
except ValueError as err:
|
|
_LOGGER.error("Check Currencylayer API %s", err.args)
|
|
self.data = None
|