mirror of
https://github.com/home-assistant/core.git
synced 2025-11-04 00:19:31 +00:00
260 lines
8.8 KiB
Python
260 lines
8.8 KiB
Python
"""Support for airthings ble sensors."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import dataclasses
|
|
import logging
|
|
|
|
from airthings_ble import AirthingsDevice
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.const import (
|
|
CONCENTRATION_PARTS_PER_BILLION,
|
|
CONCENTRATION_PARTS_PER_MILLION,
|
|
LIGHT_LUX,
|
|
PERCENTAGE,
|
|
EntityCategory,
|
|
Platform,
|
|
UnitOfPressure,
|
|
UnitOfSoundPressure,
|
|
UnitOfTemperature,
|
|
)
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
from homeassistant.helpers.device_registry import CONNECTION_BLUETOOTH, DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
from homeassistant.helpers.entity_registry import (
|
|
RegistryEntry,
|
|
async_entries_for_device,
|
|
)
|
|
from homeassistant.helpers.typing import StateType
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
from homeassistant.util.unit_system import METRIC_SYSTEM
|
|
|
|
from .const import DOMAIN, VOLUME_BECQUEREL, VOLUME_PICOCURIE
|
|
from .coordinator import AirthingsBLEConfigEntry, AirthingsBLEDataUpdateCoordinator
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
SENSORS_MAPPING_TEMPLATE: dict[str, SensorEntityDescription] = {
|
|
"radon_1day_avg": SensorEntityDescription(
|
|
key="radon_1day_avg",
|
|
translation_key="radon_1day_avg",
|
|
native_unit_of_measurement=VOLUME_BECQUEREL,
|
|
suggested_display_precision=0,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
"radon_longterm_avg": SensorEntityDescription(
|
|
key="radon_longterm_avg",
|
|
translation_key="radon_longterm_avg",
|
|
native_unit_of_measurement=VOLUME_BECQUEREL,
|
|
suggested_display_precision=0,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
"radon_1day_level": SensorEntityDescription(
|
|
key="radon_1day_level",
|
|
translation_key="radon_1day_level",
|
|
),
|
|
"radon_longterm_level": SensorEntityDescription(
|
|
key="radon_longterm_level",
|
|
translation_key="radon_longterm_level",
|
|
),
|
|
"temperature": SensorEntityDescription(
|
|
key="temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=1,
|
|
),
|
|
"humidity": SensorEntityDescription(
|
|
key="humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=1,
|
|
),
|
|
"pressure": SensorEntityDescription(
|
|
key="pressure",
|
|
device_class=SensorDeviceClass.ATMOSPHERIC_PRESSURE,
|
|
native_unit_of_measurement=UnitOfPressure.MBAR,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=1,
|
|
),
|
|
"battery": SensorEntityDescription(
|
|
key="battery",
|
|
device_class=SensorDeviceClass.BATTERY,
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
suggested_display_precision=0,
|
|
),
|
|
"co2": SensorEntityDescription(
|
|
key="co2",
|
|
device_class=SensorDeviceClass.CO2,
|
|
native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=0,
|
|
),
|
|
"voc": SensorEntityDescription(
|
|
key="voc",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS_PARTS,
|
|
native_unit_of_measurement=CONCENTRATION_PARTS_PER_BILLION,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=0,
|
|
),
|
|
"illuminance": SensorEntityDescription(
|
|
key="illuminance",
|
|
translation_key="illuminance",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=0,
|
|
),
|
|
"lux": SensorEntityDescription(
|
|
key="lux",
|
|
device_class=SensorDeviceClass.ILLUMINANCE,
|
|
native_unit_of_measurement=LIGHT_LUX,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=0,
|
|
),
|
|
"noise": SensorEntityDescription(
|
|
key="noise",
|
|
translation_key="ambient_noise",
|
|
device_class=SensorDeviceClass.SOUND_PRESSURE,
|
|
native_unit_of_measurement=UnitOfSoundPressure.WEIGHTED_DECIBEL_A,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
suggested_display_precision=0,
|
|
),
|
|
}
|
|
|
|
PARALLEL_UPDATES = 0
|
|
|
|
|
|
@callback
|
|
def async_migrate(hass: HomeAssistant, address: str, sensor_name: str) -> None:
|
|
"""Migrate entities to new unique ids (with BLE Address)."""
|
|
ent_reg = er.async_get(hass)
|
|
unique_id_trailer = f"_{sensor_name}"
|
|
new_unique_id = f"{address}{unique_id_trailer}"
|
|
if ent_reg.async_get_entity_id(DOMAIN, Platform.SENSOR, new_unique_id):
|
|
# New unique id already exists
|
|
return
|
|
dev_reg = dr.async_get(hass)
|
|
if not (
|
|
device := dev_reg.async_get_device(
|
|
connections={(CONNECTION_BLUETOOTH, address)}
|
|
)
|
|
):
|
|
return
|
|
entities = async_entries_for_device(
|
|
ent_reg,
|
|
device_id=device.id,
|
|
include_disabled_entities=True,
|
|
)
|
|
matching_reg_entry: RegistryEntry | None = None
|
|
for entry in entities:
|
|
if entry.unique_id.endswith(unique_id_trailer) and (
|
|
not matching_reg_entry or "(" not in entry.unique_id
|
|
):
|
|
matching_reg_entry = entry
|
|
if not matching_reg_entry or matching_reg_entry.unique_id == new_unique_id:
|
|
# Already has the newest unique id format
|
|
return
|
|
entity_id = matching_reg_entry.entity_id
|
|
ent_reg.async_update_entity(entity_id=entity_id, new_unique_id=new_unique_id)
|
|
_LOGGER.debug("Migrated entity '%s' to unique id '%s'", entity_id, new_unique_id)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: AirthingsBLEConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Airthings BLE sensors."""
|
|
is_metric = hass.config.units is METRIC_SYSTEM
|
|
|
|
coordinator = entry.runtime_data
|
|
|
|
# we need to change some units
|
|
sensors_mapping = SENSORS_MAPPING_TEMPLATE.copy()
|
|
if not is_metric:
|
|
for key, val in sensors_mapping.items():
|
|
if val.native_unit_of_measurement is not VOLUME_BECQUEREL:
|
|
continue
|
|
sensors_mapping[key] = dataclasses.replace(
|
|
val,
|
|
native_unit_of_measurement=VOLUME_PICOCURIE,
|
|
suggested_display_precision=1,
|
|
)
|
|
|
|
entities = []
|
|
_LOGGER.debug("got sensors: %s", coordinator.data.sensors)
|
|
for sensor_type, sensor_value in coordinator.data.sensors.items():
|
|
if sensor_type not in sensors_mapping:
|
|
_LOGGER.debug(
|
|
"Unknown sensor type detected: %s, %s",
|
|
sensor_type,
|
|
sensor_value,
|
|
)
|
|
continue
|
|
async_migrate(hass, coordinator.data.address, sensor_type)
|
|
entities.append(
|
|
AirthingsSensor(coordinator, coordinator.data, sensors_mapping[sensor_type])
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
class AirthingsSensor(
|
|
CoordinatorEntity[AirthingsBLEDataUpdateCoordinator], SensorEntity
|
|
):
|
|
"""Airthings BLE sensors for the device."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: AirthingsBLEDataUpdateCoordinator,
|
|
airthings_device: AirthingsDevice,
|
|
entity_description: SensorEntityDescription,
|
|
) -> None:
|
|
"""Populate the airthings entity with relevant data."""
|
|
super().__init__(coordinator)
|
|
self.entity_description = entity_description
|
|
|
|
name = airthings_device.name
|
|
if identifier := airthings_device.identifier:
|
|
name += f" ({identifier})"
|
|
|
|
self._attr_unique_id = f"{airthings_device.address}_{entity_description.key}"
|
|
self._attr_device_info = DeviceInfo(
|
|
connections={
|
|
(
|
|
CONNECTION_BLUETOOTH,
|
|
airthings_device.address,
|
|
)
|
|
},
|
|
name=name,
|
|
manufacturer=airthings_device.manufacturer,
|
|
hw_version=airthings_device.hw_version,
|
|
sw_version=airthings_device.sw_version,
|
|
model=airthings_device.model.product_name,
|
|
)
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Check if device and sensor is available in data."""
|
|
return (
|
|
super().available
|
|
and self.entity_description.key in self.coordinator.data.sensors
|
|
)
|
|
|
|
@property
|
|
def native_value(self) -> StateType:
|
|
"""Return the value reported by the sensor."""
|
|
return self.coordinator.data.sensors[self.entity_description.key]
|