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

@ -25,19 +25,12 @@ from .const import (
DOMAIN, DOMAIN,
KEY_STATUS, KEY_STATUS,
KEY_STATUS_DISPLAY, KEY_STATUS_DISPLAY,
SENSOR_NAME,
SENSOR_TYPES, SENSOR_TYPES,
) )
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
SENSOR_DICT = {
sensor_id: sensor_spec[SENSOR_NAME]
for sensor_id, sensor_spec in SENSOR_TYPES.items()
}
def _base_schema(discovery_info): def _base_schema(discovery_info):
"""Generate base schema.""" """Generate base schema."""
base_schema = {} base_schema = {}
@ -59,15 +52,15 @@ def _resource_schema_base(available_resources, selected_resources):
"""Resource selection schema.""" """Resource selection schema."""
known_available_resources = { known_available_resources = {
sensor_id: sensor[SENSOR_NAME] sensor_id: sensor_desc.name
for sensor_id, sensor in SENSOR_TYPES.items() for sensor_id, sensor_desc in SENSOR_TYPES.items()
if sensor_id in available_resources if sensor_id in available_resources
} }
if KEY_STATUS in known_available_resources: if KEY_STATUS in known_available_resources:
known_available_resources[KEY_STATUS_DISPLAY] = SENSOR_TYPES[ known_available_resources[KEY_STATUS_DISPLAY] = SENSOR_TYPES[
KEY_STATUS_DISPLAY KEY_STATUS_DISPLAY
][SENSOR_NAME] ].name
return { return {
vol.Required(CONF_RESOURCES, default=selected_resources): cv.multi_select( vol.Required(CONF_RESOURCES, default=selected_resources): cv.multi_select(

View file

@ -1,10 +1,17 @@
"""The nut component.""" """The nut component."""
from __future__ import annotations
from typing import Final
from homeassistant.components.sensor import ( from homeassistant.components.sensor import (
DEVICE_CLASS_BATTERY, DEVICE_CLASS_BATTERY,
DEVICE_CLASS_HUMIDITY, DEVICE_CLASS_HUMIDITY,
DEVICE_CLASS_POWER, DEVICE_CLASS_POWER,
DEVICE_CLASS_TEMPERATURE, DEVICE_CLASS_TEMPERATURE,
DEVICE_CLASS_VOLTAGE, DEVICE_CLASS_VOLTAGE,
STATE_CLASS_MEASUREMENT,
SensorEntityDescription,
) )
from homeassistant.const import ( from homeassistant.const import (
ELECTRIC_CURRENT_AMPERE, ELECTRIC_CURRENT_AMPERE,
@ -40,246 +47,559 @@ PYNUT_MODEL = "model"
PYNUT_FIRMWARE = "firmware" PYNUT_FIRMWARE = "firmware"
PYNUT_NAME = "name" PYNUT_NAME = "name"
SENSOR_TYPES = { SENSOR_TYPES: Final[dict[str, SensorEntityDescription]] = {
"ups.status.display": ["Status", "", "mdi:information-outline", None], "ups.status.display": SensorEntityDescription(
"ups.status": ["Status Data", "", "mdi:information-outline", None], key="ups.status.display",
"ups.alarm": ["Alarms", "", "mdi:alarm", None], name="Status",
"ups.temperature": [ unit_of_measurement=None,
"UPS Temperature", icon="mdi:information-outline",
TEMP_CELSIUS, device_class=None,
None, state_class=None,
DEVICE_CLASS_TEMPERATURE, ),
], "ups.status": SensorEntityDescription(
"ups.load": ["Load", PERCENTAGE, "mdi:gauge", None], key="ups.status",
"ups.load.high": ["Overload Setting", PERCENTAGE, "mdi:gauge", None], name="Status Data",
"ups.id": ["System identifier", "", "mdi:information-outline", None], unit_of_measurement=None,
"ups.delay.start": ["Load Restart Delay", TIME_SECONDS, "mdi:timer-outline", None], icon="mdi:information-outline",
"ups.delay.reboot": ["UPS Reboot Delay", TIME_SECONDS, "mdi:timer-outline", None], device_class=None,
"ups.delay.shutdown": [ state_class=None,
"UPS Shutdown Delay", ),
TIME_SECONDS, "ups.alarm": SensorEntityDescription(
"mdi:timer-outline", key="ups.alarm",
None, name="Alarms",
], unit_of_measurement=None,
"ups.timer.start": ["Load Start Timer", TIME_SECONDS, "mdi:timer-outline", None], icon="mdi:alarm",
"ups.timer.reboot": ["Load Reboot Timer", TIME_SECONDS, "mdi:timer-outline", None], device_class=None,
"ups.timer.shutdown": [ state_class=None,
"Load Shutdown Timer", ),
TIME_SECONDS, "ups.temperature": SensorEntityDescription(
"mdi:timer-outline", key="ups.temperature",
None, name="UPS Temperature",
], unit_of_measurement=TEMP_CELSIUS,
"ups.test.interval": [ icon=None,
"Self-Test Interval", device_class=DEVICE_CLASS_TEMPERATURE,
TIME_SECONDS, state_class=STATE_CLASS_MEASUREMENT,
"mdi:timer-outline", ),
None, "ups.load": SensorEntityDescription(
], key="ups.load",
"ups.test.result": ["Self-Test Result", "", "mdi:information-outline", None], name="Load",
"ups.test.date": ["Self-Test Date", "", "mdi:calendar", None], unit_of_measurement=PERCENTAGE,
"ups.display.language": ["Language", "", "mdi:information-outline", None], icon="mdi:gauge",
"ups.contacts": ["External Contacts", "", "mdi:information-outline", None], device_class=None,
"ups.efficiency": ["Efficiency", PERCENTAGE, "mdi:gauge", None], state_class=STATE_CLASS_MEASUREMENT,
"ups.power": ["Current Apparent Power", POWER_VOLT_AMPERE, "mdi:flash", None], ),
"ups.power.nominal": ["Nominal Power", POWER_VOLT_AMPERE, "mdi:flash", None], "ups.load.high": SensorEntityDescription(
"ups.realpower": [ key="ups.load.high",
"Current Real Power", name="Overload Setting",
POWER_WATT, unit_of_measurement=PERCENTAGE,
None, icon="mdi:gauge",
DEVICE_CLASS_POWER, device_class=None,
], state_class=None,
"ups.realpower.nominal": [ ),
"Nominal Real Power", "ups.id": SensorEntityDescription(
POWER_WATT, key="ups.id",
None, name="System identifier",
DEVICE_CLASS_POWER, unit_of_measurement=None,
], icon="mdi:information-outline",
"ups.beeper.status": ["Beeper Status", "", "mdi:information-outline", None], device_class=None,
"ups.type": ["UPS Type", "", "mdi:information-outline", None], state_class=None,
"ups.watchdog.status": ["Watchdog Status", "", "mdi:information-outline", None], ),
"ups.start.auto": ["Start on AC", "", "mdi:information-outline", None], "ups.delay.start": SensorEntityDescription(
"ups.start.battery": ["Start on Battery", "", "mdi:information-outline", None], key="ups.delay.start",
"ups.start.reboot": ["Reboot on Battery", "", "mdi:information-outline", None], name="Load Restart Delay",
"ups.shutdown": ["Shutdown Ability", "", "mdi:information-outline", None], unit_of_measurement=TIME_SECONDS,
"battery.charge": [ icon="mdi:timer-outline",
"Battery Charge", device_class=None,
PERCENTAGE, state_class=None,
None, ),
DEVICE_CLASS_BATTERY, "ups.delay.reboot": SensorEntityDescription(
], key="ups.delay.reboot",
"battery.charge.low": ["Low Battery Setpoint", PERCENTAGE, "mdi:gauge", None], name="UPS Reboot Delay",
"battery.charge.restart": [ unit_of_measurement=TIME_SECONDS,
"Minimum Battery to Start", icon="mdi:timer-outline",
PERCENTAGE, device_class=None,
"mdi:gauge", state_class=None,
None, ),
], "ups.delay.shutdown": SensorEntityDescription(
"battery.charge.warning": [ key="ups.delay.shutdown",
"Warning Battery Setpoint", name="UPS Shutdown Delay",
PERCENTAGE, unit_of_measurement=TIME_SECONDS,
"mdi:gauge", icon="mdi:timer-outline",
None, device_class=None,
], state_class=None,
"battery.charger.status": ["Charging Status", "", "mdi:information-outline", None], ),
"battery.voltage": [ "ups.timer.start": SensorEntityDescription(
"Battery Voltage", key="ups.timer.start",
ELECTRIC_POTENTIAL_VOLT, name="Load Start Timer",
None, unit_of_measurement=TIME_SECONDS,
DEVICE_CLASS_VOLTAGE, icon="mdi:timer-outline",
], device_class=None,
"battery.voltage.nominal": [ state_class=None,
"Nominal Battery Voltage", ),
ELECTRIC_POTENTIAL_VOLT, "ups.timer.reboot": SensorEntityDescription(
None, key="ups.timer.reboot",
DEVICE_CLASS_VOLTAGE, name="Load Reboot Timer",
], unit_of_measurement=TIME_SECONDS,
"battery.voltage.low": [ icon="mdi:timer-outline",
"Low Battery Voltage", device_class=None,
ELECTRIC_POTENTIAL_VOLT, state_class=None,
None, ),
DEVICE_CLASS_VOLTAGE, "ups.timer.shutdown": SensorEntityDescription(
], key="ups.timer.shutdown",
"battery.voltage.high": [ name="Load Shutdown Timer",
"High Battery Voltage", unit_of_measurement=TIME_SECONDS,
ELECTRIC_POTENTIAL_VOLT, icon="mdi:timer-outline",
None, device_class=None,
DEVICE_CLASS_VOLTAGE, state_class=None,
], ),
"battery.capacity": ["Battery Capacity", "Ah", "mdi:flash", None], "ups.test.interval": SensorEntityDescription(
"battery.current": [ key="ups.test.interval",
"Battery Current", name="Self-Test Interval",
ELECTRIC_CURRENT_AMPERE, unit_of_measurement=TIME_SECONDS,
"mdi:flash", icon="mdi:timer-outline",
None, device_class=None,
], state_class=None,
"battery.current.total": [ ),
"Total Battery Current", "ups.test.result": SensorEntityDescription(
ELECTRIC_CURRENT_AMPERE, key="ups.test.result",
"mdi:flash", name="Self-Test Result",
None, unit_of_measurement=None,
], icon="mdi:information-outline",
"battery.temperature": [ device_class=None,
"Battery Temperature", state_class=None,
TEMP_CELSIUS, ),
None, "ups.test.date": SensorEntityDescription(
DEVICE_CLASS_TEMPERATURE, key="ups.test.date",
], name="Self-Test Date",
"battery.runtime": ["Battery Runtime", TIME_SECONDS, "mdi:timer-outline", None], unit_of_measurement=None,
"battery.runtime.low": [ icon="mdi:calendar",
"Low Battery Runtime", device_class=None,
TIME_SECONDS, state_class=None,
"mdi:timer-outline", ),
None, "ups.display.language": SensorEntityDescription(
], key="ups.display.language",
"battery.runtime.restart": [ name="Language",
"Minimum Battery Runtime to Start", unit_of_measurement=None,
TIME_SECONDS, icon="mdi:information-outline",
"mdi:timer-outline", device_class=None,
None, state_class=None,
], ),
"battery.alarm.threshold": [ "ups.contacts": SensorEntityDescription(
"Battery Alarm Threshold", key="ups.contacts",
"", name="External Contacts",
"mdi:information-outline", unit_of_measurement=None,
None, icon="mdi:information-outline",
], device_class=None,
"battery.date": ["Battery Date", "", "mdi:calendar", None], state_class=None,
"battery.mfr.date": ["Battery Manuf. Date", "", "mdi:calendar", None], ),
"battery.packs": ["Number of Batteries", "", "mdi:information-outline", None], "ups.efficiency": SensorEntityDescription(
"battery.packs.bad": [ key="ups.efficiency",
"Number of Bad Batteries", name="Efficiency",
"", unit_of_measurement=PERCENTAGE,
"mdi:information-outline", icon="mdi:gauge",
None, device_class=None,
], state_class=STATE_CLASS_MEASUREMENT,
"battery.type": ["Battery Chemistry", "", "mdi:information-outline", None], ),
"input.sensitivity": [ "ups.power": SensorEntityDescription(
"Input Power Sensitivity", key="ups.power",
"", name="Current Apparent Power",
"mdi:information-outline", unit_of_measurement=POWER_VOLT_AMPERE,
None, icon="mdi:flash",
], device_class=None,
"input.transfer.low": [ state_class=STATE_CLASS_MEASUREMENT,
"Low Voltage Transfer", ),
ELECTRIC_POTENTIAL_VOLT, "ups.power.nominal": SensorEntityDescription(
None, key="ups.power.nominal",
DEVICE_CLASS_VOLTAGE, name="Nominal Power",
], unit_of_measurement=POWER_VOLT_AMPERE,
"input.transfer.high": [ icon="mdi:flash",
"High Voltage Transfer", device_class=None,
ELECTRIC_POTENTIAL_VOLT, state_class=None,
None, ),
DEVICE_CLASS_VOLTAGE, "ups.realpower": SensorEntityDescription(
], key="ups.realpower",
"input.transfer.reason": [ name="Current Real Power",
"Voltage Transfer Reason", unit_of_measurement=POWER_WATT,
"", icon=None,
"mdi:information-outline", device_class=DEVICE_CLASS_POWER,
None, state_class=STATE_CLASS_MEASUREMENT,
], ),
"input.voltage": [ "ups.realpower.nominal": SensorEntityDescription(
"Input Voltage", key="ups.realpower.nominal",
ELECTRIC_POTENTIAL_VOLT, name="Nominal Real Power",
None, unit_of_measurement=POWER_WATT,
DEVICE_CLASS_VOLTAGE, icon=None,
], device_class=DEVICE_CLASS_POWER,
"input.voltage.nominal": [ state_class=None,
"Nominal Input Voltage", ),
ELECTRIC_POTENTIAL_VOLT, "ups.beeper.status": SensorEntityDescription(
None, key="ups.beeper.status",
DEVICE_CLASS_VOLTAGE, name="Beeper Status",
], unit_of_measurement=None,
"input.frequency": ["Input Line Frequency", FREQUENCY_HERTZ, "mdi:flash", None], icon="mdi:information-outline",
"input.frequency.nominal": [ device_class=None,
"Nominal Input Line Frequency", state_class=None,
FREQUENCY_HERTZ, ),
"mdi:flash", "ups.type": SensorEntityDescription(
None, key="ups.type",
], name="UPS Type",
"input.frequency.status": [ unit_of_measurement=None,
"Input Frequency Status", icon="mdi:information-outline",
"", device_class=None,
"mdi:information-outline", state_class=None,
None, ),
], "ups.watchdog.status": SensorEntityDescription(
"output.current": ["Output Current", ELECTRIC_CURRENT_AMPERE, "mdi:flash", None], key="ups.watchdog.status",
"output.current.nominal": [ name="Watchdog Status",
"Nominal Output Current", unit_of_measurement=None,
ELECTRIC_CURRENT_AMPERE, icon="mdi:information-outline",
"mdi:flash", device_class=None,
None, state_class=None,
], ),
"output.voltage": [ "ups.start.auto": SensorEntityDescription(
"Output Voltage", key="ups.start.auto",
ELECTRIC_POTENTIAL_VOLT, name="Start on AC",
None, unit_of_measurement=None,
DEVICE_CLASS_VOLTAGE, icon="mdi:information-outline",
], device_class=None,
"output.voltage.nominal": [ state_class=None,
"Nominal Output Voltage", ),
ELECTRIC_POTENTIAL_VOLT, "ups.start.battery": SensorEntityDescription(
None, key="ups.start.battery",
DEVICE_CLASS_VOLTAGE, name="Start on Battery",
], unit_of_measurement=None,
"output.frequency": ["Output Frequency", FREQUENCY_HERTZ, "mdi:flash", None], icon="mdi:information-outline",
"output.frequency.nominal": [ device_class=None,
"Nominal Output Frequency", state_class=None,
FREQUENCY_HERTZ, ),
"mdi:flash", "ups.start.reboot": SensorEntityDescription(
None, key="ups.start.reboot",
], name="Reboot on Battery",
"ambient.humidity": [ unit_of_measurement=None,
"Ambient Humidity", icon="mdi:information-outline",
PERCENTAGE, device_class=None,
None, state_class=None,
DEVICE_CLASS_HUMIDITY, ),
], "ups.shutdown": SensorEntityDescription(
"ambient.temperature": [ key="ups.shutdown",
"Ambient Temperature", name="Shutdown Ability",
TEMP_CELSIUS, unit_of_measurement=None,
None, icon="mdi:information-outline",
DEVICE_CLASS_TEMPERATURE, device_class=None,
], state_class=None,
),
"battery.charge": SensorEntityDescription(
key="battery.charge",
name="Battery Charge",
unit_of_measurement=PERCENTAGE,
icon=None,
device_class=DEVICE_CLASS_BATTERY,
state_class=STATE_CLASS_MEASUREMENT,
),
"battery.charge.low": SensorEntityDescription(
key="battery.charge.low",
name="Low Battery Setpoint",
unit_of_measurement=PERCENTAGE,
icon="mdi:gauge",
device_class=None,
state_class=None,
),
"battery.charge.restart": SensorEntityDescription(
key="battery.charge.restart",
name="Minimum Battery to Start",
unit_of_measurement=PERCENTAGE,
icon="mdi:gauge",
device_class=None,
state_class=None,
),
"battery.charge.warning": SensorEntityDescription(
key="battery.charge.warning",
name="Warning Battery Setpoint",
unit_of_measurement=PERCENTAGE,
icon="mdi:gauge",
device_class=None,
state_class=None,
),
"battery.charger.status": SensorEntityDescription(
key="battery.charger.status",
name="Charging Status",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"battery.voltage": SensorEntityDescription(
key="battery.voltage",
name="Battery Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=STATE_CLASS_MEASUREMENT,
),
"battery.voltage.nominal": SensorEntityDescription(
key="battery.voltage.nominal",
name="Nominal Battery Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"battery.voltage.low": SensorEntityDescription(
key="battery.voltage.low",
name="Low Battery Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"battery.voltage.high": SensorEntityDescription(
key="battery.voltage.high",
name="High Battery Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"battery.capacity": SensorEntityDescription(
key="battery.capacity",
name="Battery Capacity",
unit_of_measurement="Ah",
icon="mdi:flash",
device_class=None,
state_class=None,
),
"battery.current": SensorEntityDescription(
key="battery.current",
name="Battery Current",
unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
icon="mdi:flash",
device_class=None,
state_class=STATE_CLASS_MEASUREMENT,
),
"battery.current.total": SensorEntityDescription(
key="battery.current.total",
name="Total Battery Current",
unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
icon="mdi:flash",
device_class=None,
state_class=None,
),
"battery.temperature": SensorEntityDescription(
key="battery.temperature",
name="Battery Temperature",
unit_of_measurement=TEMP_CELSIUS,
icon=None,
device_class=DEVICE_CLASS_TEMPERATURE,
state_class=STATE_CLASS_MEASUREMENT,
),
"battery.runtime": SensorEntityDescription(
key="battery.runtime",
name="Battery Runtime",
unit_of_measurement=TIME_SECONDS,
icon="mdi:timer-outline",
device_class=None,
state_class=None,
),
"battery.runtime.low": SensorEntityDescription(
key="battery.runtime.low",
name="Low Battery Runtime",
unit_of_measurement=TIME_SECONDS,
icon="mdi:timer-outline",
device_class=None,
state_class=None,
),
"battery.runtime.restart": SensorEntityDescription(
key="battery.runtime.restart",
name="Minimum Battery Runtime to Start",
unit_of_measurement=TIME_SECONDS,
icon="mdi:timer-outline",
device_class=None,
state_class=None,
),
"battery.alarm.threshold": SensorEntityDescription(
key="battery.alarm.threshold",
name="Battery Alarm Threshold",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"battery.date": SensorEntityDescription(
key="battery.date",
name="Battery Date",
unit_of_measurement=None,
icon="mdi:calendar",
device_class=None,
state_class=None,
),
"battery.mfr.date": SensorEntityDescription(
key="battery.mfr.date",
name="Battery Manuf. Date",
unit_of_measurement=None,
icon="mdi:calendar",
device_class=None,
state_class=None,
),
"battery.packs": SensorEntityDescription(
key="battery.packs",
name="Number of Batteries",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"battery.packs.bad": SensorEntityDescription(
key="battery.packs.bad",
name="Number of Bad Batteries",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"battery.type": SensorEntityDescription(
key="battery.type",
name="Battery Chemistry",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"input.sensitivity": SensorEntityDescription(
key="input.sensitivity",
name="Input Power Sensitivity",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"input.transfer.low": SensorEntityDescription(
key="input.transfer.low",
name="Low Voltage Transfer",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"input.transfer.high": SensorEntityDescription(
key="input.transfer.high",
name="High Voltage Transfer",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"input.transfer.reason": SensorEntityDescription(
key="input.transfer.reason",
name="Voltage Transfer Reason",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"input.voltage": SensorEntityDescription(
key="input.voltage",
name="Input Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=STATE_CLASS_MEASUREMENT,
),
"input.voltage.nominal": SensorEntityDescription(
key="input.voltage.nominal",
name="Nominal Input Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"input.frequency": SensorEntityDescription(
key="input.frequency",
name="Input Line Frequency",
unit_of_measurement=FREQUENCY_HERTZ,
icon="mdi:flash",
device_class=None,
state_class=STATE_CLASS_MEASUREMENT,
),
"input.frequency.nominal": SensorEntityDescription(
key="input.frequency.nominal",
name="Nominal Input Line Frequency",
unit_of_measurement=FREQUENCY_HERTZ,
icon="mdi:flash",
device_class=None,
state_class=None,
),
"input.frequency.status": SensorEntityDescription(
key="input.frequency.status",
name="Input Frequency Status",
unit_of_measurement=None,
icon="mdi:information-outline",
device_class=None,
state_class=None,
),
"output.current": SensorEntityDescription(
key="output.current",
name="Output Current",
unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
icon="mdi:flash",
device_class=None,
state_class=STATE_CLASS_MEASUREMENT,
),
"output.current.nominal": SensorEntityDescription(
key="output.current.nominal",
name="Nominal Output Current",
unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
icon="mdi:flash",
device_class=None,
state_class=None,
),
"output.voltage": SensorEntityDescription(
key="output.voltage",
name="Output Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=STATE_CLASS_MEASUREMENT,
),
"output.voltage.nominal": SensorEntityDescription(
key="output.voltage.nominal",
name="Nominal Output Voltage",
unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
icon=None,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=None,
),
"output.frequency": SensorEntityDescription(
key="output.frequency",
name="Output Frequency",
unit_of_measurement=FREQUENCY_HERTZ,
icon="mdi:flash",
device_class=None,
state_class=STATE_CLASS_MEASUREMENT,
),
"output.frequency.nominal": SensorEntityDescription(
key="output.frequency.nominal",
name="Nominal Output Frequency",
unit_of_measurement=FREQUENCY_HERTZ,
icon="mdi:flash",
device_class=None,
state_class=None,
),
"ambient.humidity": SensorEntityDescription(
key="ambient.humidity",
name="Ambient Humidity",
unit_of_measurement=PERCENTAGE,
icon=None,
device_class=DEVICE_CLASS_HUMIDITY,
state_class=STATE_CLASS_MEASUREMENT,
),
"ambient.temperature": SensorEntityDescription(
key="ambient.temperature",
name="Ambient Temperature",
unit_of_measurement=TEMP_CELSIUS,
icon=None,
device_class=DEVICE_CLASS_TEMPERATURE,
state_class=STATE_CLASS_MEASUREMENT,
),
} }
STATE_TYPES = { STATE_TYPES = {
@ -299,8 +619,3 @@ STATE_TYPES = {
"FSD": "Forced Shutdown", "FSD": "Forced Shutdown",
"ALARM": "Alarm", "ALARM": "Alarm",
} }
SENSOR_NAME = 0
SENSOR_UNIT = 1
SENSOR_ICON = 2
SENSOR_DEVICE_CLASS = 3

View file

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