Use SensorEntityDescription and set state class measurement for NUT sensors (#54269)

This commit is contained in:
Michael 2021-08-11 15:56:41 +02:00 committed by GitHub
parent 4ef9269790
commit 6285c7775b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 586 additions and 279 deletions

View file

@ -1,9 +1,15 @@
"""Provides a sensor to track various status aspects of a UPS."""
from __future__ import annotations
import logging
from homeassistant.components.sensor import SensorEntity
from homeassistant.components.nut import PyNUTData
from homeassistant.components.sensor import SensorEntity, SensorEntityDescription
from homeassistant.const import ATTR_STATE, CONF_RESOURCES, STATE_UNKNOWN
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from homeassistant.helpers.update_coordinator import (
CoordinatorEntity,
DataUpdateCoordinator,
)
from .const import (
COORDINATOR,
@ -16,11 +22,7 @@ from .const import (
PYNUT_MODEL,
PYNUT_NAME,
PYNUT_UNIQUE_ID,
SENSOR_DEVICE_CLASS,
SENSOR_ICON,
SENSOR_NAME,
SENSOR_TYPES,
SENSOR_UNIT,
STATE_TYPES,
)
@ -60,7 +62,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
coordinator,
data,
name.title(),
sensor_type,
SENSOR_TYPES[sensor_type],
unique_id,
manufacturer,
model,
@ -82,18 +84,18 @@ class NUTSensor(CoordinatorEntity, SensorEntity):
def __init__(
self,
coordinator,
data,
name,
sensor_type,
unique_id,
manufacturer,
model,
firmware,
):
coordinator: DataUpdateCoordinator,
data: PyNUTData,
name: str,
sensor_description: SensorEntityDescription,
unique_id: str,
manufacturer: str | None,
model: str | None,
firmware: str | None,
) -> None:
"""Initialize the sensor."""
super().__init__(coordinator)
self._type = sensor_type
self.entity_description = sensor_description
self._manufacturer = manufacturer
self._firmware = firmware
self._model = model
@ -101,10 +103,7 @@ class NUTSensor(CoordinatorEntity, SensorEntity):
self._data = data
self._unique_id = unique_id
self._attr_device_class = SENSOR_TYPES[self._type][SENSOR_DEVICE_CLASS]
self._attr_icon = SENSOR_TYPES[self._type][SENSOR_ICON]
self._attr_name = f"{name} {SENSOR_TYPES[sensor_type][SENSOR_NAME]}"
self._attr_unit_of_measurement = SENSOR_TYPES[sensor_type][SENSOR_UNIT]
self._attr_name = f"{name} {sensor_description.name}"
@property
def device_info(self):
@ -128,16 +127,16 @@ class NUTSensor(CoordinatorEntity, SensorEntity):
"""Sensor Unique id."""
if not self._unique_id:
return None
return f"{self._unique_id}_{self._type}"
return f"{self._unique_id}_{self.entity_description.key}"
@property
def state(self):
"""Return entity state from ups."""
if not self._data.status:
return None
if self._type == KEY_STATUS_DISPLAY:
if self.entity_description.key == KEY_STATUS_DISPLAY:
return _format_display_state(self._data.status)
return self._data.status.get(self._type)
return self._data.status.get(self.entity_description.key)
@property
def extra_state_attributes(self):