mirror of
https://github.com/home-assistant/core.git
synced 2025-11-08 10:29:27 +00:00
256 lines
8.4 KiB
Python
256 lines
8.4 KiB
Python
"""SFR Box sensor platform."""
|
|
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import TYPE_CHECKING
|
|
|
|
from sfrbox_api.models import DslInfo, SystemInfo, WanInfo
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.const import (
|
|
SIGNAL_STRENGTH_DECIBELS,
|
|
EntityCategory,
|
|
UnitOfDataRate,
|
|
UnitOfElectricPotential,
|
|
UnitOfTemperature,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
from homeassistant.helpers.typing import StateType
|
|
|
|
from .coordinator import SFRConfigEntry
|
|
from .entity import SFRCoordinatorEntity
|
|
|
|
|
|
@dataclass(frozen=True, kw_only=True)
|
|
class SFRBoxSensorEntityDescription[_T](SensorEntityDescription):
|
|
"""Description for SFR Box sensors."""
|
|
|
|
value_fn: Callable[[_T], StateType]
|
|
|
|
|
|
DSL_SENSOR_TYPES: tuple[SFRBoxSensorEntityDescription[DslInfo], ...] = (
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="linemode",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
translation_key="dsl_linemode",
|
|
value_fn=lambda x: x.linemode,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="counter",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
translation_key="dsl_counter",
|
|
value_fn=lambda x: x.counter,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="crc",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
translation_key="dsl_crc",
|
|
value_fn=lambda x: x.crc,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="noise_down",
|
|
device_class=SensorDeviceClass.SIGNAL_STRENGTH,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
translation_key="dsl_noise_down",
|
|
value_fn=lambda x: x.noise_down,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="noise_up",
|
|
device_class=SensorDeviceClass.SIGNAL_STRENGTH,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
translation_key="dsl_noise_up",
|
|
value_fn=lambda x: x.noise_up,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="attenuation_down",
|
|
device_class=SensorDeviceClass.SIGNAL_STRENGTH,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
translation_key="dsl_attenuation_down",
|
|
value_fn=lambda x: x.attenuation_down,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="attenuation_up",
|
|
device_class=SensorDeviceClass.SIGNAL_STRENGTH,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
translation_key="dsl_attenuation_up",
|
|
value_fn=lambda x: x.attenuation_up,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="rate_down",
|
|
device_class=SensorDeviceClass.DATA_RATE,
|
|
native_unit_of_measurement=UnitOfDataRate.KILOBITS_PER_SECOND,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
translation_key="dsl_rate_down",
|
|
value_fn=lambda x: x.rate_down,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="rate_up",
|
|
device_class=SensorDeviceClass.DATA_RATE,
|
|
native_unit_of_measurement=UnitOfDataRate.KILOBITS_PER_SECOND,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
translation_key="dsl_rate_up",
|
|
value_fn=lambda x: x.rate_up,
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="line_status",
|
|
device_class=SensorDeviceClass.ENUM,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
options=[
|
|
"no_defect",
|
|
"loss_of_frame",
|
|
"loss_of_signal",
|
|
"loss_of_power",
|
|
"loss_of_signal_quality",
|
|
"unknown",
|
|
],
|
|
translation_key="dsl_line_status",
|
|
value_fn=lambda x: _value_to_option(x.line_status),
|
|
),
|
|
SFRBoxSensorEntityDescription[DslInfo](
|
|
key="training",
|
|
device_class=SensorDeviceClass.ENUM,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
options=[
|
|
"idle",
|
|
"g_994_training",
|
|
"g_992_started",
|
|
"g_922_channel_analysis",
|
|
"g_992_message_exchange",
|
|
"g_993_started",
|
|
"g_993_channel_analysis",
|
|
"g_993_message_exchange",
|
|
"showtime",
|
|
"unknown",
|
|
],
|
|
translation_key="dsl_training",
|
|
value_fn=lambda x: _value_to_option(x.training),
|
|
),
|
|
)
|
|
SYSTEM_SENSOR_TYPES: tuple[SFRBoxSensorEntityDescription[SystemInfo], ...] = (
|
|
SFRBoxSensorEntityDescription[SystemInfo](
|
|
key="net_infra",
|
|
device_class=SensorDeviceClass.ENUM,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
options=[
|
|
"adsl",
|
|
"ftth",
|
|
"gprs",
|
|
"unknown",
|
|
],
|
|
translation_key="net_infra",
|
|
value_fn=lambda x: x.net_infra,
|
|
),
|
|
SFRBoxSensorEntityDescription[SystemInfo](
|
|
key="alimvoltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
native_unit_of_measurement=UnitOfElectricPotential.MILLIVOLT,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda x: x.alimvoltage,
|
|
),
|
|
SFRBoxSensorEntityDescription[SystemInfo](
|
|
key="temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
value_fn=lambda x: _get_temperature(x.temperature),
|
|
),
|
|
)
|
|
WAN_SENSOR_TYPES: tuple[SFRBoxSensorEntityDescription[WanInfo], ...] = (
|
|
SFRBoxSensorEntityDescription[WanInfo](
|
|
key="mode",
|
|
device_class=SensorDeviceClass.ENUM,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
options=[
|
|
"adsl_ppp",
|
|
"adsl_routed",
|
|
"ftth_routed",
|
|
"grps_ppp",
|
|
"unknown",
|
|
],
|
|
translation_key="wan_mode",
|
|
value_fn=lambda x: x.mode.replace("/", "_"),
|
|
),
|
|
)
|
|
|
|
|
|
def _value_to_option(value: str | None) -> str | None:
|
|
if value is None:
|
|
return value
|
|
return value.lower().replace(" ", "_").replace(".", "_")
|
|
|
|
|
|
def _get_temperature(value: float | None) -> float | None:
|
|
if value is None or value < 1000:
|
|
return value
|
|
return value / 1000
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: SFRConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the sensors."""
|
|
data = entry.runtime_data
|
|
system_info = data.system.data
|
|
if TYPE_CHECKING:
|
|
assert system_info is not None
|
|
|
|
entities: list[SFRBoxSensor] = [
|
|
SFRBoxSensor(data.system, description, system_info)
|
|
for description in SYSTEM_SENSOR_TYPES
|
|
]
|
|
entities.extend(
|
|
SFRBoxSensor(data.wan, description, system_info)
|
|
for description in WAN_SENSOR_TYPES
|
|
)
|
|
if system_info.net_infra == "adsl":
|
|
entities.extend(
|
|
SFRBoxSensor(data.dsl, description, system_info)
|
|
for description in DSL_SENSOR_TYPES
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
class SFRBoxSensor[_T](SFRCoordinatorEntity[_T], SensorEntity):
|
|
"""SFR Box sensor."""
|
|
|
|
entity_description: SFRBoxSensorEntityDescription[_T]
|
|
|
|
@property
|
|
def native_value(self) -> StateType:
|
|
"""Return the native value of the device."""
|
|
if self.coordinator.data is None:
|
|
return None
|
|
return self.entity_description.value_fn(self.coordinator.data)
|