jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-17 18:27:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use EntityDescription - airvisual (#55125)

Browse Source
This commit is contained in:
Aaron Bach 2021-08-25 02:51:02 -06:00 committed by GitHub
parent f92ba18a6b
commit c9e8d42405
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 105 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
homeassistant/components/airvisual/__init__.py
View File

@ -32,6 +32,7 @@ from homeassistant.helpers import (
config_validation as cv, config_validation as cv,
entity_registry, entity_registry,
) )
from homeassistant.helpers.entity import EntityDescription
from homeassistant.helpers.update_coordinator import ( from homeassistant.helpers.update_coordinator import (
CoordinatorEntity, CoordinatorEntity,
DataUpdateCoordinator, DataUpdateCoordinator,
@ -358,11 +359,14 @@ async def async_reload_entry(hass: HomeAssistant, config_entry: ConfigEntry) ->
class AirVisualEntity(CoordinatorEntity): class AirVisualEntity(CoordinatorEntity):
"""Define a generic AirVisual entity.""" """Define a generic AirVisual entity."""
def __init__(self, coordinator: DataUpdateCoordinator) -> None: def __init__(
self, coordinator: DataUpdateCoordinator, description: EntityDescription
) -> None:
"""Initialize.""" """Initialize."""
super().__init__(coordinator) super().__init__(coordinator)
self._attr_extra_state_attributes = {ATTR_ATTRIBUTION: DEFAULT_ATTRIBUTION} self._attr_extra_state_attributes = {ATTR_ATTRIBUTION: DEFAULT_ATTRIBUTION}
self.entity_description = description
async def async_added_to_hass(self) -> None: async def async_added_to_hass(self) -> None:
"""Register callbacks.""" """Register callbacks."""

199
homeassistant/components/airvisual/sensor.py
View File

@ -1,7 +1,7 @@
"""Support for AirVisual air quality sensors.""" """Support for AirVisual air quality sensors."""
from __future__ import annotations from __future__ import annotations
from homeassistant.components.sensor import SensorEntity from homeassistant.components.sensor import SensorEntity, SensorEntityDescription
from homeassistant.config_entries import ConfigEntry from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ( from homeassistant.const import (
ATTR_LATITUDE, ATTR_LATITUDE,
@ -14,10 +14,15 @@ from homeassistant.const import (
CONF_LONGITUDE, CONF_LONGITUDE,
CONF_SHOW_ON_MAP, CONF_SHOW_ON_MAP,
CONF_STATE, CONF_STATE,
DEVICE_CLASS_AQI,
DEVICE_CLASS_BATTERY, DEVICE_CLASS_BATTERY,
DEVICE_CLASS_CO2, DEVICE_CLASS_CO2,
DEVICE_CLASS_HUMIDITY, DEVICE_CLASS_HUMIDITY,
DEVICE_CLASS_PM1,
DEVICE_CLASS_PM10,
DEVICE_CLASS_PM25,
DEVICE_CLASS_TEMPERATURE, DEVICE_CLASS_TEMPERATURE,
DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS,
PERCENTAGE, PERCENTAGE,
TEMP_CELSIUS, TEMP_CELSIUS,
) )
@ -59,60 +64,84 @@ SENSOR_KIND_SENSOR_LIFE = "sensor_life"
SENSOR_KIND_TEMPERATURE = "temperature" SENSOR_KIND_TEMPERATURE = "temperature"
SENSOR_KIND_VOC = "voc" SENSOR_KIND_VOC = "voc"
GEOGRAPHY_SENSORS = [ GEOGRAPHY_SENSOR_DESCRIPTIONS = (
(SENSOR_KIND_LEVEL, "Air Pollution Level", "mdi:gauge", None), SensorEntityDescription(
(SENSOR_KIND_AQI, "Air Quality Index", "mdi:chart-line", "AQI"), key=SENSOR_KIND_LEVEL,
(SENSOR_KIND_POLLUTANT, "Main Pollutant", "mdi:chemical-weapon", None), name="Air Pollution Level",
] device_class=DEVICE_CLASS_POLLUTANT_LEVEL,
icon="mdi:gauge",
),
SensorEntityDescription(
key=SENSOR_KIND_AQI,
name="Air Quality Index",
device_class=DEVICE_CLASS_AQI,
native_unit_of_measurement="AQI",
),
SensorEntityDescription(
key=SENSOR_KIND_POLLUTANT,
name="Main Pollutant",
device_class=DEVICE_CLASS_POLLUTANT_LABEL,
icon="mdi:chemical-weapon",
),
)
GEOGRAPHY_SENSOR_LOCALES = {"cn": "Chinese", "us": "U.S."} GEOGRAPHY_SENSOR_LOCALES = {"cn": "Chinese", "us": "U.S."}
NODE_PRO_SENSORS = [ NODE_PRO_SENSOR_DESCRIPTIONS = (
(SENSOR_KIND_AQI, "Air Quality Index", None, "mdi:chart-line", "AQI"), SensorEntityDescription(
(SENSOR_KIND_BATTERY_LEVEL, "Battery", DEVICE_CLASS_BATTERY, None, PERCENTAGE), key=SENSOR_KIND_AQI,
( name="Air Quality Index",
SENSOR_KIND_CO2, device_class=DEVICE_CLASS_AQI,
"C02", native_unit_of_measurement="AQI",
DEVICE_CLASS_CO2,
None,
CONCENTRATION_PARTS_PER_MILLION,
), ),
(SENSOR_KIND_HUMIDITY, "Humidity", DEVICE_CLASS_HUMIDITY, None, PERCENTAGE), SensorEntityDescription(
( key=SENSOR_KIND_BATTERY_LEVEL,
SENSOR_KIND_PM_0_1, name="Battery",
"PM 0.1", device_class=DEVICE_CLASS_BATTERY,
None, native_unit_of_measurement=PERCENTAGE,
"mdi:sprinkler",
CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
), ),
( SensorEntityDescription(
SENSOR_KIND_PM_1_0, key=SENSOR_KIND_CO2,
"PM 1.0", name="C02",
None, device_class=DEVICE_CLASS_CO2,
"mdi:sprinkler", native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
), ),
( SensorEntityDescription(
SENSOR_KIND_PM_2_5, key=SENSOR_KIND_HUMIDITY,
"PM 2.5", name="Humidity",
None, device_class=DEVICE_CLASS_HUMIDITY,
"mdi:sprinkler", native_unit_of_measurement=PERCENTAGE,
CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
), ),
( SensorEntityDescription(
SENSOR_KIND_TEMPERATURE, key=SENSOR_KIND_PM_0_1,
"Temperature", name="PM 0.1",
DEVICE_CLASS_TEMPERATURE, device_class=DEVICE_CLASS_PM1,
None, native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
TEMP_CELSIUS,
), ),
( SensorEntityDescription(
SENSOR_KIND_VOC, key=SENSOR_KIND_PM_1_0,
"VOC", name="PM 1.0",
None, device_class=DEVICE_CLASS_PM10,
"mdi:sprinkler", native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
CONCENTRATION_PARTS_PER_MILLION,
), ),
] SensorEntityDescription(
key=SENSOR_KIND_PM_2_5,
name="PM 2.5",
device_class=DEVICE_CLASS_PM25,
native_unit_of_measurement=CONCENTRATION_MICROGRAMS_PER_CUBIC_METER,
),
SensorEntityDescription(
key=SENSOR_KIND_TEMPERATURE,
name="Temperature",
device_class=DEVICE_CLASS_TEMPERATURE,
native_unit_of_measurement=TEMP_CELSIUS,
),
SensorEntityDescription(
key=SENSOR_KIND_VOC,
name="VOC",
device_class=DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS,
native_unit_of_measurement=CONCENTRATION_PARTS_PER_MILLION,
),
)
STATE_POLLUTANT_LABEL_CO = "co" STATE_POLLUTANT_LABEL_CO = "co"
STATE_POLLUTANT_LABEL_N2 = "n2" STATE_POLLUTANT_LABEL_N2 = "n2"
@ -161,22 +190,14 @@ async def async_setup_entry(
INTEGRATION_TYPE_GEOGRAPHY_NAME, INTEGRATION_TYPE_GEOGRAPHY_NAME,
): ):
sensors = [ sensors = [
AirVisualGeographySensor( AirVisualGeographySensor(coordinator, config_entry, description, locale)
coordinator,
config_entry,
kind,
name,
icon,
unit,
locale,
)
for locale in GEOGRAPHY_SENSOR_LOCALES for locale in GEOGRAPHY_SENSOR_LOCALES
for kind, name, icon, unit in GEOGRAPHY_SENSORS for description in GEOGRAPHY_SENSOR_DESCRIPTIONS
] ]
else: else:
sensors = [ sensors = [
AirVisualNodeProSensor(coordinator, kind, name, device_class, icon, unit) AirVisualNodeProSensor(coordinator, description)
for kind, name, device_class, icon, unit in NODE_PRO_SENSORS for description in NODE_PRO_SENSOR_DESCRIPTIONS
] ]
async_add_entities(sensors, True) async_add_entities(sensors, True)
@ -189,19 +210,12 @@ class AirVisualGeographySensor(AirVisualEntity, SensorEntity):
self, self,
coordinator: DataUpdateCoordinator, coordinator: DataUpdateCoordinator,
config_entry: ConfigEntry, config_entry: ConfigEntry,
kind: str, description: SensorEntityDescription,
name: str,
icon: str,
unit: str | None,
locale: str, locale: str,
) -> None: ) -> None:
"""Initialize.""" """Initialize."""
super().__init__(coordinator) super().__init__(coordinator, description)
if kind == SENSOR_KIND_LEVEL:
self._attr_device_class = DEVICE_CLASS_POLLUTANT_LEVEL
elif kind == SENSOR_KIND_POLLUTANT:
self._attr_device_class = DEVICE_CLASS_POLLUTANT_LABEL
self._attr_extra_state_attributes.update( self._attr_extra_state_attributes.update(
{ {
ATTR_CITY: config_entry.data.get(CONF_CITY), ATTR_CITY: config_entry.data.get(CONF_CITY),
@ -209,12 +223,9 @@ class AirVisualGeographySensor(AirVisualEntity, SensorEntity):
ATTR_COUNTRY: config_entry.data.get(CONF_COUNTRY), ATTR_COUNTRY: config_entry.data.get(CONF_COUNTRY),
} }
) )
self._attr_icon = icon self._attr_name = f"{GEOGRAPHY_SENSOR_LOCALES[locale]} {description.name}"
self._attr_name = f"{GEOGRAPHY_SENSOR_LOCALES[locale]} {name}" self._attr_unique_id = f"{config_entry.unique_id}_{locale}_{description.key}"
self._attr_unique_id = f"{config_entry.unique_id}_{locale}_{kind}"
self._attr_native_unit_of_measurement = unit
self._config_entry = config_entry self._config_entry = config_entry
self._kind = kind
self._locale = locale self._locale = locale
@property @property
@ -230,16 +241,16 @@ class AirVisualGeographySensor(AirVisualEntity, SensorEntity):
except KeyError: except KeyError:
return return
if self._kind == SENSOR_KIND_LEVEL: if self.entity_description.key == SENSOR_KIND_LEVEL:
aqi = data[f"aqi{self._locale}"] aqi = data[f"aqi{self._locale}"]
[(self._attr_native_value, self._attr_icon)] = [ [(self._attr_native_value, self._attr_icon)] = [
(name, icon) (name, icon)
for (floor, ceiling), (name, icon) in POLLUTANT_LEVELS.items() for (floor, ceiling), (name, icon) in POLLUTANT_LEVELS.items()
if floor <= aqi <= ceiling if floor <= aqi <= ceiling
] ]
elif self._kind == SENSOR_KIND_AQI: elif self.entity_description.key == SENSOR_KIND_AQI:
self._attr_native_value = data[f"aqi{self._locale}"] self._attr_native_value = data[f"aqi{self._locale}"]
elif self._kind == SENSOR_KIND_POLLUTANT: elif self.entity_description.key == SENSOR_KIND_POLLUTANT:
symbol = data[f"main{self._locale}"] symbol = data[f"main{self._locale}"]
self._attr_native_value = symbol self._attr_native_value = symbol
self._attr_extra_state_attributes.update( self._attr_extra_state_attributes.update(
@ -281,25 +292,15 @@ class AirVisualNodeProSensor(AirVisualEntity, SensorEntity):
"""Define an AirVisual sensor related to a Node/Pro unit.""" """Define an AirVisual sensor related to a Node/Pro unit."""
def __init__( def __init__(
self, self, coordinator: DataUpdateCoordinator, description: SensorEntityDescription
coordinator: DataUpdateCoordinator,
kind: str,
name: str,
device_class: str | None,
icon: str | None,
unit: str,
) -> None: ) -> None:
"""Initialize.""" """Initialize."""
super().__init__(coordinator) super().__init__(coordinator, description)
self._attr_device_class = device_class
self._attr_icon = icon
self._attr_name = ( self._attr_name = (
f"{coordinator.data['settings']['node_name']} Node/Pro: {name}" f"{coordinator.data['settings']['node_name']} Node/Pro: {description.name}"
) )
self._attr_unique_id = f"{coordinator.data['serial_number']}_{kind}" self._attr_unique_id = f"{coordinator.data['serial_number']}_{description.key}"
self._attr_native_unit_of_measurement = unit
self._kind = kind
@property @property
def device_info(self) -> DeviceInfo: def device_info(self) -> DeviceInfo:
@ -318,7 +319,7 @@ class AirVisualNodeProSensor(AirVisualEntity, SensorEntity):
@callback @callback
def update_from_latest_data(self) -> None: def update_from_latest_data(self) -> None:
"""Update the entity from the latest data.""" """Update the entity from the latest data."""
if self._kind == SENSOR_KIND_AQI: if self.entity_description.key == SENSOR_KIND_AQI:
if self.coordinator.data["settings"]["is_aqi_usa"]: if self.coordinator.data["settings"]["is_aqi_usa"]:
self._attr_native_value = self.coordinator.data["measurements"][ self._attr_native_value = self.coordinator.data["measurements"][
"aqi_us" "aqi_us"
@ -327,23 +328,23 @@ class AirVisualNodeProSensor(AirVisualEntity, SensorEntity):
self._attr_native_value = self.coordinator.data["measurements"][ self._attr_native_value = self.coordinator.data["measurements"][
"aqi_cn" "aqi_cn"
] ]
elif self._kind == SENSOR_KIND_BATTERY_LEVEL: elif self.entity_description.key == SENSOR_KIND_BATTERY_LEVEL:
self._attr_native_value = self.coordinator.data["status"]["battery"] self._attr_native_value = self.coordinator.data["status"]["battery"]
elif self._kind == SENSOR_KIND_CO2: elif self.entity_description.key == SENSOR_KIND_CO2:
self._attr_native_value = self.coordinator.data["measurements"].get("co2") self._attr_native_value = self.coordinator.data["measurements"].get("co2")
elif self._kind == SENSOR_KIND_HUMIDITY: elif self.entity_description.key == SENSOR_KIND_HUMIDITY:
self._attr_native_value = self.coordinator.data["measurements"].get( self._attr_native_value = self.coordinator.data["measurements"].get(
"humidity" "humidity"
) )
elif self._kind == SENSOR_KIND_PM_0_1: elif self.entity_description.key == SENSOR_KIND_PM_0_1:
self._attr_native_value = self.coordinator.data["measurements"].get("pm0_1") self._attr_native_value = self.coordinator.data["measurements"].get("pm0_1")
elif self._kind == SENSOR_KIND_PM_1_0: elif self.entity_description.key == SENSOR_KIND_PM_1_0:
self._attr_native_value = self.coordinator.data["measurements"].get("pm1_0") self._attr_native_value = self.coordinator.data["measurements"].get("pm1_0")
elif self._kind == SENSOR_KIND_PM_2_5: elif self.entity_description.key == SENSOR_KIND_PM_2_5:
self._attr_native_value = self.coordinator.data["measurements"].get("pm2_5") self._attr_native_value = self.coordinator.data["measurements"].get("pm2_5")
elif self._kind == SENSOR_KIND_TEMPERATURE: elif self.entity_description.key == SENSOR_KIND_TEMPERATURE:
self._attr_native_value = self.coordinator.data["measurements"].get( self._attr_native_value = self.coordinator.data["measurements"].get(
"temperature_C" "temperature_C"
) )
elif self._kind == SENSOR_KIND_VOC: elif self.entity_description.key == SENSOR_KIND_VOC:
self._attr_native_value = self.coordinator.data["measurements"].get("voc") self._attr_native_value = self.coordinator.data["measurements"].get("voc")