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

Refactor mysensors sensor description (#54522)

Browse Source 
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
Martin Hjelmare 2021-08-16 16:34:22 +02:00 committed by GitHub
parent 512a474e93
commit 494fd21351
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 165 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

270
homeassistant/components/mysensors/sensor.py
View File

@ -1,7 +1,7 @@
"""Support for MySensors sensors.""" """Support for MySensors sensors."""
from __future__ import annotations from __future__ import annotations
from datetime import datetime from typing import Any
from awesomeversion import AwesomeVersion from awesomeversion import AwesomeVersion
@ -10,6 +10,7 @@ from homeassistant.components.sensor import (
DOMAIN, DOMAIN,
STATE_CLASS_MEASUREMENT, STATE_CLASS_MEASUREMENT,
SensorEntity, SensorEntity,
SensorEntityDescription,
) )
from homeassistant.config_entries import ConfigEntry from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ( from homeassistant.const import (
@ -46,64 +47,150 @@ from homeassistant.util.dt import utc_from_timestamp
from .const import MYSENSORS_DISCOVERY, DiscoveryInfo from .const import MYSENSORS_DISCOVERY, DiscoveryInfo
from .helpers import on_unload from .helpers import on_unload
SENSORS: dict[str, list[str | None] | dict[str, list[str | None]]] = { SENSORS: dict[str, SensorEntityDescription] = {
"V_TEMP": [None, None, DEVICE_CLASS_TEMPERATURE, STATE_CLASS_MEASUREMENT], "V_TEMP": SensorEntityDescription(
"V_HUM": [ key="V_TEMP",
PERCENTAGE, device_class=DEVICE_CLASS_TEMPERATURE,
"mdi:water-percent", state_class=STATE_CLASS_MEASUREMENT,
DEVICE_CLASS_HUMIDITY, ),
STATE_CLASS_MEASUREMENT, "V_HUM": SensorEntityDescription(
], key="V_HUM",
"V_DIMMER": [PERCENTAGE, "mdi:percent", None, None], native_unit_of_measurement=PERCENTAGE,
"V_PERCENTAGE": [PERCENTAGE, "mdi:percent", None, None], device_class=DEVICE_CLASS_HUMIDITY,
"V_PRESSURE": [None, "mdi:gauge", None, None], state_class=STATE_CLASS_MEASUREMENT,
"V_FORECAST": [None, "mdi:weather-partly-cloudy", None, None], ),
"V_RAIN": [None, "mdi:weather-rainy", None, None], "V_DIMMER": SensorEntityDescription(
"V_RAINRATE": [None, "mdi:weather-rainy", None, None], key="V_DIMMER",
"V_WIND": [None, "mdi:weather-windy", None, None], native_unit_of_measurement=PERCENTAGE,
"V_GUST": [None, "mdi:weather-windy", None, None], icon="mdi:percent",
"V_DIRECTION": [DEGREE, "mdi:compass", None, None], ),
"V_WEIGHT": [MASS_KILOGRAMS, "mdi:weight-kilogram", None, None], "V_PERCENTAGE": SensorEntityDescription(
"V_DISTANCE": [LENGTH_METERS, "mdi:ruler", None, None], key="V_PERCENTAGE",
"V_IMPEDANCE": ["ohm", None, None, None], native_unit_of_measurement=PERCENTAGE,
"V_WATT": [POWER_WATT, None, DEVICE_CLASS_POWER, STATE_CLASS_MEASUREMENT], icon="mdi:percent",
"V_KWH": [ ),
ENERGY_KILO_WATT_HOUR, "V_PRESSURE": SensorEntityDescription(
None, key="V_PRESSURE",
DEVICE_CLASS_ENERGY, icon="mdi:gauge",
STATE_CLASS_MEASUREMENT, ),
], "V_FORECAST": SensorEntityDescription(
"V_LIGHT_LEVEL": [PERCENTAGE, "mdi:white-balance-sunny", None, None], key="V_FORECAST",
"V_FLOW": [LENGTH_METERS, "mdi:gauge", None, None], icon="mdi:weather-partly-cloudy",
"V_VOLUME": [VOLUME_CUBIC_METERS, None, None, None], ),
"V_LEVEL": { "V_RAIN": SensorEntityDescription(
"S_SOUND": [SOUND_PRESSURE_DB, "mdi:volume-high", None, None], key="V_RAIN",
"S_VIBRATION": [FREQUENCY_HERTZ, None, None, None], icon="mdi:weather-rainy",
"S_LIGHT_LEVEL": [ ),
LIGHT_LUX, "V_RAINRATE": SensorEntityDescription(
"mdi:white-balance-sunny", key="V_RAINRATE",
DEVICE_CLASS_ILLUMINANCE, icon="mdi:weather-rainy",
STATE_CLASS_MEASUREMENT, ),
], "V_WIND": SensorEntityDescription(
"S_MOISTURE": [PERCENTAGE, "mdi:water-percent", None, None], key="V_WIND",
}, icon="mdi:weather-windy",
"V_VOLTAGE": [ ),
ELECTRIC_POTENTIAL_VOLT, "V_GUST": SensorEntityDescription(
"mdi:flash", key="V_GUST",
DEVICE_CLASS_VOLTAGE, icon="mdi:weather-windy",
STATE_CLASS_MEASUREMENT, ),
], "V_DIRECTION": SensorEntityDescription(
"V_CURRENT": [ key="V_DIRECTION",
ELECTRIC_CURRENT_AMPERE, native_unit_of_measurement=DEGREE,
"mdi:flash-auto", icon="mdi:compass",
DEVICE_CLASS_CURRENT, ),
STATE_CLASS_MEASUREMENT, "V_WEIGHT": SensorEntityDescription(
], key="V_WEIGHT",
"V_PH": ["pH", None, None, None], native_unit_of_measurement=MASS_KILOGRAMS,
"V_ORP": [ELECTRIC_POTENTIAL_MILLIVOLT, None, None, None], icon="mdi:weight-kilogram",
"V_EC": [CONDUCTIVITY, None, None, None], ),
"V_VAR": ["var", None, None, None], "V_DISTANCE": SensorEntityDescription(
"V_VA": [POWER_VOLT_AMPERE, None, None, None], key="V_DISTANCE",
native_unit_of_measurement=LENGTH_METERS,
icon="mdi:ruler",
),
"V_IMPEDANCE": SensorEntityDescription(
key="V_IMPEDANCE",
native_unit_of_measurement="ohm",
),
"V_WATT": SensorEntityDescription(
key="V_WATT",
native_unit_of_measurement=POWER_WATT,
device_class=DEVICE_CLASS_POWER,
state_class=STATE_CLASS_MEASUREMENT,
),
"V_KWH": SensorEntityDescription(
key="V_KWH",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY,
state_class=STATE_CLASS_MEASUREMENT,
last_reset=utc_from_timestamp(0),
),
"V_LIGHT_LEVEL": SensorEntityDescription(
key="V_LIGHT_LEVEL",
native_unit_of_measurement=PERCENTAGE,
icon="mdi:white-balance-sunny",
),
"V_FLOW": SensorEntityDescription(
key="V_FLOW",
native_unit_of_measurement=LENGTH_METERS,
icon="mdi:gauge",
),
"V_VOLUME": SensorEntityDescription(
key="V_VOLUME",
native_unit_of_measurement=VOLUME_CUBIC_METERS,
),
"V_LEVEL_S_SOUND": SensorEntityDescription(
key="V_LEVEL_S_SOUND",
native_unit_of_measurement=SOUND_PRESSURE_DB,
icon="mdi:volume-high",
),
"V_LEVEL_S_VIBRATION": SensorEntityDescription(
key="V_LEVEL_S_VIBRATION",
native_unit_of_measurement=FREQUENCY_HERTZ,
),
"V_LEVEL_S_LIGHT_LEVEL": SensorEntityDescription(
key="V_LEVEL_S_LIGHT_LEVEL",
native_unit_of_measurement=LIGHT_LUX,
device_class=DEVICE_CLASS_ILLUMINANCE,
state_class=STATE_CLASS_MEASUREMENT,
),
"V_LEVEL_S_MOISTURE": SensorEntityDescription(
key="V_LEVEL_S_MOISTURE",
native_unit_of_measurement=PERCENTAGE,
icon="mdi:water-percent",
),
"V_VOLTAGE": SensorEntityDescription(
key="V_VOLTAGE",
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=STATE_CLASS_MEASUREMENT,
),
"V_CURRENT": SensorEntityDescription(
key="V_CURRENT",
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
device_class=DEVICE_CLASS_CURRENT,
state_class=STATE_CLASS_MEASUREMENT,
),
"V_PH": SensorEntityDescription(
key="V_PH",
native_unit_of_measurement="pH",
),
"V_ORP": SensorEntityDescription(
key="V_ORP",
native_unit_of_measurement=ELECTRIC_POTENTIAL_MILLIVOLT,
),
"V_EC": SensorEntityDescription(
key="V_EC",
native_unit_of_measurement=CONDUCTIVITY,
),
"V_VAR": SensorEntityDescription(
key="V_VAR",
native_unit_of_measurement="var",
),
"V_VA": SensorEntityDescription(
key="V_VA",
native_unit_of_measurement=POWER_VOLT_AMPERE,
),
} }
@ -138,44 +225,19 @@ async def async_setup_entry(
class MySensorsSensor(mysensors.device.MySensorsEntity, SensorEntity): class MySensorsSensor(mysensors.device.MySensorsEntity, SensorEntity):
"""Representation of a MySensors Sensor child node.""" """Representation of a MySensors Sensor child node."""
@property _attr_force_update = True
def force_update(self) -> bool:
"""Return True if state updates should be forced.
If True, a state change will be triggered anytime the state property is def __init__(self, *args: Any, **kwargs: Any) -> None:
updated, not just when the value changes. """Set up the instance."""
""" super().__init__(*args, **kwargs)
return True if entity_description := self._get_entity_description():
self.entity_description = entity_description
@property @property
def native_value(self) -> str | None: def native_value(self) -> str | None:
"""Return the state of the device.""" """Return the state of the sensor."""
return self._values.get(self.value_type) return self._values.get(self.value_type)
@property
def device_class(self) -> str | None:
"""Return the device class of this entity."""
return self._get_sensor_type()[2]
@property
def icon(self) -> str | None:
"""Return the icon to use in the frontend, if any."""
return self._get_sensor_type()[1]
@property
def last_reset(self) -> datetime | None:
"""Return the time when the sensor was last reset, if any."""
set_req = self.gateway.const.SetReq
if set_req(self.value_type).name == "V_KWH":
return utc_from_timestamp(0)
return None
@property
def state_class(self) -> str | None:
"""Return the state class of this entity."""
return self._get_sensor_type()[3]
@property @property
def native_unit_of_measurement(self) -> str | None: def native_unit_of_measurement(self) -> str | None:
"""Return the unit of measurement of this entity.""" """Return the unit of measurement of this entity."""
@ -192,21 +254,19 @@ class MySensorsSensor(mysensors.device.MySensorsEntity, SensorEntity):
return TEMP_CELSIUS return TEMP_CELSIUS
return TEMP_FAHRENHEIT return TEMP_FAHRENHEIT
unit = self._get_sensor_type()[0] if hasattr(self, "entity_description"):
return unit return self.entity_description.native_unit_of_measurement
return None
def _get_sensor_type(self) -> list[str | None]: def _get_entity_description(self) -> SensorEntityDescription | None:
"""Return list with unit and icon of sensor type.""" """Return the sensor entity description."""
pres = self.gateway.const.Presentation
set_req = self.gateway.const.SetReq set_req = self.gateway.const.SetReq
entity_description = SENSORS.get(set_req(self.value_type).name)
_sensor_type = SENSORS.get( if not entity_description:
set_req(self.value_type).name, [None, None, None, None] pres = self.gateway.const.Presentation
) entity_description = SENSORS.get(
if isinstance(_sensor_type, dict): f"{set_req(self.value_type).name}_{pres(self.child_type).name}"
sensor_type = _sensor_type.get(
pres(self.child_type).name, [None, None, None, None]
) )
else:
sensor_type = _sensor_type return entity_description
return sensor_type