sensor.py

Go to the documentation of this file.

"""Support for Västtrafik public transport."""
 
from __future__ import annotations
 
from datetime import datetime, timedelta
import logging
 
import vasttrafik
import voluptuous as vol
 
from homeassistant.components.sensor import (
    PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
    SensorEntity,
)
from homeassistant.const import CONF_DELAY, 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
from homeassistant.util import Throttle
from homeassistant.util.dt import now
 
_LOGGER = logging.getLogger(__name__)
 
ATTR_ACCESSIBILITY = "accessibility"
ATTR_DIRECTION = "direction"
ATTR_LINE = "line"
ATTR_TRACK = "track"
ATTR_FROM = "from"
ATTR_TO = "to"
ATTR_DELAY = "delay"
 
CONF_DEPARTURES = "departures"
CONF_FROM = "from"
CONF_HEADING = "heading"
CONF_LINES = "lines"
CONF_KEY = "key"
CONF_SECRET = "secret"
 
DEFAULT_DELAY = 0
 
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=120)
 
PLATFORM_SCHEMA = SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_KEY): cv.string,
        vol.Required(CONF_SECRET): cv.string,
        vol.Required(CONF_DEPARTURES): [
            {
                vol.Required(CONF_FROM): cv.string,
                vol.Optional(CONF_DELAY, default=DEFAULT_DELAY): cv.positive_int,
                vol.Optional(CONF_HEADING): cv.string,
                vol.Optional(CONF_LINES, default=[]): vol.All(
                    cv.ensure_list, [cv.string]
                ),
                vol.Optional(CONF_NAME): cv.string,
            }
        ],
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the departure sensor."""
    planner = vasttrafik.JournyPlanner(config.get(CONF_KEY), config.get(CONF_SECRET))
    add_entities(
        (
            VasttrafikDepartureSensor(
                planner,
                departure.get(CONF_NAME),
                departure.get(CONF_FROM),
                departure.get(CONF_HEADING),
                departure.get(CONF_LINES),
                departure.get(CONF_DELAY),
            )
            for departure in config[CONF_DEPARTURES]
        ),
        True,
    )
 
 
class VasttrafikDepartureSensor(SensorEntity):
    """Implementation of a Vasttrafik Departure Sensor."""
 
    _attr_attribution = "Data provided by Västtrafik"
    _attr_icon = "mdi:train"
 
    def __init__(self, planner, name, departure, heading, lines, delay):
        """Initialize the sensor."""
        self._planner_planner = planner
        self._name_name = name or departure
        self._departure_departure = self.get_station_idget_station_id(departure)
        self._heading_heading = self.get_station_idget_station_id(heading) if heading else None
        self._lines_lines = lines if lines else None
        self._delay_delay = timedelta(minutes=delay)
        self._departureboard_departureboard = None
        self._state_state = None
        self._attributes_attributes = None
 
    def get_station_id(self, location):
        """Get the station ID."""
        if location.isdecimal():
            station_info = {"station_name": location, "station_id": location}
        else:
            station_id = self._planner_planner.location_name(location)[0]["gid"]
            station_info = {"station_name": location, "station_id": station_id}
        return station_info
 
    @property
    def name(self):
        """Return the name of the sensor."""
        return self._name_name
 
    @property
    def extra_state_attributes(self):
        """Return the state attributes."""
        return self._attributes_attributes
 
    @property
    def native_value(self):
        """Return the next departure time."""
        return self._state_state
 
    @Throttle(MIN_TIME_BETWEEN_UPDATES)
    def update(self) -> None:
        """Get the departure board."""
        try:
            self._departureboard_departureboard = self._planner_planner.departureboard(
                self._departure_departure["station_id"],
                direction=self._heading_heading["station_id"] if self._heading_heading else None,
                date=now() + self._delay_delay,
            )
        except vasttrafik.Error:
            _LOGGER.debug("Unable to read departure board, updating token")
            self._planner_planner.update_token()
 
        if not self._departureboard_departureboard:
            _LOGGER.debug(
                "No departures from departure station %s to destination station %s",
                self._departure_departure["station_name"],
                self._heading_heading["station_name"] if self._heading_heading else "ANY",
            )
            self._state_state = None
            self._attributes_attributes = {}
        else:
            for departure in self._departureboard_departureboard:
                service_journey = departure.get("serviceJourney", {})
                line = service_journey.get("line", {})
 
                if departure.get("isCancelled"):
                    continue
                if not self._lines_lines or line.get("shortName") in self._lines_lines:
                    if "estimatedOtherwisePlannedTime" in departure:
                        try:
                            self._state_state = datetime.fromisoformat(
                                departure["estimatedOtherwisePlannedTime"]
                            ).strftime("%H:%M")
                        except ValueError:
                            self._state_state = departure["estimatedOtherwisePlannedTime"]
                    else:
                        self._state_state = None
 
                    stop_point = departure.get("stopPoint", {})
 
                    params = {
                        ATTR_ACCESSIBILITY: "wheelChair"
                        if line.get("isWheelchairAccessible")
                        else None,
                        ATTR_DIRECTION: service_journey.get("direction"),
                        ATTR_LINE: line.get("shortName"),
                        ATTR_TRACK: stop_point.get("platform"),
                        ATTR_FROM: stop_point.get("name"),
                        ATTR_TO: self._heading_heading["station_name"]
                        if self._heading_heading
                        else "ANY",
                        ATTR_DELAY: self._delay_delay.seconds // 60 % 60,
                    }
 
                    self._attributes_attributes = {k: v for k, v in params.items() if v}
                    break