1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
"""Constants for Meter CC."""
from __future__ import annotations
from enum import IntEnum
VALUE_PROPERTY = "value"
RESET_PROPERTY = "reset"
CC_SPECIFIC_SCALE = "scale"
CC_SPECIFIC_METER_TYPE = "meterType"
CC_SPECIFIC_RATE_TYPE = "rateType"
RESET_METER_CC_API = "reset"
# optional attributes when calling the Meter CC reset API.
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/cc/src/cc/MeterCC.ts
RESET_METER_OPTION_TARGET_VALUE = "targetValue"
RESET_METER_OPTION_TYPE = "type"
RESET_METER_OPTION_SCALE = "scale"
RESET_METER_OPTION_RATE_TYPE = "rateType"
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/config/config/meters.json
class MeterType(IntEnum):
"""Enum with all known meter types."""
ELECTRIC = 1
GAS = 2
WATER = 3
HEATING = 4
COOLING = 5
class RateType(IntEnum):
"""Enum with all known rate types."""
# https://github.com/raman325/node-zwave-js/blob/master/packages/cc/src/lib/_Types.ts#L996
UNSPECIFIED = 0
CONSUMED = 1
PRODUCED = 2
class MeterScaleType(IntEnum):
"""Common base class for meter scale enums."""
class ElectricScale(MeterScaleType):
"""Enum with all known electric meter scale values."""
KILOWATT_HOUR = 0
KILOVOLT_AMPERE_HOUR = 1
WATT = 2
PULSE_COUNT = 3
VOLT = 4
AMPERE = 5
POWER_FACTOR = 6
KILOVOLT_AMPERE_REACTIVE = 7
KILOVOLT_AMPERE_REACTIVE_HOUR = 8
class GasScale(MeterScaleType):
"""Enum with all known gas meter scale values."""
CUBIC_METER = 0
CUBIC_FEET = 1
PULSE_COUNT = 3
class WaterScale(MeterScaleType):
"""Enum with all known water meter scale values."""
CUBIC_METER = 0
CUBIC_FEET = 1
US_GALLON = 2
PULSE_COUNT = 3
class HeatingScale(MeterScaleType):
"""Enum with all known heating meter scale values."""
KILOWATT_HOUR = 0
CoolingScale = HeatingScale
METER_TYPE_TO_SCALE_ENUM_MAP: dict[MeterType, type[MeterScaleType]] = {
MeterType.ELECTRIC: ElectricScale,
MeterType.GAS: GasScale,
MeterType.WATER: WaterScale,
MeterType.HEATING: HeatingScale,
MeterType.COOLING: CoolingScale,
}
ENERGY_TOTAL_INCREASING_METER_TYPES: list[MeterScaleType] = [
ElectricScale.KILOWATT_HOUR,
ElectricScale.KILOVOLT_AMPERE_HOUR,
ElectricScale.KILOVOLT_AMPERE_REACTIVE_HOUR,
HeatingScale.KILOWATT_HOUR,
CoolingScale.KILOWATT_HOUR,
ElectricScale.PULSE_COUNT,
]
POWER_METER_TYPES: list[MeterScaleType] = [
ElectricScale.WATT,
ElectricScale.KILOVOLT_AMPERE_REACTIVE,
]
POWER_FACTOR_METER_TYPES: list[MeterScaleType] = [ElectricScale.POWER_FACTOR]
VOLTAGE_METER_TYPES: list[MeterScaleType] = [ElectricScale.VOLT]
CURRENT_METER_TYPES: list[MeterScaleType] = [ElectricScale.AMPERE]
GAS_METER_TYPES: list[MeterScaleType] = [
GasScale.CUBIC_METER,
GasScale.CUBIC_FEET,
GasScale.PULSE_COUNT,
]
WATER_METER_TYPES: list[MeterScaleType] = [
WaterScale.CUBIC_METER,
WaterScale.CUBIC_FEET,
WaterScale.US_GALLON,
WaterScale.PULSE_COUNT,
]
UNIT_KILOWATT_HOUR: list[MeterScaleType] = [
ElectricScale.KILOWATT_HOUR,
HeatingScale.KILOWATT_HOUR,
CoolingScale.KILOWATT_HOUR,
]
UNIT_KILOVOLT_AMPERE_HOUR: list[MeterScaleType] = [ElectricScale.KILOVOLT_AMPERE_HOUR]
UNIT_WATT: list[MeterScaleType] = [ElectricScale.WATT]
UNIT_PULSE_COUNT: list[MeterScaleType] = [
ElectricScale.PULSE_COUNT,
GasScale.PULSE_COUNT,
WaterScale.PULSE_COUNT,
]
UNIT_VOLT: list[MeterScaleType] = [ElectricScale.VOLT]
UNIT_AMPERE: list[MeterScaleType] = [ElectricScale.AMPERE]
UNIT_POWER_FACTOR: list[MeterScaleType] = [ElectricScale.POWER_FACTOR]
UNIT_KILOVOLT_AMPERE_REACTIVE: list[MeterScaleType] = [
ElectricScale.KILOVOLT_AMPERE_REACTIVE
]
UNIT_KILOVOLT_AMPERE_REACTIVE_HOUR: list[MeterScaleType] = [
ElectricScale.KILOVOLT_AMPERE_REACTIVE_HOUR
]
UNIT_CUBIC_METER: list[MeterScaleType] = [GasScale.CUBIC_METER, WaterScale.CUBIC_METER]
UNIT_CUBIC_FEET: list[MeterScaleType] = [GasScale.CUBIC_FEET, WaterScale.CUBIC_FEET]
UNIT_US_GALLON: list[MeterScaleType] = [WaterScale.US_GALLON]
|