mirror of
https://github.com/home-assistant/core.git
synced 2025-07-19 03:07:37 +00:00
Use EntityDescription - dovado (#54945)
This commit is contained in:
parent
a23f27a7a8
commit
1152330865
@ -1,10 +1,17 @@
|
||||
"""Support for sensors from the Dovado router."""
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from datetime import timedelta
|
||||
import re
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
||||
from homeassistant.components.sensor import (
|
||||
PLATFORM_SCHEMA,
|
||||
SensorEntity,
|
||||
SensorEntityDescription,
|
||||
)
|
||||
from homeassistant.const import CONF_SENSORS, DATA_GIGABYTES, PERCENTAGE
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
|
||||
@ -18,26 +25,59 @@ SENSOR_SIGNAL = "signal"
|
||||
SENSOR_NETWORK = "network"
|
||||
SENSOR_SMS_UNREAD = "sms"
|
||||
|
||||
SENSORS = {
|
||||
SENSOR_NETWORK: ("signal strength", "Network", None, "mdi:access-point-network"),
|
||||
SENSOR_SIGNAL: (
|
||||
"signal strength",
|
||||
"Signal Strength",
|
||||
PERCENTAGE,
|
||||
"mdi:signal",
|
||||
|
||||
@dataclass
|
||||
class DovadoRequiredKeysMixin:
|
||||
"""Mixin for required keys."""
|
||||
|
||||
identifier: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class DovadoSensorEntityDescription(SensorEntityDescription, DovadoRequiredKeysMixin):
|
||||
"""Describes Dovado sensor entity."""
|
||||
|
||||
|
||||
SENSOR_TYPES: tuple[DovadoSensorEntityDescription, ...] = (
|
||||
DovadoSensorEntityDescription(
|
||||
identifier=SENSOR_NETWORK,
|
||||
key="signal strength",
|
||||
name="Network",
|
||||
icon="mdi:access-point-network",
|
||||
),
|
||||
SENSOR_SMS_UNREAD: ("sms unread", "SMS unread", "", "mdi:message-text-outline"),
|
||||
SENSOR_UPLOAD: ("traffic modem tx", "Sent", DATA_GIGABYTES, "mdi:cloud-upload"),
|
||||
SENSOR_DOWNLOAD: (
|
||||
"traffic modem rx",
|
||||
"Received",
|
||||
DATA_GIGABYTES,
|
||||
"mdi:cloud-download",
|
||||
DovadoSensorEntityDescription(
|
||||
identifier=SENSOR_SIGNAL,
|
||||
key="signal strength",
|
||||
name="Signal Strength",
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
icon="mdi:signal",
|
||||
),
|
||||
}
|
||||
DovadoSensorEntityDescription(
|
||||
identifier=SENSOR_SMS_UNREAD,
|
||||
key="sms unread",
|
||||
name="SMS unread",
|
||||
icon="mdi:message-text-outline",
|
||||
),
|
||||
DovadoSensorEntityDescription(
|
||||
identifier=SENSOR_UPLOAD,
|
||||
key="traffic modem tx",
|
||||
name="Sent",
|
||||
native_unit_of_measurement=DATA_GIGABYTES,
|
||||
icon="mdi:cloud-upload",
|
||||
),
|
||||
DovadoSensorEntityDescription(
|
||||
identifier=SENSOR_DOWNLOAD,
|
||||
key="traffic modem rx",
|
||||
name="Received",
|
||||
native_unit_of_measurement=DATA_GIGABYTES,
|
||||
icon="mdi:cloud-download",
|
||||
),
|
||||
)
|
||||
|
||||
SENSOR_KEYS: list[str] = [desc.key for desc in SENSOR_TYPES]
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
||||
{vol.Required(CONF_SENSORS): vol.All(cv.ensure_list, [vol.In(SENSORS)])}
|
||||
{vol.Required(CONF_SENSORS): vol.All(cv.ensure_list, [vol.In(SENSOR_KEYS)])}
|
||||
)
|
||||
|
||||
|
||||
@ -45,63 +85,50 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
|
||||
"""Set up the Dovado sensor platform."""
|
||||
dovado = hass.data[DOVADO_DOMAIN]
|
||||
|
||||
entities = []
|
||||
for sensor in config[CONF_SENSORS]:
|
||||
entities.append(DovadoSensor(dovado, sensor))
|
||||
|
||||
sensors = config[CONF_SENSORS]
|
||||
entities = [
|
||||
DovadoSensor(dovado, description)
|
||||
for description in SENSOR_TYPES
|
||||
if description.key in sensors
|
||||
]
|
||||
add_entities(entities)
|
||||
|
||||
|
||||
class DovadoSensor(SensorEntity):
|
||||
"""Representation of a Dovado sensor."""
|
||||
|
||||
def __init__(self, data, sensor):
|
||||
entity_description: DovadoSensorEntityDescription
|
||||
|
||||
def __init__(self, data, description: DovadoSensorEntityDescription):
|
||||
"""Initialize the sensor."""
|
||||
self.entity_description = description
|
||||
self._data = data
|
||||
self._sensor = sensor
|
||||
self._state = self._compute_state()
|
||||
|
||||
self._attr_name = f"{data.name} {description.name}"
|
||||
self._attr_native_value = self._compute_state()
|
||||
|
||||
def _compute_state(self):
|
||||
"""Compute the state of the sensor."""
|
||||
state = self._data.state.get(SENSORS[self._sensor][0])
|
||||
if self._sensor == SENSOR_NETWORK:
|
||||
state = self._data.state.get(self.entity_description.key)
|
||||
sensor_identifier = self.entity_description.identifier
|
||||
if sensor_identifier == SENSOR_NETWORK:
|
||||
match = re.search(r"\((.+)\)", state)
|
||||
return match.group(1) if match else None
|
||||
if self._sensor == SENSOR_SIGNAL:
|
||||
if sensor_identifier == SENSOR_SIGNAL:
|
||||
try:
|
||||
return int(state.split()[0])
|
||||
except ValueError:
|
||||
return None
|
||||
if self._sensor == SENSOR_SMS_UNREAD:
|
||||
if sensor_identifier == SENSOR_SMS_UNREAD:
|
||||
return int(state)
|
||||
if self._sensor in [SENSOR_UPLOAD, SENSOR_DOWNLOAD]:
|
||||
if sensor_identifier in [SENSOR_UPLOAD, SENSOR_DOWNLOAD]:
|
||||
return round(float(state) / 1e6, 1)
|
||||
return state
|
||||
|
||||
def update(self):
|
||||
"""Update sensor values."""
|
||||
self._data.update()
|
||||
self._state = self._compute_state()
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of the sensor."""
|
||||
return f"{self._data.name} {SENSORS[self._sensor][1]}"
|
||||
|
||||
@property
|
||||
def native_value(self):
|
||||
"""Return the sensor state."""
|
||||
return self._state
|
||||
|
||||
@property
|
||||
def icon(self):
|
||||
"""Return the icon for the sensor."""
|
||||
return SENSORS[self._sensor][3]
|
||||
|
||||
@property
|
||||
def native_unit_of_measurement(self):
|
||||
"""Return the unit of measurement."""
|
||||
return SENSORS[self._sensor][2]
|
||||
self._attr_native_value = self._compute_state()
|
||||
|
||||
@property
|
||||
def extra_state_attributes(self):
|
||||
|
Loading…
x
Reference in New Issue
Block a user