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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
|
"""Constants for the Z-Wave JS python library."""
from __future__ import annotations
from dataclasses import dataclass, field
from enum import Enum, IntEnum
import logging
from typing import TypedDict
PACKAGE_NAME = "zwave-js-server-python"
__version__ = "0.67.1"
# minimal server schema version we can handle
MIN_SERVER_SCHEMA_VERSION = 44
# max server schema version we can handle (and our code is compatible with)
MAX_SERVER_SCHEMA_VERSION = 44
VALUE_UNKNOWN = "unknown"
NOT_INTERVIEWED = "None"
INTERVIEW_FAILED = "Failed"
CURRENT_STATE_PROPERTY = "currentState"
TARGET_STATE_PROPERTY = "targetState"
CURRENT_VALUE_PROPERTY = "currentValue"
TARGET_VALUE_PROPERTY = "targetValue"
DURATION_PROPERTY = "duration"
TRANSITION_DURATION_OPTION = "transitionDuration"
VOLUME_OPTION = "volume"
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"
LOG_LEVEL_MAP: dict[LogLevel, int] = {
LogLevel.ERROR: logging.ERROR,
LogLevel.WARN: logging.WARN,
LogLevel.INFO: logging.INFO,
LogLevel.HTTP: logging.INFO,
LogLevel.VERBOSE: logging.DEBUG,
LogLevel.DEBUG: logging.DEBUG,
LogLevel.SILLY: logging.DEBUG,
}
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."""
BOOLEAN = "boolean"
ENUMERATED = "enumerated"
MANUAL_ENTRY = "manual_entry"
RANGE = "range"
UNDEFINED = "undefined"
class NodeType(IntEnum):
"""Enum with all Node types."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/capabilities/NodeInfo.ts#L151-L156
CONTROLLER = 0
END_NODE = 1
# Exclusion enums
class ExclusionStrategy(IntEnum):
"""Enum with all exclusion strategies."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L49-L56
EXCLUDE_ONLY = 0
DISABLE_PROVISIONING_ENTRY = 1
UNPROVISION = 2
# 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
class QRCodeVersion(IntEnum):
"""Enum for all known QR Code versions."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/security/QR.ts#L43-L46
S2 = 0
SMART_START = 1
class Protocols(IntEnum):
"""Enum for all known protocols."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/capabilities/Protocols.ts#L1-L4
ZWAVE = 0
ZWAVE_LONG_RANGE = 1
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/security/QR.ts#L41
MINIMUM_QR_STRING_LENGTH = 52
class ZwaveFeature(IntEnum):
"""Enum for all known Zwave features."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Features.ts#L4
SMART_START = 0
class PowerLevel(IntEnum):
"""Enum for all known power levels."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/commandclass/PowerlevelCC.ts#L38
NORMAL_POWER = 0
DBM_MINUS_1 = 1
DBM_MINUS_2 = 2
DBM_MINUS_3 = 3
DBM_MINUS_4 = 4
DBM_MINUS_5 = 5
DBM_MINUS_6 = 6
DBM_MINUS_7 = 7
DBM_MINUS_8 = 8
DBM_MINUS_9 = 9
class InclusionState(IntEnum):
"""Enum for all known inclusion states."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L154
IDLE = 0
INCLUDING = 1
EXCLUDING = 2
BUSY = 3
SMART_START = 4
class RFRegion(IntEnum):
"""Enum for all known RF regions."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/definitions/RFRegion.ts#L1
EUROPE = 0
USA = 1
AUSTRALIA_AND_NEW_ZEALAND = 2
HONG_KONG = 3
INDIA = 5
ISRAEL = 6
RUSSIA = 7
CHINA = 8
USA_LONG_RANGE = 9
EUROPE_LONG_RANGE = 11
JAPAN = 32
KOREA = 33
UNKNOWN = 254
DEFAULT_EU = 255
class ProtocolDataRate(IntEnum):
"""Enum for all known protocol data rates."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/capabilities/Protocols.ts#L6
ZWAVE_9K6 = 1
ZWAVE_40K = 2
ZWAVE_100K = 3
LONG_RANGE_100K = 4
class RssiError(IntEnum):
"""Enum for all known RSSI errors."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/SendDataShared.ts#L79
NOT_AVAILABLE = 127
RECEIVER_SATURATED = 126
NO_SIGNAL_DETECTED = 125
class ProvisioningEntryStatus(IntEnum):
"""Enum for all known provisioning entry statuses."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L136
ACTIVE = 0
INACTIVE = 1
class SecurityBootstrapFailure(IntEnum):
"""Enum with all security bootstrap failure reasons."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L16
USER_CANCELED = 0
NO_KEYS_CONFIGURED = 1
S2_NO_USER_CALLBACKS = 2
TIMEOUT = 3
PARAMETER_MISMATCH = 4
NODE_CANCELED = 5
S2_INCORRECT_PIN = 6
S2_WRONG_SECURITY_LEVEL = 7
UNKNOWN = 8
class SetValueStatus(IntEnum):
"""Enum for all known setValue statuses."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/cc/src/lib/API.ts#L83
# The device reports no support for this command
NO_DEVICE_SUPPORT = 0
# The device has accepted the command and is working on it
WORKING = 1
# The device has rejected the command
FAIL = 2
# The endpoint specified in the value ID does not exist
ENDPOINT_NOT_FOUND = 3
# The given CC or its API is not implemented (yet) or it has no `setValue`
# implementation
NOT_IMPLEMENTED = 4
# The value to set (or a related value) is invalid
INVALID_VALUE = 5
# The command was sent successfully, but it is unknown whether it was executed
SUCCESS_UNSUPERVISED = 254
# The device has executed the command successfully
SUCCESS = 255
SET_VALUE_SUCCESS = (
SetValueStatus.SUCCESS,
SetValueStatus.SUCCESS_UNSUPERVISED,
SetValueStatus.WORKING,
)
class RemoveNodeReason(IntEnum):
"""Enum for all known reasons why a node was removed."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L266
# The node was excluded by the user or an inclusion controller
EXCLUDED = 0
# The node was excluded by an inclusion controller
PROXY_EXCLUDED = 1
# The node was removed using the "remove failed node" feature
REMOVE_FAILED = 2
# The node was replaced using the "replace failed node" feature
REPLACED = 3
# The node was replaced by an inclusion controller
PROXY_REPLACED = 4
# The node was reset locally and was auto-removed
RESET = 5
# SmartStart inclusion failed, and the node was auto-removed as a result.
SMART_START_FAILED = 6
class Weekday(IntEnum):
"""Enum for all known weekdays."""
UNKNOWN = 0
MONDAY = 1
TUESDAY = 2
WEDNESDAY = 3
THURSDAY = 4
FRIDAY = 5
SATURDAY = 6
SUNDAY = 7
class DateAndTimeDataType(TypedDict, total=False):
"""Represent a date and time data type."""
hour: int
minute: int
weekday: int
second: int
year: int
month: int
day: int
dstOffset: int
standardOffset: int
@dataclass
class DateAndTime:
"""Represent a date and time."""
data: DateAndTimeDataType = field(repr=False)
hour: int | None = field(init=False)
minute: int | None = field(init=False)
weekday: Weekday | None = field(default=None, init=False)
second: int | None = field(init=False)
year: int | None = field(init=False)
month: int | None = field(init=False)
day: int | None = field(init=False)
dst_offset: int | None = field(init=False)
standard_offset: int | None = field(init=False)
def __post_init__(self) -> None:
"""Post initialization."""
self.hour = self.data.get("hour")
self.minute = self.data.get("minute")
if weekday := self.data.get("weekday"):
self.weekday = Weekday(weekday)
self.second = self.data.get("second")
self.year = self.data.get("year")
self.month = self.data.get("month")
self.day = self.data.get("day")
self.dst_offset = self.data.get("dstOffset")
self.standard_offset = self.data.get("standardOffset")
class ControllerStatus(IntEnum):
"""Enum for all known controller statuses."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/consts/ControllerStatus.TS
# The controller is ready to accept commands and transmit
READY = 0
# The controller is unresponsive
UNRESPONSIVE = 1
# The controller is unable to transmit
JAMMED = 2
class SupervisionStatus(IntEnum):
"""Enum for all known supervision statuses."""
# https://github.com/zwave-js/node-zwave-js/blob/cc_api_options/packages/core/src/consts/Transmission.ts#L304
NO_SUPPORT = 0
WORKING = 1
FAIL = 2
SUCCESS = 255
class AssociationCheckResult(IntEnum):
"""Enum for all known association check results."""
# https://github.com/zwave-js/node-zwave-js/blob/master/packages/cc/src/lib/_Types.ts#L47
OK = 1
FORBIDDEN_DESTINATION_IS_LONG_RANGE = 2
FORBIDDEN_SOURCE_IS_LONG_RANGE = 3
FORBIDDEN_SELF_ASSOCIATION = 4
FORBIDDEN_SECURITY_CLASS_MISMATCH = 5
FORBIDDEN_DESTINATION_SECURITY_CLASS_NOT_GRANTED = 6
FORBIDDEN_NO_SUPPORTED_CCS = 7
|