zwave-js-server-python 0.29.0__tar.gz → 0.30.0__tar.gz

{zwave-js-server-python-0.29.0 → zwave-js-server-python-0.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.29.0
+Version: 0.30.0
 Summary: Python wrapper for zwave-js-server
 Home-page: https://github.com/home-assistant-libs/zwave-js-server-python
 Author: Home Assistant Team

{zwave-js-server-python-0.29.0 → zwave-js-server-python-0.30.0}/setup.py

@@ -5,7 +5,7 @@ from setuptools import find_packages, setup
 
 PROJECT_DIR = Path(__file__).parent.resolve()
 README_FILE = PROJECT_DIR / "README.md"
-VERSION = "0.29.0"
+VERSION = "0.30.0"
 
 
 setup(

zwave-js-server-python-0.30.0/zwave_js_server/const/__init__.py

@@ -0,0 +1,217 @@
+"""Constants for the Z-Wave JS python library."""
+from enum import Enum, IntEnum
+
+# minimal server schema version we can handle
+MIN_SERVER_SCHEMA_VERSION = 8
+# max server schema version we can handle (and our code is compatible with)
+MAX_SERVER_SCHEMA_VERSION = 8
+
+VALUE_UNKNOWN = "unknown"
+
+INTERVIEW_FAILED = "Failed"
+
+TARGET_STATE_PROPERTY = "targetState"
+TARGET_VALUE_PROPERTY = "targetValue"
+
+
+class CommandStatus(str, Enum):
+    """Status of a command sent to zwave-js-server."""
+
+    ACCEPTED = "accepted"
+    QUEUED = "queued"
+
+
+# Multiple inheritance so that LogLevel will JSON serialize properly
+# Reference: https://stackoverflow.com/a/51976841
+class LogLevel(str, Enum):
+    """Enum for log levels used by node-zwave-js."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/log/shared.ts#L12
+    # https://github.com/winstonjs/triple-beam/blame/master/config/npm.js#L14
+    ERROR = "error"
+    WARN = "warn"
+    INFO = "info"
+    HTTP = "http"
+    VERBOSE = "verbose"
+    DEBUG = "debug"
+    SILLY = "silly"
+
+
+class CommandClass(IntEnum):
+    """Enum with all known CommandClasses."""
+
+    SENSOR_ALARM = 156
+    SILENCE_ALARM = 157
+    SWITCH_ALL = 39
+    ANTITHEFT = 93
+    ANTITHEFT_UNLOCK = 126
+    APPLICATION_CAPABILITY = 87
+    APPLICATION_STATUS = 34
+    ASSOCIATION = 133
+    ASSOCIATION_COMMAND_CONFIGURATION = 155
+    ASSOCIATION_GRP_INFO = 89
+    AUTHENTICATION = 161
+    AUTHENTICATION_MEDIA_WRITE = 162
+    BARRIER_OPERATOR = 102
+    BASIC = 32
+    BASIC_TARIFF_INFO = 54
+    BASIC_WINDOW_COVERING = 80
+    BATTERY = 128
+    SENSOR_BINARY = 48
+    SWITCH_BINARY = 37
+    SWITCH_TOGGLE_BINARY = 40
+    CLIMATE_CONTROL_SCHEDULE = 70
+    CENTRAL_SCENE = 91
+    CLOCK = 129
+    SWITCH_COLOR = 51
+    CONFIGURATION = 112
+    CONTROLLER_REPLICATION = 33
+    CRC_16_ENCAP = 86
+    DCP_CONFIG = 58
+    DCP_MONITOR = 59
+    DEVICE_RESET_LOCALLY = 90
+    DOOR_LOCK = 98
+    DOOR_LOCK_LOGGING = 76
+    ENERGY_PRODUCTION = 144
+    ENTRY_CONTROL = 111
+    FIRMWARE_UPDATE_MD = 122
+    GENERIC_SCHEDULE = 163
+    GEOGRAPHIC_LOCATION = 140
+    GROUPING_NAME = 123
+    HAIL = 130
+    HRV_STATUS = 55
+    HRV_CONTROL = 57
+    HUMIDITY_CONTROL_MODE = 109
+    HUMIDITY_CONTROL_OPERATING_STATE = 110
+    HUMIDITY_CONTROL_SETPOINT = 100
+    INCLUSION_CONTROLLER = 116
+    INDICATOR = 135
+    IP_ASSOCIATION = 92
+    IP_CONFIGURATION = 154
+    IR_REPEATER = 160
+    IRRIGATION = 107
+    LANGUAGE = 137
+    LOCK = 118
+    MAILBOX = 105
+    MANUFACTURER_PROPRIETARY = 145
+    MANUFACTURER_SPECIFIC = 114
+    MARK = 239
+    METER = 50
+    METER_TBL_CONFIG = 60
+    METER_TBL_MONITOR = 61
+    METER_TBL_PUSH = 62
+    MTP_WINDOW_COVERING = 81
+    MULTI_CHANNEL = 96
+    MULTI_CHANNEL_ASSOCIATION = 142
+    MULTI_CMD = 143
+    SENSOR_MULTILEVEL = 49
+    SWITCH_MULTILEVEL = 38
+    SWITCH_TOGGLE_MULTILEVEL = 41
+    NETWORK_MANAGEMENT_BASIC = 77
+    NETWORK_MANAGEMENT_INCLUSION = 52
+    NETWORK_MANAGEMENT_INSTALLATION_MAINTENANCE = 103
+    NETWORK_MANAGEMENT_PRIMARY = 84
+    NETWORK_MANAGEMENT_PROXY = 82
+    NO_OPERATION = 0
+    NODE_NAMING = 119
+    NODE_PROVISIONING = 120
+    NOTIFICATION = 113
+    POWERLEVEL = 115
+    PREPAYMENT = 63
+    PREPAYMENT_ENCAPSULATION = 65
+    PROPRIETARY = 136
+    PROTECTION = 117
+    METER_PULSE = 53
+    RATE_TBL_CONFIG = 72
+    RATE_TBL_MONITOR = 73
+    REMOTE_ASSOCIATION_ACTIVATE = 124
+    REMOTE_ASSOCIATION = 125
+    SCENE_ACTIVATION = 43
+    SCENE_ACTUATOR_CONF = 44
+    SCENE_CONTROLLER_CONF = 45
+    SCHEDULE = 83
+    SCHEDULE_ENTRY_LOCK = 78
+    SCREEN_ATTRIBUTES = 147
+    SCREEN_MD = 146
+    SECURITY = 152
+    SECURITY_2 = 159
+    SECURITY_SCHEME0_MARK = 61696
+    SENSOR_CONFIGURATION = 158
+    SIMPLE_AV_CONTROL = 148
+    SOUND_SWITCH = 121
+    SUPERVISION = 108
+    TARIFF_CONFIG = 74
+    TARIFF_TBL_MONITOR = 75
+    THERMOSTAT_FAN_MODE = 68
+    THERMOSTAT_FAN_STATE = 69
+    THERMOSTAT_MODE = 64
+    THERMOSTAT_OPERATING_STATE = 66
+    THERMOSTAT_SETBACK = 71
+    THERMOSTAT_SETPOINT = 67
+    TIME = 138
+    TIME_PARAMETERS = 139
+    TRANSPORT_SERVICE = 85
+    USER_CODE = 99
+    VERSION = 134
+    WAKE_UP = 132
+    WINDOW_COVERING = 106
+    ZIP = 35
+    ZIP_6LOWPAN = 79
+    ZIP_GATEWAY = 95
+    ZIP_NAMING = 104
+    ZIP_ND = 88
+    ZIP_PORTAL = 97
+    ZWAVEPLUS_INFO = 94
+
+
+class ProtocolVersion(IntEnum):
+    """Protocol version."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/node/Types.ts#L149
+    UNKNOWN = 0
+    VERSION_2_0 = 1
+    VERSION_4_2X_OR_5_0X = 2
+    VERSION_4_5X_OR_6_0X = 3
+
+
+class NodeStatus(IntEnum):
+    """Enum with all Node status values."""
+
+    # https://zwave-js.github.io/node-zwave-js/#/api/node?id=status
+    UNKNOWN = 0
+    ASLEEP = 1
+    AWAKE = 2
+    DEAD = 3
+    ALIVE = 4
+
+
+class ConfigurationValueType(str, Enum):
+    """Enum for configuration value types."""
+
+    ENUMERATED = "enumerated"
+    MANUAL_ENTRY = "manual_entry"
+    RANGE = "range"
+    UNDEFINED = "undefined"
+
+
+# Inclusion enums
+class InclusionStrategy(IntEnum):
+    """Enum for all known inclusion strategies."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L9-L46
+    DEFAULT = 0
+    SMART_START = 1
+    INSECURE = 2
+    SECURITY_S0 = 3
+    SECURITY_S2 = 4
+
+
+class SecurityClass(IntEnum):
+    """Enum for all known security classes."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/security/SecurityClass.ts#L3-L17
+    NONE = -1
+    S2_UNAUTHENTICATED = 0
+    S2_AUTHENTICATED = 1
+    S2_ACCESS_CONTROL = 2
+    S0_LEGACY = 7

zwave-js-server-python-0.30.0/zwave_js_server/const/command_class/__init__.py

@@ -0,0 +1 @@
+"""Constants for Command Classes."""

zwave-js-server-python-0.30.0/zwave_js_server/const/command_class/barrier_operator.py

@@ -0,0 +1,21 @@
+"""Constants for the Barrier Operator CC."""
+from enum import IntEnum
+
+
+class BarrierEventSignalingSubsystemState(IntEnum):
+    """Enum with all (known/used) Z-Wave Barrier Event Signaling Subsystem States."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/15e1b59f627bfad8bfae114bd774a14089c76683/packages/zwave-js/src/lib/commandclass/BarrierOperatorCC.ts#L46-L49
+    OFF = 0
+    ON = 255
+
+
+class BarrierState(IntEnum):
+    """Enum with all (known/used) Z-Wave Barrier States."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/15e1b59f627bfad8bfae114bd774a14089c76683/packages/zwave-js/src/lib/commandclass/BarrierOperatorCC.ts#L107-L113
+    CLOSED = 0
+    CLOSING = 252
+    STOPPED = 253
+    OPENING = 254
+    OPEN = 255

zwave-js-server-python-0.30.0/zwave_js_server/const/command_class/color_switch.py

@@ -0,0 +1,32 @@
+"""Constants for the Color Switch CC."""
+from enum import IntEnum
+
+
+class ColorComponent(IntEnum):
+    """Enum with all (known/used) Color Switch CC colors."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/commandclass/ColorSwitchCC.ts#L62
+    WARM_WHITE = 0
+    COLD_WHITE = 1
+    RED = 2
+    GREEN = 3
+    BLUE = 4
+    AMBER = 5
+    CYAN = 6
+    PURPLE = 7
+    INDEX = 8
+
+
+# Keys for the Color Switch CC combined colors value
+# https://github.com/zwave-js/node-zwave-js/pull/1782
+COLOR_SWITCH_COMBINED_RED = "red"
+COLOR_SWITCH_COMBINED_GREEN = "green"
+COLOR_SWITCH_COMBINED_BLUE = "blue"
+COLOR_SWITCH_COMBINED_AMBER = "amber"
+COLOR_SWITCH_COMBINED_CYAN = "cyan"
+COLOR_SWITCH_COMBINED_PURPLE = "purple"
+COLOR_SWITCH_COMBINED_WARM_WHITE = "warmWhite"
+COLOR_SWITCH_COMBINED_COLD_WHITE = "coldWhite"
+
+CURRENT_COLOR_PROPERTY = "currentColor"
+TARGET_COLOR_PROPERTY = "targetColor"

zwave-js-server-python-0.30.0/zwave_js_server/const/command_class/entry_control.py

@@ -0,0 +1,44 @@
+"""Constants for the Entry Control CC."""
+from enum import IntEnum
+
+
+class EntryControlEventType(IntEnum):
+    """Entry control event types."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/commandclass/EntryControlCC.ts#L54
+    CACHING = 0
+    CACHED_KEYS = 1
+    ENTER = 2
+    DISARM_ALL = 3
+    ARM_ALL = 4
+    ARM_AWAY = 5
+    ARM_HOME = 6
+    EXIT_DELAY = 7
+    ARM1 = 8
+    ARM2 = 9
+    ARM3 = 10
+    ARM4 = 11
+    ARM5 = 12
+    ARM6 = 13
+    RFID = 14
+    BELL = 15
+    FIRE = 16
+    POLICE = 17
+    ALERT_PANIC = 18
+    ALERT_MEDICAL = 19
+    GATE_OPEN = 20
+    GATE_CLOSE = 21
+    LOCK = 22
+    UNLOCK = 23
+    TEST = 24
+    CANCEL = 25
+
+
+class EntryControlDataType(IntEnum):
+    """Entry control data types."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/commandclass/EntryControlCC.ts#L83
+    NONE = 0
+    RAW = 1
+    ASCII = 2
+    MD5 = 3

zwave-js-server-python-0.30.0/zwave_js_server/const/command_class/lock.py

@@ -0,0 +1,52 @@
+"""
+Constants for lock related CCs.
+
+Includes Door Lock and Lock CCs.
+"""
+from enum import IntEnum
+
+from .. import CommandClass
+
+
+class DoorLockMode(IntEnum):
+    """Enum with all (known/used) Z-Wave lock states for CommandClass.DOOR_LOCK."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/commandclass/DoorLockCC.ts#L56-L65
+    UNSECURED = 0
+    UNSECURED_WITH_TIMEOUT = 1
+    INSIDE_UNSECURED = 2
+    INSIDE_UNSECURED_WITH_TIMEOUT = 3
+    OUTSIDE_UNSECURED = 4
+    OUTSIDE_UNSECURED_WITH_TIMEOUT = 5
+    UNKNOWN = 254
+    SECURED = 255
+
+
+class CodeSlotStatus(IntEnum):
+    """Enum with all (known/used) Z-Wave code slot statuses."""
+
+    AVAILABLE = 0
+    ENABLED = 1
+    DISABLED = 2
+
+
+# Depending on the Command Class being used by the lock, the lock state is
+# different so we need a map to track it
+LOCK_CMD_CLASS_TO_LOCKED_STATE_MAP = {
+    CommandClass.DOOR_LOCK: DoorLockMode.SECURED,
+    CommandClass.LOCK: 1,
+}
+
+# Depending on the Command Class being used by the lock, the locked state property
+# is different so we need a map to track it
+LOCK_CMD_CLASS_TO_PROPERTY_MAP = {
+    CommandClass.DOOR_LOCK: "targetMode",
+    CommandClass.LOCK: "locked",
+}
+
+LOCK_USERCODE_PROPERTY = "userCode"
+LOCK_USERCODE_STATUS_PROPERTY = "userIdStatus"
+ATTR_CODE_SLOT = "code_slot"
+ATTR_IN_USE = "in_use"
+ATTR_NAME = "name"
+ATTR_USERCODE = "usercode"

zwave-js-server-python-0.30.0/zwave_js_server/const/command_class/meter.py

@@ -0,0 +1,102 @@
+"""Constants for Meter CC."""
+from enum import IntEnum
+from typing import Dict, Set, Type, Union
+
+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/zwave-js/src/lib/commandclass/MeterCC.ts#L873-L881
+RESET_METER_OPTION_TARGET_VALUE = "targetValue"
+RESET_METER_OPTION_TYPE = "type"
+
+
+# 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 ElectricScale(IntEnum):
+    """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(IntEnum):
+    """Enum with all known gas meter scale values."""
+
+    CUBIC_METER = 0
+    CUBIC_FEET = 1
+    PULSE_COUNT = 3
+
+
+class WaterScale(IntEnum):
+    """Enum with all known water meter scale values."""
+
+    CUBIC_METER = 0
+    CUBIC_FEET = 1
+    US_GALLON = 2
+    PULSE_COUNT = 3
+
+
+class HeatingScale(IntEnum):
+    """Enum with all known heating meter scale values."""
+
+    KILOWATT_HOUR = 0
+
+
+CoolingScale = HeatingScale
+
+MeterScaleType = Union[CoolingScale, ElectricScale, GasScale, HeatingScale, WaterScale]
+
+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: Set[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: Set[MeterScaleType] = {
+    ElectricScale.WATT,
+    ElectricScale.KILOVOLT_AMPERE_REACTIVE,
+}
+POWER_FACTOR_METER_TYPES: Set[MeterScaleType] = {ElectricScale.POWER_FACTOR}
+VOLTAGE_METER_TYPES: Set[MeterScaleType] = {ElectricScale.VOLT}
+CURRENT_METER_TYPES: Set[MeterScaleType] = {ElectricScale.AMPERE}
+GAS_METER_TYPES: Set[MeterScaleType] = {
+    GasScale.CUBIC_METER,
+    GasScale.CUBIC_FEET,
+    GasScale.PULSE_COUNT,
+}
+WATER_METER_TYPES: Set[MeterScaleType] = {
+    WaterScale.CUBIC_METER,
+    WaterScale.CUBIC_FEET,
+    WaterScale.US_GALLON,
+    WaterScale.PULSE_COUNT,
+}