pyzwave.commandclass.Configuration module

class pyzwave.commandclass.Configuration.BulkGet(parameterOffset, numberOfParameters)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_CONFIGURATION CONFIGURATION_BULK_GET_V2

NAME = 'BULK_GET'
attributes = (('parameterOffset', <class 'pyzwave.types.uint16_t'>), ('numberOfParameters', <class 'pyzwave.types.uint8_t'>))
class pyzwave.commandclass.Configuration.BulkReport(parameterOffset, numberOfParameters, reportsToFollow, default, handshake, -, size, parameter)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_CONFIGURATION CONFIGURATION_BULK_REPORT_V2

NAME = 'BULK_REPORT'
attributes = (('parameterOffset', <class 'pyzwave.types.uint16_t'>), ('numberOfParameters', <class 'pyzwave.types.uint8_t'>), ('reportsToFollow', <class 'pyzwave.types.uint8_t'>), ('default', <class 'pyzwave.types.flag_t'>), ('handshake', <class 'pyzwave.types.flag_t'>), ('-', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('size', <class 'pyzwave.types.enum_t.<locals>.enum_t'>), ('parameter', <class 'pyzwave.types.bytes_t'>))
class pyzwave.commandclass.Configuration.Configuration(parameters)

Bases: pyzwave.commandclass.CommandClass.CommandClass

Command Class COMMAND_CLASS_CONFIGURATION

NAME = 'CONFIGURATION'
attributes = (('parameters', <class 'pyzwave.commandclass.CommandClass.VarDictAttribute.<locals>.VarDictAttributeType'>),)
async get(number: int, cached: bool = True) → int

Request configuration value from node. Return the cached value if it is already known.

async set(parameterNumber: int, size: pyzwave.commandclass.Configuration.Size, value: int) → bool

Set a configuration value in the node

class pyzwave.commandclass.Configuration.ConfigurationValue(value, size)

Bases: pyzwave.commandclass.CommandClass.DictAttribute

Helper class for holding one configuration value

attributes = (('value', <class 'int'>), ('size', <class 'int'>))
class pyzwave.commandclass.Configuration.Get(parameterNumber)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_CONFIGURATION CONFIGURATION_GET

NAME = 'GET'
attributes = (('parameterNumber', <class 'pyzwave.types.uint8_t'>),)
class pyzwave.commandclass.Configuration.Report(parameterNumber, -, size, value)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_CONFIGURATION CONFIGURATION_REPORT

NAME = 'REPORT'
attributes = (('parameterNumber', <class 'pyzwave.types.uint8_t'>), ('-', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('size', <class 'pyzwave.types.enum_t.<locals>.enum_t'>), ('value', <class 'int'>))
parse_value(stream: pyzwave.types.BitStreamReader)

Decode the value from the report

class pyzwave.commandclass.Configuration.Set(parameterNumber, default, -, size, value)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_CONFIGURATION CONFIGURATION_SET

NAME = 'SET'
attributes = (('parameterNumber', <class 'pyzwave.types.uint8_t'>), ('default', <class 'pyzwave.types.flag_t'>), ('-', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('size', <class 'pyzwave.types.enum_t.<locals>.enum_t'>), ('value', <class 'int'>))
compose_value(stream: pyzwave.types.BitStreamWriter)

Write the value to the bitstream. The value is variable size

class pyzwave.commandclass.Configuration.Size

Bases: enum.IntEnum

Size enum for configurations

SIZE_16_BIT = 2
SIZE_32_BIT = 4
SIZE_8_BIT = 1