Add state_class and device_class to Solarlog platform (#53946)

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Ernst Klamer 2021-08-23 22:11:20 +02:00 committed by GitHub
parent 3bd309299e
commit 4a57392881
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 231 additions and 144 deletions

View file

@ -1,7 +1,20 @@
"""Constants for the Solar-Log integration."""
from __future__ import annotations
from dataclasses import dataclass
from datetime import timedelta
from homeassistant.components.sensor import (
STATE_CLASS_MEASUREMENT,
STATE_CLASS_TOTAL_INCREASING,
SensorEntityDescription,
)
from homeassistant.const import (
DEVICE_CLASS_ENERGY,
DEVICE_CLASS_POWER,
DEVICE_CLASS_POWER_FACTOR,
DEVICE_CLASS_TIMESTAMP,
DEVICE_CLASS_VOLTAGE,
ELECTRIC_POTENTIAL_VOLT,
ENERGY_KILO_WATT_HOUR,
PERCENTAGE,
@ -17,83 +30,187 @@ DEFAULT_NAME = "solarlog"
"""Fixed constants."""
SCAN_INTERVAL = timedelta(seconds=60)
"""Supported sensor types."""
SENSOR_TYPES = {
"time": ["TIME", "last update", None, "mdi:calendar-clock"],
"power_ac": ["powerAC", "power AC", POWER_WATT, "mdi:solar-power"],
"power_dc": ["powerDC", "power DC", POWER_WATT, "mdi:solar-power"],
"voltage_ac": ["voltageAC", "voltage AC", ELECTRIC_POTENTIAL_VOLT, "mdi:flash"],
"voltage_dc": ["voltageDC", "voltage DC", ELECTRIC_POTENTIAL_VOLT, "mdi:flash"],
"yield_day": ["yieldDAY", "yield day", ENERGY_KILO_WATT_HOUR, "mdi:solar-power"],
"yield_yesterday": [
"yieldYESTERDAY",
"yield yesterday",
ENERGY_KILO_WATT_HOUR,
"mdi:solar-power",
],
"yield_month": [
"yieldMONTH",
"yield month",
ENERGY_KILO_WATT_HOUR,
"mdi:solar-power",
],
"yield_year": ["yieldYEAR", "yield year", ENERGY_KILO_WATT_HOUR, "mdi:solar-power"],
"yield_total": [
"yieldTOTAL",
"yield total",
ENERGY_KILO_WATT_HOUR,
"mdi:solar-power",
],
"consumption_ac": ["consumptionAC", "consumption AC", POWER_WATT, "mdi:power-plug"],
"consumption_day": [
"consumptionDAY",
"consumption day",
ENERGY_KILO_WATT_HOUR,
"mdi:power-plug",
],
"consumption_yesterday": [
"consumptionYESTERDAY",
"consumption yesterday",
ENERGY_KILO_WATT_HOUR,
"mdi:power-plug",
],
"consumption_month": [
"consumptionMONTH",
"consumption month",
ENERGY_KILO_WATT_HOUR,
"mdi:power-plug",
],
"consumption_year": [
"consumptionYEAR",
"consumption year",
ENERGY_KILO_WATT_HOUR,
"mdi:power-plug",
],
"consumption_total": [
"consumptionTOTAL",
"consumption total",
ENERGY_KILO_WATT_HOUR,
"mdi:power-plug",
],
"total_power": ["totalPOWER", "total power", "Wp", "mdi:solar-power"],
"alternator_loss": [
"alternatorLOSS",
"alternator loss",
POWER_WATT,
"mdi:solar-power",
],
"capacity": ["CAPACITY", "capacity", PERCENTAGE, "mdi:solar-power"],
"efficiency": [
"EFFICIENCY",
"efficiency",
f"% {POWER_WATT}/{POWER_WATT}p",
"mdi:solar-power",
],
"power_available": [
"powerAVAILABLE",
"power available",
POWER_WATT,
"mdi:solar-power",
],
"usage": ["USAGE", "usage", None, "mdi:solar-power"],
}
@dataclass
class SolarlogRequiredKeysMixin:
"""Mixin for required keys."""
json_key: str
@dataclass
class SolarLogSensorEntityDescription(
SensorEntityDescription, SolarlogRequiredKeysMixin
):
"""Describes Solarlog sensor entity."""
SENSOR_TYPES: tuple[SolarLogSensorEntityDescription, ...] = (
SolarLogSensorEntityDescription(
key="time",
json_key="TIME",
name="last update",
device_class=DEVICE_CLASS_TIMESTAMP,
),
SolarLogSensorEntityDescription(
key="power_ac",
json_key="powerAC",
name="power AC",
icon="mdi:solar-power",
native_unit_of_measurement=POWER_WATT,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="power_dc",
json_key="powerDC",
name="power DC",
icon="mdi:solar-power",
native_unit_of_measurement=POWER_WATT,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="voltage_ac",
json_key="voltageAC",
name="voltage AC",
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="voltage_dc",
json_key="voltageDC",
name="voltage DC",
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
device_class=DEVICE_CLASS_VOLTAGE,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="yield_day",
json_key="yieldDAY",
name="yield day",
icon="mdi:solar-power",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
),
SolarLogSensorEntityDescription(
key="yield_yesterday",
json_key="yieldYESTERDAY",
name="yield yesterday",
icon="mdi:solar-power",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
),
SolarLogSensorEntityDescription(
key="yield_month",
json_key="yieldMONTH",
name="yield month",
icon="mdi:solar-power",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
),
SolarLogSensorEntityDescription(
key="yield_year",
json_key="yieldYEAR",
name="yield year",
icon="mdi:solar-power",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
),
SolarLogSensorEntityDescription(
key="yield_total",
json_key="yieldTOTAL",
name="yield total",
icon="mdi:solar-power",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
state_class=STATE_CLASS_TOTAL_INCREASING,
),
SolarLogSensorEntityDescription(
key="consumption_ac",
json_key="consumptionAC",
name="consumption AC",
native_unit_of_measurement=POWER_WATT,
device_class=DEVICE_CLASS_POWER,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="consumption_day",
json_key="consumptionDAY",
name="consumption day",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY,
),
SolarLogSensorEntityDescription(
key="consumption_yesterday",
json_key="consumptionYESTERDAY",
name="consumption yesterday",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY,
),
SolarLogSensorEntityDescription(
key="consumption_month",
json_key="consumptionMONTH",
name="consumption month",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY,
),
SolarLogSensorEntityDescription(
key="consumption_year",
json_key="consumptionYEAR",
name="consumption year",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY,
),
SolarLogSensorEntityDescription(
key="consumption_total",
json_key="consumptionTOTAL",
name="consumption total",
native_unit_of_measurement=ENERGY_KILO_WATT_HOUR,
device_class=DEVICE_CLASS_ENERGY,
state_class=STATE_CLASS_TOTAL_INCREASING,
),
SolarLogSensorEntityDescription(
key="total_power",
json_key="totalPOWER",
name="total power",
icon="mdi:solar-power",
native_unit_of_measurement="Wp",
),
SolarLogSensorEntityDescription(
key="alternator_loss",
json_key="alternatorLOSS",
name="alternator loss",
icon="mdi:solar-power",
native_unit_of_measurement=POWER_WATT,
device_class=DEVICE_CLASS_POWER,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="capacity",
json_key="CAPACITY",
name="capacity",
icon="mdi:solar-power",
native_unit_of_measurement="W/Wp",
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="efficiency",
json_key="EFFICIENCY",
name="efficiency",
native_unit_of_measurement=PERCENTAGE,
device_class=DEVICE_CLASS_POWER_FACTOR,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="power_available",
json_key="powerAVAILABLE",
name="power available",
icon="mdi:solar-power",
native_unit_of_measurement=POWER_WATT,
device_class=DEVICE_CLASS_POWER,
state_class=STATE_CLASS_MEASUREMENT,
),
SolarLogSensorEntityDescription(
key="usage",
json_key="USAGE",
name="usage",
native_unit_of_measurement=PERCENTAGE,
device_class=DEVICE_CLASS_POWER_FACTOR,
state_class=STATE_CLASS_MEASUREMENT,
),
)