evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use SensorEntityDescription in Nettigo Air Monitor (#53539)

Browse source
This commit is contained in:
Maciej Bieniek 2021-07-27 12:12:15 +02:00 • committed by GitHub
parent c0e84a7b32
commit ca020e1f87
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 166 additions and 215 deletions
Download patch file Download diff file Expand all files Collapse all files

317
homeassistant/components/nam/const.py
View file

@ -4,10 +4,11 @@ from __future__ import annotations
from datetime import timedelta from datetime import timedelta
from typing import Final from typing import Final
from homeassistant.components.sensor import ATTR_STATE_CLASS, STATE_CLASS_MEASUREMENT from homeassistant.components.sensor import (
STATE_CLASS_MEASUREMENT,
SensorEntityDescription,
)
from homeassistant.const import ( from homeassistant.const import (
ATTR_DEVICE_CLASS,
ATTR_ICON,
CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
CONCENTRATION_PARTS_PER_MILLION, CONCENTRATION_PARTS_PER_MILLION,
DEVICE_CLASS_CO2, DEVICE_CLASS_CO2,
@ -22,8 +23,6 @@ from homeassistant.const import (
TEMP_CELSIUS, TEMP_CELSIUS,
) )
from .model import SensorDescription
SUFFIX_P0: Final = "_p0" SUFFIX_P0: Final = "_p0"
SUFFIX_P1: Final = "_p1" SUFFIX_P1: Final = "_p1"
SUFFIX_P2: Final = "_p2" SUFFIX_P2: Final = "_p2"
@ -52,10 +51,6 @@ ATTR_SPS30_P2: Final = f"{ATTR_SPS30}{SUFFIX_P2}"
ATTR_SPS30_P4: Final = f"{ATTR_SPS30}{SUFFIX_P4}" ATTR_SPS30_P4: Final = f"{ATTR_SPS30}{SUFFIX_P4}"
ATTR_UPTIME: Final = "uptime" ATTR_UPTIME: Final = "uptime"
ATTR_ENABLED: Final = "enabled"
ATTR_LABEL: Final = "label"
ATTR_UNIT: Final = "unit"
DEFAULT_NAME: Final = "Nettigo Air Monitor" DEFAULT_NAME: Final = "Nettigo Air Monitor"
DEFAULT_UPDATE_INTERVAL: Final = timedelta(minutes=6) DEFAULT_UPDATE_INTERVAL: Final = timedelta(minutes=6)
DOMAIN: Final = "nam" DOMAIN: Final = "nam"
@ -66,165 +61,145 @@ MIGRATION_SENSORS: Final = [
("humidity", ATTR_DHT22_HUMIDITY), ("humidity", ATTR_DHT22_HUMIDITY),
] ]
SENSORS: Final[dict[str, SensorDescription]] = { SENSORS: Final[tuple[SensorEntityDescription, ...]] = (
ATTR_BME280_HUMIDITY: { SensorEntityDescription(
ATTR_LABEL: f"{DEFAULT_NAME} BME280 Humidity", key=ATTR_BME280_HUMIDITY,
ATTR_UNIT: PERCENTAGE, name=f"{DEFAULT_NAME} BME280 Humidity",
ATTR_DEVICE_CLASS: DEVICE_CLASS_HUMIDITY, unit_of_measurement=PERCENTAGE,
ATTR_ICON: None, device_class=DEVICE_CLASS_HUMIDITY,
ATTR_ENABLED: True, state_class=STATE_CLASS_MEASUREMENT,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, ),
}, SensorEntityDescription(
ATTR_BME280_PRESSURE: { key=ATTR_BME280_PRESSURE,
ATTR_LABEL: f"{DEFAULT_NAME} BME280 Pressure", name=f"{DEFAULT_NAME} BME280 Pressure",
ATTR_UNIT: PRESSURE_HPA, unit_of_measurement=PRESSURE_HPA,
ATTR_DEVICE_CLASS: DEVICE_CLASS_PRESSURE, device_class=DEVICE_CLASS_PRESSURE,
ATTR_ICON: None, state_class=STATE_CLASS_MEASUREMENT,
ATTR_ENABLED: True, ),
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, SensorEntityDescription(
}, key=ATTR_BME280_TEMPERATURE,
ATTR_BME280_TEMPERATURE: { name=f"{DEFAULT_NAME} BME280 Temperature",
ATTR_LABEL: f"{DEFAULT_NAME} BME280 Temperature", unit_of_measurement=TEMP_CELSIUS,
ATTR_UNIT: TEMP_CELSIUS, device_class=DEVICE_CLASS_TEMPERATURE,
ATTR_DEVICE_CLASS: DEVICE_CLASS_TEMPERATURE, state_class=STATE_CLASS_MEASUREMENT,
ATTR_ICON: None, ),
ATTR_ENABLED: True, SensorEntityDescription(
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, key=ATTR_BMP280_PRESSURE,
}, name=f"{DEFAULT_NAME} BMP280 Pressure",
ATTR_BMP280_PRESSURE: { unit_of_measurement=PRESSURE_HPA,
ATTR_LABEL: f"{DEFAULT_NAME} BMP280 Pressure", device_class=DEVICE_CLASS_PRESSURE,
ATTR_UNIT: PRESSURE_HPA, state_class=STATE_CLASS_MEASUREMENT,
ATTR_DEVICE_CLASS: DEVICE_CLASS_PRESSURE, ),
ATTR_ICON: None, SensorEntityDescription(
ATTR_ENABLED: True, key=ATTR_BMP280_TEMPERATURE,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, name=f"{DEFAULT_NAME} BMP280 Temperature",
}, unit_of_measurement=TEMP_CELSIUS,
ATTR_BMP280_TEMPERATURE: { device_class=DEVICE_CLASS_TEMPERATURE,
ATTR_LABEL: f"{DEFAULT_NAME} BMP280 Temperature", state_class=STATE_CLASS_MEASUREMENT,
ATTR_UNIT: TEMP_CELSIUS, ),
ATTR_DEVICE_CLASS: DEVICE_CLASS_TEMPERATURE, SensorEntityDescription(
ATTR_ICON: None, key=ATTR_HECA_HUMIDITY,
ATTR_ENABLED: True, name=f"{DEFAULT_NAME} HECA Humidity",
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, unit_of_measurement=PERCENTAGE,
}, device_class=DEVICE_CLASS_HUMIDITY,
ATTR_HECA_HUMIDITY: { state_class=STATE_CLASS_MEASUREMENT,
ATTR_LABEL: f"{DEFAULT_NAME} HECA Humidity", ),
ATTR_UNIT: PERCENTAGE, SensorEntityDescription(
ATTR_DEVICE_CLASS: DEVICE_CLASS_HUMIDITY, key=ATTR_HECA_TEMPERATURE,
ATTR_ICON: None, name=f"{DEFAULT_NAME} HECA Temperature",
ATTR_ENABLED: True, unit_of_measurement=TEMP_CELSIUS,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, device_class=DEVICE_CLASS_TEMPERATURE,
}, state_class=STATE_CLASS_MEASUREMENT,
ATTR_HECA_TEMPERATURE: { ),
ATTR_LABEL: f"{DEFAULT_NAME} HECA Temperature", SensorEntityDescription(
ATTR_UNIT: TEMP_CELSIUS, key=ATTR_MHZ14A_CARBON_DIOXIDE,
ATTR_DEVICE_CLASS: DEVICE_CLASS_TEMPERATURE, name=f"{DEFAULT_NAME} MH-Z14A Carbon Dioxide",
ATTR_ICON: None, unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
ATTR_ENABLED: True, device_class=DEVICE_CLASS_CO2,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, state_class=STATE_CLASS_MEASUREMENT,
}, ),
ATTR_MHZ14A_CARBON_DIOXIDE: { SensorEntityDescription(
ATTR_LABEL: f"{DEFAULT_NAME} MH-Z14A Carbon Dioxide", key=ATTR_SDS011_P1,
ATTR_UNIT: CONCENTRATION_PARTS_PER_MILLION, name=f"{DEFAULT_NAME} SDS011 Particulate Matter 10",
ATTR_DEVICE_CLASS: DEVICE_CLASS_CO2, unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
ATTR_ICON: None, icon="mdi:blur",
ATTR_ENABLED: True, state_class=STATE_CLASS_MEASUREMENT,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, ),
}, SensorEntityDescription(
ATTR_SDS011_P1: { key=ATTR_SDS011_P2,
ATTR_LABEL: f"{DEFAULT_NAME} SDS011 Particulate Matter 10", name=f"{DEFAULT_NAME} SDS011 Particulate Matter 2.5",
ATTR_UNIT: CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
ATTR_DEVICE_CLASS: None, icon="mdi:blur",
ATTR_ICON: "mdi:blur", state_class=STATE_CLASS_MEASUREMENT,
ATTR_ENABLED: True, ),
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, SensorEntityDescription(
}, key=ATTR_SHT3X_HUMIDITY,
ATTR_SDS011_P2: { name=f"{DEFAULT_NAME} SHT3X Humidity",
ATTR_LABEL: f"{DEFAULT_NAME} SDS011 Particulate Matter 2.5", unit_of_measurement=PERCENTAGE,
ATTR_UNIT: CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, device_class=DEVICE_CLASS_HUMIDITY,
ATTR_DEVICE_CLASS: None, state_class=STATE_CLASS_MEASUREMENT,
ATTR_ICON: "mdi:blur", ),
ATTR_ENABLED: True, SensorEntityDescription(
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, key=ATTR_SHT3X_TEMPERATURE,
}, name=f"{DEFAULT_NAME} SHT3X Temperature",
ATTR_SHT3X_HUMIDITY: { unit_of_measurement=TEMP_CELSIUS,
ATTR_LABEL: f"{DEFAULT_NAME} SHT3X Humidity", device_class=DEVICE_CLASS_TEMPERATURE,
ATTR_UNIT: PERCENTAGE, state_class=STATE_CLASS_MEASUREMENT,
ATTR_DEVICE_CLASS: DEVICE_CLASS_HUMIDITY, ),
ATTR_ICON: None, SensorEntityDescription(
ATTR_ENABLED: True, key=ATTR_SPS30_P0,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, name=f"{DEFAULT_NAME} SPS30 Particulate Matter 1.0",
}, unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
ATTR_SHT3X_TEMPERATURE: { icon="mdi:blur",
ATTR_LABEL: f"{DEFAULT_NAME} SHT3X Temperature", state_class=STATE_CLASS_MEASUREMENT,
ATTR_UNIT: TEMP_CELSIUS, ),
ATTR_DEVICE_CLASS: DEVICE_CLASS_TEMPERATURE, SensorEntityDescription(
ATTR_ICON: None, key=ATTR_SPS30_P1,
ATTR_ENABLED: True, name=f"{DEFAULT_NAME} SPS30 Particulate Matter 10",
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
}, icon="mdi:blur",
ATTR_SPS30_P0: { state_class=STATE_CLASS_MEASUREMENT,
ATTR_LABEL: f"{DEFAULT_NAME} SPS30 Particulate Matter 1.0", ),
ATTR_UNIT: CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, SensorEntityDescription(
ATTR_DEVICE_CLASS: None, key=ATTR_SPS30_P2,
ATTR_ICON: "mdi:blur", name=f"{DEFAULT_NAME} SPS30 Particulate Matter 2.5",
ATTR_ENABLED: True, unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, icon="mdi:blur",
}, state_class=STATE_CLASS_MEASUREMENT,
ATTR_SPS30_P1: { ),
ATTR_LABEL: f"{DEFAULT_NAME} SPS30 Particulate Matter 10", SensorEntityDescription(
ATTR_UNIT: CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, key=ATTR_SPS30_P4,
ATTR_DEVICE_CLASS: None, name=f"{DEFAULT_NAME} SPS30 Particulate Matter 4.0",
ATTR_ICON: "mdi:blur", unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
ATTR_ENABLED: True, icon="mdi:blur",
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, state_class=STATE_CLASS_MEASUREMENT,
}, ),
ATTR_SPS30_P2: { SensorEntityDescription(
ATTR_LABEL: f"{DEFAULT_NAME} SPS30 Particulate Matter 2.5", key=ATTR_DHT22_HUMIDITY,
ATTR_UNIT: CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, name=f"{DEFAULT_NAME} DHT22 Humidity",
ATTR_DEVICE_CLASS: None, unit_of_measurement=PERCENTAGE,
ATTR_ICON: "mdi:blur", device_class=DEVICE_CLASS_HUMIDITY,
ATTR_ENABLED: True, state_class=STATE_CLASS_MEASUREMENT,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, ),
}, SensorEntityDescription(
ATTR_SPS30_P4: { key=ATTR_DHT22_TEMPERATURE,
ATTR_LABEL: f"{DEFAULT_NAME} SPS30 Particulate Matter 4.0", name=f"{DEFAULT_NAME} DHT22 Temperature",
ATTR_UNIT: CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, unit_of_measurement=TEMP_CELSIUS,
ATTR_DEVICE_CLASS: None, device_class=DEVICE_CLASS_TEMPERATURE,
ATTR_ICON: "mdi:blur", state_class=STATE_CLASS_MEASUREMENT,
ATTR_ENABLED: True, ),
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, SensorEntityDescription(
}, key=ATTR_SIGNAL_STRENGTH,
ATTR_DHT22_HUMIDITY: { name=f"{DEFAULT_NAME} Signal Strength",
ATTR_LABEL: f"{DEFAULT_NAME} DHT22 Humidity", unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
ATTR_UNIT: PERCENTAGE, device_class=DEVICE_CLASS_SIGNAL_STRENGTH,
ATTR_DEVICE_CLASS: DEVICE_CLASS_HUMIDITY, entity_registry_enabled_default=False,
ATTR_ICON: None, state_class=STATE_CLASS_MEASUREMENT,
ATTR_ENABLED: True, ),
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT, SensorEntityDescription(
}, key=ATTR_UPTIME,
ATTR_DHT22_TEMPERATURE: { name=f"{DEFAULT_NAME} Uptime",
ATTR_LABEL: f"{DEFAULT_NAME} DHT22 Temperature", device_class=DEVICE_CLASS_TIMESTAMP,
ATTR_UNIT: TEMP_CELSIUS, entity_registry_enabled_default=False,
ATTR_DEVICE_CLASS: DEVICE_CLASS_TEMPERATURE, ),
ATTR_ICON: None, )
ATTR_ENABLED: True,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT,
},
ATTR_SIGNAL_STRENGTH: {
ATTR_LABEL: f"{DEFAULT_NAME} Signal Strength",
ATTR_UNIT: SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
ATTR_DEVICE_CLASS: DEVICE_CLASS_SIGNAL_STRENGTH,
ATTR_ICON: None,
ATTR_ENABLED: False,
ATTR_STATE_CLASS: STATE_CLASS_MEASUREMENT,
},
ATTR_UPTIME: {
ATTR_LABEL: f"{DEFAULT_NAME} Uptime",
ATTR_UNIT: None,
ATTR_DEVICE_CLASS: DEVICE_CLASS_TIMESTAMP,
ATTR_ICON: None,
ATTR_ENABLED: False,
ATTR_STATE_CLASS: None,
},
}

15
homeassistant/components/nam/model.py
View file

@ -1,15 +0,0 @@
"""Type definitions for Nettig Air Monitor integration."""
from __future__ import annotations
from typing import TypedDict
class SensorDescription(TypedDict):
"""Sensor description class."""
label: str
unit: str | None
device_class: str | None
icon: str | None
enabled: bool
state_class: str | None

49
homeassistant/components/nam/sensor.py
View file

@ -6,12 +6,11 @@ import logging
from typing import cast from typing import cast
from homeassistant.components.sensor import ( from homeassistant.components.sensor import (
ATTR_STATE_CLASS,
DOMAIN as PLATFORM, DOMAIN as PLATFORM,
SensorEntity, SensorEntity,
SensorEntityDescription,
) )
from homeassistant.config_entries import ConfigEntry from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_DEVICE_CLASS, ATTR_ICON
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry from homeassistant.helpers import entity_registry
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
@ -20,15 +19,7 @@ from homeassistant.helpers.update_coordinator import CoordinatorEntity
from homeassistant.util.dt import utcnow from homeassistant.util.dt import utcnow
from . import NAMDataUpdateCoordinator from . import NAMDataUpdateCoordinator
from .const import ( from .const import ATTR_UPTIME, DOMAIN, MIGRATION_SENSORS, SENSORS
ATTR_ENABLED,
ATTR_LABEL,
ATTR_UNIT,
ATTR_UPTIME,
DOMAIN,
MIGRATION_SENSORS,
SENSORS,
)
PARALLEL_UPDATES = 1 PARALLEL_UPDATES = 1
@ -57,12 +48,12 @@ async def async_setup_entry(
ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id) ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
sensors: list[NAMSensor | NAMSensorUptime] = [] sensors: list[NAMSensor | NAMSensorUptime] = []
for sensor in SENSORS: for description in SENSORS:
if getattr(coordinator.data, sensor) is not None: if getattr(coordinator.data, description.key) is not None:
if sensor == ATTR_UPTIME: if description.key == ATTR_UPTIME:
sensors.append(NAMSensorUptime(coordinator, sensor)) sensors.append(NAMSensorUptime(coordinator, description))
else: else:
sensors.append(NAMSensor(coordinator, sensor)) sensors.append(NAMSensor(coordinator, description))
async_add_entities(sensors, False) async_add_entities(sensors, False)
@ -72,24 +63,23 @@ class NAMSensor(CoordinatorEntity, SensorEntity):
coordinator: NAMDataUpdateCoordinator coordinator: NAMDataUpdateCoordinator
def __init__(self, coordinator: NAMDataUpdateCoordinator, sensor_type: str) -> None: def __init__(
self,
coordinator: NAMDataUpdateCoordinator,
description: SensorEntityDescription,
) -> None:
"""Initialize.""" """Initialize."""
super().__init__(coordinator) super().__init__(coordinator)
description = SENSORS[sensor_type]
self._attr_device_class = description[ATTR_DEVICE_CLASS]
self._attr_device_info = coordinator.device_info self._attr_device_info = coordinator.device_info
self._attr_entity_registry_enabled_default = description[ATTR_ENABLED] self._attr_unique_id = f"{coordinator.unique_id}-{description.key}"
self._attr_icon = description[ATTR_ICON] self.entity_description = description
self._attr_name = description[ATTR_LABEL]
self._attr_state_class = description[ATTR_STATE_CLASS]
self._attr_unique_id = f"{coordinator.unique_id}-{sensor_type}"
self._attr_unit_of_measurement = description[ATTR_UNIT]
self.sensor_type = sensor_type
@property @property
def state(self) -> StateType: def state(self) -> StateType:
"""Return the state.""" """Return the state."""
return cast(StateType, getattr(self.coordinator.data, self.sensor_type)) return cast(
StateType, getattr(self.coordinator.data, self.entity_description.key)
)
@property @property
def available(self) -> bool: def available(self) -> bool:
@ -100,7 +90,8 @@ class NAMSensor(CoordinatorEntity, SensorEntity):
# sensors. For this reason, we mark entities for which data is missing as # sensors. For this reason, we mark entities for which data is missing as
# unavailable. # unavailable.
return ( return (
available and getattr(self.coordinator.data, self.sensor_type) is not None available
and getattr(self.coordinator.data, self.entity_description.key) is not None
) )
@ -110,7 +101,7 @@ class NAMSensorUptime(NAMSensor):
@property @property
def state(self) -> str: def state(self) -> str:
"""Return the state.""" """Return the state."""
uptime_sec = getattr(self.coordinator.data, self.sensor_type) uptime_sec = getattr(self.coordinator.data, self.entity_description.key)
return ( return (
(utcnow() - timedelta(seconds=uptime_sec)) (utcnow() - timedelta(seconds=uptime_sec))
.replace(microsecond=0) .replace(microsecond=0)