esphome/esphome/components/zigbee/const.py

from enum import IntEnum

import esphome.codegen as cg

# The entity schema keys and report enum live outside this package so
# entity base schemas can use them without importing it; re-imported here
# so zigbee code keeps its existing import paths.
from esphome.const import (  # noqa: F401  # pylint: disable=unused-import
    CONF_ENDPOINT,
    CONF_REPORT,
    CONF_USE_DEVICE_TYPE,
    DEVICE_CLASS_CURRENT,
    DEVICE_CLASS_DURATION,
    DEVICE_CLASS_ENERGY,
    DEVICE_CLASS_FREQUENCY,
    DEVICE_CLASS_HUMIDITY,
    DEVICE_CLASS_POWER,
    DEVICE_CLASS_PRESSURE,
    DEVICE_CLASS_TEMPERATURE,
    DEVICE_CLASS_VOLUME_FLOW_RATE,
    UNIT_AMPERE,
    UNIT_CELSIUS,
    UNIT_CENTIMETER,
    UNIT_CUBIC_METER,
    UNIT_CUBIC_METER_PER_HOUR,
    UNIT_DECIBEL,
    UNIT_HECTOPASCAL,
    UNIT_HERTZ,
    UNIT_HOUR,
    UNIT_KELVIN,
    UNIT_KILOMETER,
    UNIT_KILOPASCAL,
    UNIT_KILOVOLT_AMPS,
    UNIT_KILOVOLT_AMPS_REACTIVE,
    UNIT_KILOWATT,
    UNIT_KILOWATT_HOURS,
    UNIT_LITRE_PER_SECOND,
    UNIT_LUX,
    UNIT_METER,
    UNIT_MICROGRAMS_PER_CUBIC_METER,
    UNIT_MILLIAMP,
    UNIT_MILLIGRAMS_PER_CUBIC_METER,
    UNIT_MILLIMETER,
    UNIT_MILLISECOND,
    UNIT_MILLIVOLT,
    UNIT_MINUTE,
    UNIT_OHM,
    UNIT_PARTS_PER_BILLION,
    UNIT_PARTS_PER_MILLION,
    UNIT_PASCAL,
    UNIT_PERCENT,
    UNIT_PH,
    UNIT_SECOND,
    UNIT_VOLT,
    UNIT_WATT,
    UNIT_WATT_HOURS,
)
from esphome.core.entity_helpers import (  # noqa: F401  # pylint: disable=unused-import
    ZIGBEE_MAX_EP_NUMBER as CONF_MAX_EP_NUMBER,
    ZIGBEE_REPORT as REPORT,
)

zigbee_ns = cg.esphome_ns.namespace("zigbee")
ZigbeeComponent = zigbee_ns.class_("ZigbeeComponent", cg.Component)
ZigbeeAttribute = zigbee_ns.class_("ZigbeeAttribute", cg.Component)
BinaryAttrs = zigbee_ns.struct("BinaryAttrs")
AnalogAttrs = zigbee_ns.struct("AnalogAttrs")
AnalogAttrsOutput = zigbee_ns.struct("AnalogAttrsOutput")

CONF_ON_JOIN = "on_join"
CONF_WIPE_ON_BOOT = "wipe_on_boot"
CONF_ROUTER = "router"
CONF_POWER_SOURCE = "power_source"
POWER_SOURCE = {
    "UNKNOWN": 0x00,  # ZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN
    "MAINS_SINGLE_PHASE": 0x01,  # ZB_ZCL_BASIC_POWER_SOURCE_MAINS_SINGLE_PHASE
    "MAINS_THREE_PHASE": 0x02,  # ZB_ZCL_BASIC_POWER_SOURCE_MAINS_THREE_PHASE
    "BATTERY": 0x03,  # ZB_ZCL_BASIC_POWER_SOURCE_BATTERY
    "DC_SOURCE": 0x04,  # ZB_ZCL_BASIC_POWER_SOURCE_DC_SOURCE
    "EMERGENCY_MAINS_CONST": 0x05,  # ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_CONST
    "EMERGENCY_MAINS_TRANSF": 0x06,  # ZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_TRANSF
}

KEY_ZIGBEE = "zigbee"

# BACnet engineering units mapping (ZCL uses BACnet unit codes)
# See: https://github.com/zigpy/zha/blob/dev/zha/application/platforms/number/bacnet.py
BACNET_UNITS = {
    UNIT_CELSIUS: 62,
    UNIT_KELVIN: 63,
    UNIT_VOLT: 5,
    UNIT_MILLIVOLT: 124,
    UNIT_AMPERE: 3,
    UNIT_MILLIAMP: 2,
    UNIT_OHM: 4,
    UNIT_WATT: 47,
    UNIT_KILOWATT: 48,
    UNIT_KILOVOLT_AMPS: 9,
    UNIT_KILOVOLT_AMPS_REACTIVE: 12,
    UNIT_WATT_HOURS: 18,
    UNIT_KILOWATT_HOURS: 19,
    UNIT_PASCAL: 53,
    UNIT_HECTOPASCAL: 133,
    UNIT_KILOPASCAL: 54,
    UNIT_HERTZ: 27,
    UNIT_MILLIMETER: 30,
    UNIT_CENTIMETER: 118,
    UNIT_METER: 31,
    UNIT_KILOMETER: 193,
    UNIT_MILLISECOND: 159,
    UNIT_SECOND: 73,
    UNIT_MINUTE: 72,
    UNIT_HOUR: 71,
    UNIT_PARTS_PER_MILLION: 96,
    UNIT_PARTS_PER_BILLION: 97,
    UNIT_MICROGRAMS_PER_CUBIC_METER: 219,
    UNIT_MILLIGRAMS_PER_CUBIC_METER: 218,
    UNIT_LUX: 37,
    UNIT_DECIBEL: 199,
    UNIT_PERCENT: 98,
    UNIT_CUBIC_METER: 80,
    UNIT_CUBIC_METER_PER_HOUR: 135,
    UNIT_PH: 234,
}
BACNET_UNIT_NO_UNITS = 95


class AnalogInputType(IntEnum):
    TEMP_DEGREES_C = 0x00
    RELATIVE_HUMIDITY_PERCENT = 0x01
    PRESSURE_PASCAL = 0x02
    FLOW_LITERS_PER_SEC = 0x03
    PERCENTAGE = 0x04
    PARTS_PER_MILLION = 0x05
    ROTATIONAL_SPEED_RPM = 0x06
    CURRENT_AMPS = 0x07
    FREQUENCY_HZ = 0x08
    POWER_WATTS = 0x09
    POWER_KILO_WATTS = 0x0A
    ENERGY_KILO_WATT_HOURS = 0x0B
    COUNT = 0x0C
    ENTHALPY_KJOULES_PER_KG = 0x0D
    TIME_SECONDS = 0x0E


ANALOG_INPUT_APPTYPE = {
    (DEVICE_CLASS_TEMPERATURE, UNIT_CELSIUS): AnalogInputType.TEMP_DEGREES_C,
    (DEVICE_CLASS_HUMIDITY, UNIT_PERCENT): AnalogInputType.RELATIVE_HUMIDITY_PERCENT,
    (DEVICE_CLASS_PRESSURE, UNIT_PASCAL): AnalogInputType.PRESSURE_PASCAL,
    (
        DEVICE_CLASS_VOLUME_FLOW_RATE,
        UNIT_LITRE_PER_SECOND,
    ): AnalogInputType.FLOW_LITERS_PER_SEC,
    (DEVICE_CLASS_CURRENT, UNIT_AMPERE): AnalogInputType.CURRENT_AMPS,
    (DEVICE_CLASS_FREQUENCY, UNIT_HERTZ): AnalogInputType.FREQUENCY_HZ,
    (DEVICE_CLASS_POWER, UNIT_WATT): AnalogInputType.POWER_WATTS,
    (DEVICE_CLASS_POWER, UNIT_KILOWATT): AnalogInputType.POWER_KILO_WATTS,
    (DEVICE_CLASS_ENERGY, UNIT_KILOWATT_HOURS): AnalogInputType.ENERGY_KILO_WATT_HOURS,
    (DEVICE_CLASS_DURATION, UNIT_SECOND): AnalogInputType.TIME_SECONDS,
}