mirror of
https://github.com/home-assistant/core.git
synced 2025-11-08 02:19:31 +00:00
Add sensors to Airgradient (#120286)
This commit is contained in:
Joost Lekkerkerker
committed by
GitHub
GitHub
parent
5c2db162c4
commit
ab9cbf64da
@@ -3,7 +3,13 @@
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
|
||||
from airgradient.models import Measures
|
||||
from airgradient import Config
|
||||
from airgradient.models import (
|
||||
ConfigurationControl,
|
||||
LedBarMode,
|
||||
Measures,
|
||||
TemperatureUnit,
|
||||
)
|
||||
|
||||
from homeassistant.components.sensor import (
|
||||
SensorDeviceClass,
|
||||
@@ -18,60 +24,69 @@ from homeassistant.const import (
|
||||
SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
|
||||
EntityCategory,
|
||||
UnitOfTemperature,
|
||||
UnitOfTime,
|
||||
)
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.typing import StateType
|
||||
|
||||
from . import AirGradientConfigEntry
|
||||
from .coordinator import AirGradientMeasurementCoordinator
|
||||
from .const import PM_STANDARD, PM_STANDARD_REVERSE
|
||||
from .coordinator import AirGradientConfigCoordinator, AirGradientMeasurementCoordinator
|
||||
from .entity import AirGradientEntity
|
||||
|
||||
|
||||
@dataclass(frozen=True, kw_only=True)
|
||||
class AirGradientSensorEntityDescription(SensorEntityDescription):
|
||||
"""Describes AirGradient sensor entity."""
|
||||
class AirGradientMeasurementSensorEntityDescription(SensorEntityDescription):
|
||||
"""Describes AirGradient measurement sensor entity."""
|
||||
|
||||
value_fn: Callable[[Measures], StateType]
|
||||
|
||||
|
||||
SENSOR_TYPES: tuple[AirGradientSensorEntityDescription, ...] = (
|
||||
AirGradientSensorEntityDescription(
|
||||
@dataclass(frozen=True, kw_only=True)
|
||||
class AirGradientConfigSensorEntityDescription(SensorEntityDescription):
|
||||
"""Describes AirGradient config sensor entity."""
|
||||
|
||||
value_fn: Callable[[Config], StateType]
|
||||
|
||||
|
||||
MEASUREMENT_SENSOR_TYPES: tuple[AirGradientMeasurementSensorEntityDescription, ...] = (
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="pm01",
|
||||
device_class=SensorDeviceClass.PM1,
|
||||
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.pm01,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="pm02",
|
||||
device_class=SensorDeviceClass.PM25,
|
||||
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.pm02,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="pm10",
|
||||
device_class=SensorDeviceClass.PM10,
|
||||
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.pm10,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="temperature",
|
||||
device_class=SensorDeviceClass.TEMPERATURE,
|
||||
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.ambient_temperature,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="humidity",
|
||||
device_class=SensorDeviceClass.HUMIDITY,
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.relative_humidity,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="signal_strength",
|
||||
device_class=SensorDeviceClass.SIGNAL_STRENGTH,
|
||||
native_unit_of_measurement=SIGNAL_STRENGTH_DECIBELS_MILLIWATT,
|
||||
@@ -80,33 +95,33 @@ SENSOR_TYPES: tuple[AirGradientSensorEntityDescription, ...] = (
|
||||
entity_registry_enabled_default=False,
|
||||
value_fn=lambda status: status.signal_strength,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="tvoc",
|
||||
translation_key="total_volatile_organic_component_index",
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.total_volatile_organic_component_index,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="nitrogen_index",
|
||||
translation_key="nitrogen_index",
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.nitrogen_index,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="co2",
|
||||
device_class=SensorDeviceClass.CO2,
|
||||
native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.rco2,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="pm003",
|
||||
translation_key="pm003_count",
|
||||
native_unit_of_measurement="particles/dL",
|
||||
state_class=SensorStateClass.MEASUREMENT,
|
||||
value_fn=lambda status: status.pm003_count,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="nox_raw",
|
||||
translation_key="raw_nitrogen",
|
||||
native_unit_of_measurement="ticks",
|
||||
@@ -114,7 +129,7 @@ SENSOR_TYPES: tuple[AirGradientSensorEntityDescription, ...] = (
|
||||
entity_registry_enabled_default=False,
|
||||
value_fn=lambda status: status.raw_nitrogen,
|
||||
),
|
||||
AirGradientSensorEntityDescription(
|
||||
AirGradientMeasurementSensorEntityDescription(
|
||||
key="tvoc_raw",
|
||||
translation_key="raw_total_volatile_organic_component",
|
||||
native_unit_of_measurement="ticks",
|
||||
@@ -124,6 +139,77 @@ SENSOR_TYPES: tuple[AirGradientSensorEntityDescription, ...] = (
|
||||
),
|
||||
)
|
||||
|
||||
CONFIG_SENSOR_TYPES: tuple[AirGradientConfigSensorEntityDescription, ...] = (
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="co2_automatic_baseline_calibration_days",
|
||||
translation_key="co2_automatic_baseline_calibration_days",
|
||||
device_class=SensorDeviceClass.DURATION,
|
||||
native_unit_of_measurement=UnitOfTime.DAYS,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.co2_automatic_baseline_calibration_days,
|
||||
),
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="nox_learning_offset",
|
||||
translation_key="nox_learning_offset",
|
||||
device_class=SensorDeviceClass.DURATION,
|
||||
native_unit_of_measurement=UnitOfTime.DAYS,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.nox_learning_offset,
|
||||
),
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="tvoc_learning_offset",
|
||||
translation_key="tvoc_learning_offset",
|
||||
device_class=SensorDeviceClass.DURATION,
|
||||
native_unit_of_measurement=UnitOfTime.DAYS,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.tvoc_learning_offset,
|
||||
),
|
||||
)
|
||||
|
||||
CONFIG_LED_BAR_SENSOR_TYPES: tuple[AirGradientConfigSensorEntityDescription, ...] = (
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="led_bar_mode",
|
||||
translation_key="led_bar_mode",
|
||||
device_class=SensorDeviceClass.ENUM,
|
||||
options=[x.value for x in LedBarMode],
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.led_bar_mode,
|
||||
),
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="led_bar_brightness",
|
||||
translation_key="led_bar_brightness",
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.led_bar_brightness,
|
||||
),
|
||||
)
|
||||
|
||||
CONFIG_DISPLAY_SENSOR_TYPES: tuple[AirGradientConfigSensorEntityDescription, ...] = (
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="display_temperature_unit",
|
||||
translation_key="display_temperature_unit",
|
||||
device_class=SensorDeviceClass.ENUM,
|
||||
options=[x.value for x in TemperatureUnit],
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.temperature_unit,
|
||||
),
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="display_pm_standard",
|
||||
translation_key="display_pm_standard",
|
||||
device_class=SensorDeviceClass.ENUM,
|
||||
options=list(PM_STANDARD_REVERSE),
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: PM_STANDARD.get(config.pm_standard),
|
||||
),
|
||||
AirGradientConfigSensorEntityDescription(
|
||||
key="display_brightness",
|
||||
translation_key="display_brightness",
|
||||
native_unit_of_measurement=PERCENTAGE,
|
||||
entity_category=EntityCategory.DIAGNOSTIC,
|
||||
value_fn=lambda config: config.display_brightness,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
hass: HomeAssistant,
|
||||
@@ -134,7 +220,9 @@ async def async_setup_entry(
|
||||
|
||||
coordinator = entry.runtime_data.measurement
|
||||
listener: Callable[[], None] | None = None
|
||||
not_setup: set[AirGradientSensorEntityDescription] = set(SENSOR_TYPES)
|
||||
not_setup: set[AirGradientMeasurementSensorEntityDescription] = set(
|
||||
MEASUREMENT_SENSOR_TYPES
|
||||
)
|
||||
|
||||
@callback
|
||||
def add_entities() -> None:
|
||||
@@ -147,7 +235,7 @@ async def async_setup_entry(
|
||||
if description.value_fn(coordinator.data) is None:
|
||||
not_setup.add(description)
|
||||
else:
|
||||
sensors.append(AirGradientSensor(coordinator, description))
|
||||
sensors.append(AirGradientMeasurementSensor(coordinator, description))
|
||||
|
||||
if sensors:
|
||||
async_add_entities(sensors)
|
||||
@@ -159,17 +247,33 @@ async def async_setup_entry(
|
||||
|
||||
add_entities()
|
||||
|
||||
entities = [
|
||||
AirGradientConfigSensor(entry.runtime_data.config, description)
|
||||
for description in CONFIG_SENSOR_TYPES
|
||||
]
|
||||
if "L" in coordinator.data.model:
|
||||
entities.extend(
|
||||
AirGradientConfigSensor(entry.runtime_data.config, description)
|
||||
for description in CONFIG_LED_BAR_SENSOR_TYPES
|
||||
)
|
||||
if "I" in coordinator.data.model:
|
||||
entities.extend(
|
||||
AirGradientConfigSensor(entry.runtime_data.config, description)
|
||||
for description in CONFIG_DISPLAY_SENSOR_TYPES
|
||||
)
|
||||
async_add_entities(entities)
|
||||
|
||||
class AirGradientSensor(AirGradientEntity, SensorEntity):
|
||||
|
||||
class AirGradientMeasurementSensor(AirGradientEntity, SensorEntity):
|
||||
"""Defines an AirGradient sensor."""
|
||||
|
||||
entity_description: AirGradientSensorEntityDescription
|
||||
entity_description: AirGradientMeasurementSensorEntityDescription
|
||||
coordinator: AirGradientMeasurementCoordinator
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
coordinator: AirGradientMeasurementCoordinator,
|
||||
description: AirGradientSensorEntityDescription,
|
||||
description: AirGradientMeasurementSensorEntityDescription,
|
||||
) -> None:
|
||||
"""Initialize airgradient sensor."""
|
||||
super().__init__(coordinator)
|
||||
@@ -180,3 +284,28 @@ class AirGradientSensor(AirGradientEntity, SensorEntity):
|
||||
def native_value(self) -> StateType:
|
||||
"""Return the state of the sensor."""
|
||||
return self.entity_description.value_fn(self.coordinator.data)
|
||||
|
||||
|
||||
class AirGradientConfigSensor(AirGradientEntity, SensorEntity):
|
||||
"""Defines an AirGradient sensor."""
|
||||
|
||||
entity_description: AirGradientConfigSensorEntityDescription
|
||||
coordinator: AirGradientConfigCoordinator
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
coordinator: AirGradientConfigCoordinator,
|
||||
description: AirGradientConfigSensorEntityDescription,
|
||||
) -> None:
|
||||
"""Initialize airgradient sensor."""
|
||||
super().__init__(coordinator)
|
||||
self.entity_description = description
|
||||
self._attr_unique_id = f"{coordinator.serial_number}-{description.key}"
|
||||
self._attr_entity_registry_enabled_default = (
|
||||
coordinator.data.configuration_control is not ConfigurationControl.LOCAL
|
||||
)
|
||||
|
||||
@property
|
||||
def native_value(self) -> StateType:
|
||||
"""Return the state of the sensor."""
|
||||
return self.entity_description.value_fn(self.coordinator.data)
|
||||
|
||||
Reference in New Issue
Block a user