1085 lines
38 KiB
Python
1085 lines
38 KiB
Python
"""Support for Tuya sensors."""
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
|
|
from tuya_iot import TuyaDevice, TuyaDeviceManager
|
|
from tuya_iot.device import TuyaDeviceStatusRange
|
|
|
|
from homeassistant.components.sensor import (
|
|
SensorDeviceClass,
|
|
SensorEntity,
|
|
SensorEntityDescription,
|
|
SensorStateClass,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
ELECTRIC_CURRENT_AMPERE,
|
|
ELECTRIC_POTENTIAL_VOLT,
|
|
PERCENTAGE,
|
|
POWER_KILO_WATT,
|
|
)
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
|
from homeassistant.helpers.entity import EntityCategory
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import StateType
|
|
|
|
from . import HomeAssistantTuyaData
|
|
from .base import ElectricityTypeData, EnumTypeData, IntegerTypeData, TuyaEntity
|
|
from .const import (
|
|
DEVICE_CLASS_UNITS,
|
|
DOMAIN,
|
|
TUYA_DISCOVERY_NEW,
|
|
DPCode,
|
|
DPType,
|
|
TuyaDeviceClass,
|
|
UnitOfMeasurement,
|
|
)
|
|
|
|
|
|
@dataclass
|
|
class TuyaSensorEntityDescription(SensorEntityDescription):
|
|
"""Describes Tuya sensor entity."""
|
|
|
|
subkey: str | None = None
|
|
|
|
|
|
# Commonly used battery sensors, that are re-used in the sensors down below.
|
|
BATTERY_SENSORS: tuple[TuyaSensorEntityDescription, ...] = (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BATTERY_PERCENTAGE,
|
|
name="Battery",
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
device_class=SensorDeviceClass.BATTERY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BATTERY_STATE,
|
|
name="Battery State",
|
|
icon="mdi:battery",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BATTERY_VALUE,
|
|
name="Battery",
|
|
device_class=SensorDeviceClass.BATTERY,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VA_BATTERY,
|
|
name="Battery",
|
|
device_class=SensorDeviceClass.BATTERY,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
)
|
|
|
|
# All descriptions can be found here. Mostly the Integer data types in the
|
|
# default status set of each category (that don't have a set instruction)
|
|
# end up being a sensor.
|
|
# https://developer.tuya.com/en/docs/iot/standarddescription?id=K9i5ql6waswzq
|
|
SENSORS: dict[str, tuple[TuyaSensorEntityDescription, ...]] = {
|
|
# Multi-functional Sensor
|
|
# https://developer.tuya.com/en/docs/iot/categorydgnbj?id=Kaiuz3yorvzg3
|
|
"dgnbj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.GAS_SENSOR_VALUE,
|
|
name="Gas",
|
|
icon="mdi:gas-cylinder",
|
|
device_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH4_SENSOR_VALUE,
|
|
name="Methane",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VOC_VALUE,
|
|
name="Volatile Organic Compound",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM25_VALUE,
|
|
name="Particulate Matter 2.5 µm",
|
|
device_class=SensorDeviceClass.PM25,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO_VALUE,
|
|
name="Carbon Monoxide",
|
|
icon="mdi:molecule-co",
|
|
device_class=SensorDeviceClass.CO,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
icon="mdi:molecule-co2",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH2O_VALUE,
|
|
name="Formaldehyde",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BRIGHT_STATE,
|
|
name="Luminosity",
|
|
icon="mdi:brightness-6",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BRIGHT_VALUE,
|
|
name="Luminosity",
|
|
icon="mdi:brightness-6",
|
|
device_class=SensorDeviceClass.ILLUMINANCE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.SMOKE_SENSOR_VALUE,
|
|
name="Smoke Amount",
|
|
icon="mdi:smoke-detector",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
device_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Smart Kettle
|
|
# https://developer.tuya.com/en/docs/iot/fbh?id=K9gf484m21yq7
|
|
"bh": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Current Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT_F,
|
|
name="Current Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.STATUS,
|
|
name="Status",
|
|
device_class=TuyaDeviceClass.STATUS,
|
|
),
|
|
),
|
|
# CO2 Detector
|
|
# https://developer.tuya.com/en/docs/iot/categoryco2bj?id=Kaiuz3wes7yuy
|
|
"co2bj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# CO Detector
|
|
# https://developer.tuya.com/en/docs/iot/categorycobj?id=Kaiuz3u1j6q1v
|
|
"cobj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO_VALUE,
|
|
name="Carbon Monoxide",
|
|
device_class=SensorDeviceClass.CO,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Smart Pet Feeder
|
|
# https://developer.tuya.com/en/docs/iot/categorycwwsq?id=Kaiuz2b6vydld
|
|
"cwwsq": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.FEED_REPORT,
|
|
name="Last Amount",
|
|
icon="mdi:counter",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
),
|
|
# Air Quality Monitor
|
|
# No specification on Tuya portal
|
|
"hjjcy": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH2O_VALUE,
|
|
name="Formaldehyde",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VOC_VALUE,
|
|
name="Volatile Organic Compound",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM25_VALUE,
|
|
name="Particulate Matter 2.5 µm",
|
|
device_class=SensorDeviceClass.PM25,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
),
|
|
# Formaldehyde Detector
|
|
# Note: Not documented
|
|
"jqbj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VOC_VALUE,
|
|
name="Volatile Organic Compound",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM25_VALUE,
|
|
name="Particulate Matter 2.5 µm",
|
|
device_class=SensorDeviceClass.PM25,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VA_HUMIDITY,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VA_TEMPERATURE,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH2O_VALUE,
|
|
name="Formaldehyde",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Methane Detector
|
|
# https://developer.tuya.com/en/docs/iot/categoryjwbj?id=Kaiuz40u98lkm
|
|
"jwbj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH4_SENSOR_VALUE,
|
|
name="Methane",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Switch
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf7o5prgf7s
|
|
"kg": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CUR_CURRENT,
|
|
name="Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_registry_enabled_default=False,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CUR_POWER,
|
|
name="Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_registry_enabled_default=False,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CUR_VOLTAGE,
|
|
name="Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
entity_registry_enabled_default=False,
|
|
),
|
|
),
|
|
# Luminance Sensor
|
|
# https://developer.tuya.com/en/docs/iot/categoryldcg?id=Kaiuz3n7u69l8
|
|
"ldcg": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BRIGHT_STATE,
|
|
name="Luminosity",
|
|
icon="mdi:brightness-6",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BRIGHT_VALUE,
|
|
name="Luminosity",
|
|
device_class=SensorDeviceClass.ILLUMINANCE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Door and Window Controller
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf48r5zjsy9
|
|
"mc": BATTERY_SENSORS,
|
|
# Door Window Sensor
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf48hm02l8m
|
|
"mcs": BATTERY_SENSORS,
|
|
# PIR Detector
|
|
# https://developer.tuya.com/en/docs/iot/categorypir?id=Kaiuz3ss11b80
|
|
"pir": BATTERY_SENSORS,
|
|
# PM2.5 Sensor
|
|
# https://developer.tuya.com/en/docs/iot/categorypm25?id=Kaiuz3qof3yfu
|
|
"pm2.5": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM25_VALUE,
|
|
name="Particulate Matter 2.5 µm",
|
|
device_class=SensorDeviceClass.PM25,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH2O_VALUE,
|
|
name="Formaldehyde",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VOC_VALUE,
|
|
name="Volatile Organic Compound",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM1,
|
|
name="Particulate Matter 1.0 µm",
|
|
device_class=SensorDeviceClass.PM1,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM10,
|
|
name="Particulate Matter 10.0 µm",
|
|
device_class=SensorDeviceClass.PM10,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Heater
|
|
# https://developer.tuya.com/en/docs/iot/categoryqn?id=Kaiuz18kih0sm
|
|
"qn": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.WORK_POWER,
|
|
name="Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
),
|
|
# Gas Detector
|
|
# https://developer.tuya.com/en/docs/iot/categoryrqbj?id=Kaiuz3d162ubw
|
|
"rqbj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.GAS_SENSOR_VALUE,
|
|
icon="mdi:gas-cylinder",
|
|
device_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Water Detector
|
|
# https://developer.tuya.com/en/docs/iot/categorysj?id=Kaiuz3iub2sli
|
|
"sj": BATTERY_SENSORS,
|
|
# Emergency Button
|
|
# https://developer.tuya.com/en/docs/iot/categorysos?id=Kaiuz3oi6agjy
|
|
"sos": BATTERY_SENSORS,
|
|
# Smart Camera
|
|
# https://developer.tuya.com/en/docs/iot/categorysp?id=Kaiuz35leyo12
|
|
"sp": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.SENSOR_TEMPERATURE,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.SENSOR_HUMIDITY,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.WIRELESS_ELECTRICITY,
|
|
name="Battery",
|
|
device_class=SensorDeviceClass.BATTERY,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
),
|
|
# Fingerbot
|
|
"szjqr": BATTERY_SENSORS,
|
|
# Solar Light
|
|
# https://developer.tuya.com/en/docs/iot/tynd?id=Kaof8j02e1t98
|
|
"tyndj": BATTERY_SENSORS,
|
|
# Volatile Organic Compound Sensor
|
|
# Note: Undocumented in cloud API docs, based on test device
|
|
"voc": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CO2_VALUE,
|
|
name="Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM25_VALUE,
|
|
name="Particulate Matter 2.5 µm",
|
|
device_class=SensorDeviceClass.PM25,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CH2O_VALUE,
|
|
name="Formaldehyde",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VOC_VALUE,
|
|
name="Volatile Organic Compound",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Thermostatic Radiator Valve
|
|
# Not documented
|
|
"wkf": BATTERY_SENSORS,
|
|
# Temperature and Humidity Sensor
|
|
# https://developer.tuya.com/en/docs/iot/categorywsdcg?id=Kaiuz3hinij34
|
|
"wsdcg": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VA_TEMPERATURE,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.VA_HUMIDITY,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_VALUE,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.BRIGHT_VALUE,
|
|
name="Luminosity",
|
|
device_class=SensorDeviceClass.ILLUMINANCE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Pressure Sensor
|
|
# https://developer.tuya.com/en/docs/iot/categoryylcg?id=Kaiuz3kc2e4gm
|
|
"ylcg": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PRESSURE_VALUE,
|
|
device_class=SensorDeviceClass.PRESSURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Smoke Detector
|
|
# https://developer.tuya.com/en/docs/iot/categoryywbj?id=Kaiuz3f6sf952
|
|
"ywbj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.SMOKE_SENSOR_VALUE,
|
|
name="Smoke Amount",
|
|
icon="mdi:smoke-detector",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
device_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
*BATTERY_SENSORS,
|
|
),
|
|
# Vibration Sensor
|
|
# https://developer.tuya.com/en/docs/iot/categoryzd?id=Kaiuz3a5vrzno
|
|
"zd": BATTERY_SENSORS,
|
|
# Smart Electricity Meter
|
|
# https://developer.tuya.com/en/docs/iot/smart-meter?id=Kaiuz4gv6ack7
|
|
"zndb": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.FORWARD_ENERGY_TOTAL,
|
|
name="Total Energy",
|
|
device_class=SensorDeviceClass.ENERGY,
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_A,
|
|
name="Phase A Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
subkey="electriccurrent",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_A,
|
|
name="Phase A Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=POWER_KILO_WATT,
|
|
subkey="power",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_A,
|
|
name="Phase A Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
|
|
subkey="voltage",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_B,
|
|
name="Phase B Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
subkey="electriccurrent",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_B,
|
|
name="Phase B Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=POWER_KILO_WATT,
|
|
subkey="power",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_B,
|
|
name="Phase B Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
|
|
subkey="voltage",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_C,
|
|
name="Phase C Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
subkey="electriccurrent",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_C,
|
|
name="Phase C Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=POWER_KILO_WATT,
|
|
subkey="power",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_C,
|
|
name="Phase C Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
|
|
subkey="voltage",
|
|
),
|
|
),
|
|
# Circuit Breaker
|
|
# https://developer.tuya.com/en/docs/iot/dlq?id=Kb0kidk9enyh8
|
|
"dlq": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TOTAL_FORWARD_ENERGY,
|
|
name="Total Energy",
|
|
device_class=SensorDeviceClass.ENERGY,
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_A,
|
|
name="Phase A Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
subkey="electriccurrent",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_A,
|
|
name="Phase A Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=POWER_KILO_WATT,
|
|
subkey="power",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_A,
|
|
name="Phase A Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
|
|
subkey="voltage",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_B,
|
|
name="Phase B Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
subkey="electriccurrent",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_B,
|
|
name="Phase B Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=POWER_KILO_WATT,
|
|
subkey="power",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_B,
|
|
name="Phase B Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
|
|
subkey="voltage",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_C,
|
|
name="Phase C Current",
|
|
device_class=SensorDeviceClass.CURRENT,
|
|
native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
subkey="electriccurrent",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_C,
|
|
name="Phase C Power",
|
|
device_class=SensorDeviceClass.POWER,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=POWER_KILO_WATT,
|
|
subkey="power",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PHASE_C,
|
|
name="Phase C Voltage",
|
|
device_class=SensorDeviceClass.VOLTAGE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
native_unit_of_measurement=ELECTRIC_POTENTIAL_VOLT,
|
|
subkey="voltage",
|
|
),
|
|
),
|
|
# Robot Vacuum
|
|
# https://developer.tuya.com/en/docs/iot/fsd?id=K9gf487ck1tlo
|
|
"sd": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CLEAN_AREA,
|
|
name="Cleaning Area",
|
|
icon="mdi:texture-box",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.CLEAN_TIME,
|
|
name="Cleaning Time",
|
|
icon="mdi:progress-clock",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TOTAL_CLEAN_AREA,
|
|
name="Total Cleaning Area",
|
|
icon="mdi:texture-box",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TOTAL_CLEAN_TIME,
|
|
name="Total Cleaning Time",
|
|
icon="mdi:history",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TOTAL_CLEAN_COUNT,
|
|
name="Total Cleaning Times",
|
|
icon="mdi:counter",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.DUSTER_CLOTH,
|
|
name="Duster Cloth Life",
|
|
icon="mdi:ticket-percent-outline",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.EDGE_BRUSH,
|
|
name="Side Brush Life",
|
|
icon="mdi:ticket-percent-outline",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.FILTER_LIFE,
|
|
name="Filter Life",
|
|
icon="mdi:ticket-percent-outline",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.ROLL_BRUSH,
|
|
name="Rolling Brush Life",
|
|
icon="mdi:ticket-percent-outline",
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
),
|
|
# Curtain
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf48qy7wkre
|
|
"cl": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TIME_TOTAL,
|
|
name="Last Operation Duration",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:progress-clock",
|
|
),
|
|
),
|
|
# Humidifier
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf48qwjz0i3
|
|
"jsq": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY_CURRENT,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT_F,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.LEVEL_CURRENT,
|
|
name="Water Level",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:waves-arrow-up",
|
|
),
|
|
),
|
|
# Air Purifier
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf48r41mn81
|
|
"kj": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.FILTER,
|
|
name="Filter Utilization",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
icon="mdi:ticket-percent-outline",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.PM25,
|
|
name="Particulate Matter 2.5 µm",
|
|
device_class=SensorDeviceClass.PM25,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
icon="mdi:molecule",
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.HUMIDITY,
|
|
name="Humidity",
|
|
device_class=SensorDeviceClass.HUMIDITY,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TVOC,
|
|
name="Total Volatile Organic Compound",
|
|
device_class=SensorDeviceClass.VOLATILE_ORGANIC_COMPOUNDS,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.ECO2,
|
|
name="Concentration of Carbon Dioxide",
|
|
device_class=SensorDeviceClass.CO2,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TOTAL_TIME,
|
|
name="Total Operating Time",
|
|
icon="mdi:history",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TOTAL_PM,
|
|
name="Total Absorption of Particles",
|
|
icon="mdi:texture-box",
|
|
state_class=SensorStateClass.TOTAL_INCREASING,
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.AIR_QUALITY,
|
|
name="Air quality",
|
|
icon="mdi:air-filter",
|
|
device_class=TuyaDeviceClass.AIR_QUALITY,
|
|
),
|
|
),
|
|
# Fan
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf48quojr54
|
|
"fs": (
|
|
TuyaSensorEntityDescription(
|
|
key=DPCode.TEMP_CURRENT,
|
|
name="Temperature",
|
|
device_class=SensorDeviceClass.TEMPERATURE,
|
|
state_class=SensorStateClass.MEASUREMENT,
|
|
),
|
|
),
|
|
}
|
|
|
|
# Socket (duplicate of `kg`)
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf7o5prgf7s
|
|
SENSORS["cz"] = SENSORS["kg"]
|
|
|
|
# Power Socket (duplicate of `kg`)
|
|
# https://developer.tuya.com/en/docs/iot/s?id=K9gf7o5prgf7s
|
|
SENSORS["pc"] = SENSORS["kg"]
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
|
|
) -> None:
|
|
"""Set up Tuya sensor dynamically through Tuya discovery."""
|
|
hass_data: HomeAssistantTuyaData = hass.data[DOMAIN][entry.entry_id]
|
|
|
|
@callback
|
|
def async_discover_device(device_ids: list[str]) -> None:
|
|
"""Discover and add a discovered Tuya sensor."""
|
|
entities: list[TuyaSensorEntity] = []
|
|
for device_id in device_ids:
|
|
device = hass_data.device_manager.device_map[device_id]
|
|
if descriptions := SENSORS.get(device.category):
|
|
for description in descriptions:
|
|
if description.key in device.status:
|
|
entities.append(
|
|
TuyaSensorEntity(
|
|
device, hass_data.device_manager, description
|
|
)
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
async_discover_device([*hass_data.device_manager.device_map])
|
|
|
|
entry.async_on_unload(
|
|
async_dispatcher_connect(hass, TUYA_DISCOVERY_NEW, async_discover_device)
|
|
)
|
|
|
|
|
|
class TuyaSensorEntity(TuyaEntity, SensorEntity):
|
|
"""Tuya Sensor Entity."""
|
|
|
|
entity_description: TuyaSensorEntityDescription
|
|
|
|
_status_range: TuyaDeviceStatusRange | None = None
|
|
_type: DPType | None = None
|
|
_type_data: IntegerTypeData | EnumTypeData | None = None
|
|
_uom: UnitOfMeasurement | None = None
|
|
|
|
def __init__(
|
|
self,
|
|
device: TuyaDevice,
|
|
device_manager: TuyaDeviceManager,
|
|
description: TuyaSensorEntityDescription,
|
|
) -> None:
|
|
"""Init Tuya sensor."""
|
|
super().__init__(device, device_manager)
|
|
self.entity_description = description
|
|
self._attr_unique_id = (
|
|
f"{super().unique_id}{description.key}{description.subkey or ''}"
|
|
)
|
|
|
|
if int_type := self.find_dpcode(description.key, dptype=DPType.INTEGER):
|
|
self._type_data = int_type
|
|
self._type = DPType.INTEGER
|
|
if description.native_unit_of_measurement is None:
|
|
self._attr_native_unit_of_measurement = int_type.unit
|
|
elif enum_type := self.find_dpcode(
|
|
description.key, dptype=DPType.ENUM, prefer_function=True
|
|
):
|
|
self._type_data = enum_type
|
|
self._type = DPType.ENUM
|
|
else:
|
|
self._type = self.get_dptype(DPCode(description.key))
|
|
|
|
# Logic to ensure the set device class and API received Unit Of Measurement
|
|
# match Home Assistants requirements.
|
|
if (
|
|
self.device_class is not None
|
|
and not self.device_class.startswith(DOMAIN)
|
|
and description.native_unit_of_measurement is None
|
|
):
|
|
# We cannot have a device class, if the UOM isn't set or the
|
|
# device class cannot be found in the validation mapping.
|
|
if (
|
|
self.native_unit_of_measurement is None
|
|
or self.device_class not in DEVICE_CLASS_UNITS
|
|
):
|
|
self._attr_device_class = None
|
|
return
|
|
|
|
uoms = DEVICE_CLASS_UNITS[self.device_class]
|
|
self._uom = uoms.get(self.native_unit_of_measurement) or uoms.get(
|
|
self.native_unit_of_measurement.lower()
|
|
)
|
|
|
|
# Unknown unit of measurement, device class should not be used.
|
|
if self._uom is None:
|
|
self._attr_device_class = None
|
|
return
|
|
|
|
# If we still have a device class, we should not use an icon
|
|
if self.device_class:
|
|
self._attr_icon = None
|
|
|
|
# Found unit of measurement, use the standardized Unit
|
|
# Use the target conversion unit (if set)
|
|
self._attr_native_unit_of_measurement = (
|
|
self._uom.conversion_unit or self._uom.unit
|
|
)
|
|
|
|
@property
|
|
def native_value(self) -> StateType:
|
|
"""Return the value reported by the sensor."""
|
|
# Only continue if data type is known
|
|
if self._type not in (
|
|
DPType.INTEGER,
|
|
DPType.STRING,
|
|
DPType.ENUM,
|
|
DPType.JSON,
|
|
DPType.RAW,
|
|
):
|
|
return None
|
|
|
|
# Raw value
|
|
value = self.device.status.get(self.entity_description.key)
|
|
if value is None:
|
|
return None
|
|
|
|
# Scale integer/float value
|
|
if isinstance(self._type_data, IntegerTypeData):
|
|
scaled_value = self._type_data.scale_value(value)
|
|
if self._uom and self._uom.conversion_fn is not None:
|
|
return self._uom.conversion_fn(scaled_value)
|
|
return scaled_value
|
|
|
|
# Unexpected enum value
|
|
if (
|
|
isinstance(self._type_data, EnumTypeData)
|
|
and value not in self._type_data.range
|
|
):
|
|
return None
|
|
|
|
# Get subkey value from Json string.
|
|
if self._type is DPType.JSON:
|
|
if self.entity_description.subkey is None:
|
|
return None
|
|
values = ElectricityTypeData.from_json(value)
|
|
return getattr(values, self.entity_description.subkey)
|
|
|
|
if self._type is DPType.RAW:
|
|
if self.entity_description.subkey is None:
|
|
return None
|
|
values = ElectricityTypeData.from_raw(value)
|
|
return getattr(values, self.entity_description.subkey)
|
|
|
|
# Valid string or enum value
|
|
return value
|