sensor.py

Go to the documentation of this file.

"""Support for the worldtides.info API."""
 
from __future__ import annotations
 
from datetime import timedelta
import logging
import time
 
import requests
import voluptuous as vol
 
from homeassistant.components.sensor import (
    PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
    SensorEntity,
)
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
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__)
 
ATTRIBUTION = "Data provided by WorldTides"
 
DEFAULT_NAME = "WorldTidesInfo"
 
SCAN_INTERVAL = timedelta(seconds=3600)
 
PLATFORM_SCHEMA = SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_API_KEY): cv.string,
        vol.Optional(CONF_LATITUDE): cv.latitude,
        vol.Optional(CONF_LONGITUDE): cv.longitude,
        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 WorldTidesInfo sensor."""
    name = config.get(CONF_NAME)
 
    lat = config.get(CONF_LATITUDE, hass.config.latitude)
    lon = config.get(CONF_LONGITUDE, hass.config.longitude)
    key = config.get(CONF_API_KEY)
 
    if None in (lat, lon):
        _LOGGER.error("Latitude or longitude not set in Home Assistant config")
 
    tides = WorldTidesInfoSensor(name, lat, lon, key)
    tides.update()
    if tides.data.get("error") == "No location found":
        _LOGGER.error("Location not available")
        return
 
    add_entities([tides])
 
 
class WorldTidesInfoSensor(SensorEntity):
    """Representation of a WorldTidesInfo sensor."""
 
    _attr_attribution = ATTRIBUTION
 
    def __init__(self, name, lat, lon, key):
        """Initialize the sensor."""
        self._name_name = name
        self._lat_lat = lat
        self._lon_lon = lon
        self._key_key = key
        self.datadata = None
 
    @property
    def name(self):
        """Return the name of the sensor."""
        return self._name_name
 
    @property
    def extra_state_attributes(self):
        """Return the state attributes of this device."""
        attr = {}
 
        if "High" in str(self.datadata["extremes"][0]["type"]):
            attr["high_tide_time_utc"] = self.datadata["extremes"][0]["date"]
            attr["high_tide_height"] = self.datadata["extremes"][0]["height"]
            attr["low_tide_time_utc"] = self.datadata["extremes"][1]["date"]
            attr["low_tide_height"] = self.datadata["extremes"][1]["height"]
        elif "Low" in str(self.datadata["extremes"][0]["type"]):
            attr["high_tide_time_utc"] = self.datadata["extremes"][1]["date"]
            attr["high_tide_height"] = self.datadata["extremes"][1]["height"]
            attr["low_tide_time_utc"] = self.datadata["extremes"][0]["date"]
            attr["low_tide_height"] = self.datadata["extremes"][0]["height"]
        return attr
 
    @property
    def native_value(self):
        """Return the state of the device."""
        if self.datadata:
            if "High" in str(self.datadata["extremes"][0]["type"]):
                tidetime = time.strftime(
                    "%I:%M %p", time.localtime(self.datadata["extremes"][0]["dt"])
                )
                return f"High tide at {tidetime}"
            if "Low" in str(self.datadata["extremes"][0]["type"]):
                tidetime = time.strftime(
                    "%I:%M %p", time.localtime(self.datadata["extremes"][0]["dt"])
                )
                return f"Low tide at {tidetime}"
            return None
        return None
 
    def update(self) -> None:
        """Get the latest data from WorldTidesInfo API."""
        start = int(time.time())
        resource = (
            "https://www.worldtides.info/api?extremes&length=86400"
            f"&key={self._key}&lat={self._lat}&lon={self._lon}&start={start}"
        )
 
        try:
            self.datadata = requests.get(resource, timeout=10).json()
            _LOGGER.debug("Data: %s", self.datadata)
            _LOGGER.debug("Tide data queried with start time set to: %s", start)
        except ValueError as err:
            _LOGGER.error("Error retrieving data from WorldTidesInfo: %s", err.args)
            self.datadata = None