mirror of
https://github.com/home-assistant/core.git
synced 2026-09-07 05:52:27 +01:00
132 lines
4.3 KiB
Python
132 lines
4.3 KiB
Python
"""Sensor for checking the status of London Underground tube lines."""
|
|
|
|
import logging
|
|
from typing import Any, override
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import (
|
|
PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
|
|
SensorEntity,
|
|
)
|
|
from homeassistant.config_entries import SOURCE_IMPORT
|
|
from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResultType
|
|
from homeassistant.helpers import config_validation as cv, issue_registry as ir
|
|
from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
|
|
from homeassistant.helpers.entity_platform import (
|
|
AddConfigEntryEntitiesCallback,
|
|
AddEntitiesCallback,
|
|
)
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .const import CONF_LINE, DOMAIN, TUBE_LINES
|
|
from .coordinator import LondonTubeCoordinator, LondonUndergroundConfigEntry
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM_SCHEMA = SENSOR_PLATFORM_SCHEMA.extend(
|
|
{vol.Required(CONF_LINE): vol.All(cv.ensure_list, [vol.In(list(TUBE_LINES))])}
|
|
)
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
async_add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the Tube sensor."""
|
|
|
|
# If configuration.yaml config exists, trigger the import flow.
|
|
# If the config entry already exists, this will not be
|
|
# triggered as only one config is allowed.
|
|
result = await hass.config_entries.flow.async_init(
|
|
DOMAIN, context={"source": SOURCE_IMPORT}, data=config
|
|
)
|
|
if (
|
|
result.get("type") is FlowResultType.ABORT
|
|
and result.get("reason") != "already_configured"
|
|
):
|
|
ir.async_create_issue(
|
|
hass,
|
|
DOMAIN,
|
|
f"deprecated_yaml_import_issue_{result.get('reason')}",
|
|
is_fixable=False,
|
|
issue_domain=DOMAIN,
|
|
severity=ir.IssueSeverity.WARNING,
|
|
translation_key="deprecated_yaml_import_issue",
|
|
translation_placeholders={
|
|
"domain": DOMAIN,
|
|
"integration_title": "London Underground",
|
|
},
|
|
)
|
|
return
|
|
|
|
ir.async_create_issue(
|
|
hass,
|
|
HOMEASSISTANT_DOMAIN,
|
|
"deprecated_yaml",
|
|
is_fixable=False,
|
|
issue_domain=DOMAIN,
|
|
severity=ir.IssueSeverity.WARNING,
|
|
translation_key="deprecated_yaml",
|
|
translation_placeholders={
|
|
"domain": DOMAIN,
|
|
"integration_title": "London Underground",
|
|
},
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: LondonUndergroundConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the London Underground sensor from config entry."""
|
|
|
|
async_add_entities(
|
|
LondonTubeSensor(entry.runtime_data, line) for line in entry.options[CONF_LINE]
|
|
)
|
|
|
|
|
|
class LondonTubeSensor(CoordinatorEntity[LondonTubeCoordinator], SensorEntity):
|
|
"""Sensor that reads the status of a line from Tube Data."""
|
|
|
|
_attr_attribution = "Powered by TfL Open Data"
|
|
_attr_icon = "mdi:subway"
|
|
_attr_has_entity_name = True # Use modern entity naming
|
|
|
|
def __init__(self, coordinator: LondonTubeCoordinator, name: str) -> None:
|
|
"""Initialize the London Underground sensor."""
|
|
super().__init__(coordinator)
|
|
self._name = name
|
|
# Add unique_id for proper entity registry
|
|
self._attr_unique_id = f"tube_{name.lower().replace(' ', '_')}"
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(DOMAIN, DOMAIN)},
|
|
name="London Underground",
|
|
manufacturer="Transport for London",
|
|
model="Tube Status",
|
|
entry_type=DeviceEntryType.SERVICE,
|
|
)
|
|
|
|
@property
|
|
@override
|
|
def name(self) -> str:
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
@override
|
|
def native_value(self) -> str:
|
|
"""Return the state of the sensor."""
|
|
return self.coordinator.data[self.name]["State"]
|
|
|
|
@property
|
|
@override
|
|
def extra_state_attributes(self) -> dict[str, Any]:
|
|
"""Return other details about the sensor state."""
|
|
return {"Description": self.coordinator.data[self.name]["Description"]}
|