pyzwave.commandclass.Zip module

class pyzwave.commandclass.Zip.HeaderExtension

Bases: pyzwave.commandclass.CommandClass.VarDictAttributeType

Decoder type for header extensions in Command Class message ZIP_PACKET

default = {}

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize header extension from stream

property expectedDelay

Returns the expected delay for sleeping nodes

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize header extension into stream

class pyzwave.commandclass.Zip.IMEAckChannel

Bases: pyzwave.commandclass.Zip.IMEValue, pyzwave.types.uint8_t

Ack channel

class pyzwave.commandclass.Zip.IMELastWorkingRoute(repeater1, repeater2, repeater3, repeater4, speed)

Bases: pyzwave.commandclass.Zip.IMEValue, pyzwave.util.AttributesMixin

Last working route

class Speed

Bases: enum.IntEnum

Communication speed

SPEED_100_KBIT_S = 3

SPEED_40_KBIT_S = 2

SPEED_9_6_KBIT_S = 1

attributes = (('repeater1', <class 'pyzwave.types.uint8_t'>), ('repeater2', <class 'pyzwave.types.uint8_t'>), ('repeater3', <class 'pyzwave.types.uint8_t'>), ('repeater4', <class 'pyzwave.types.uint8_t'>), ('speed', <class 'pyzwave.types.enum_t.<locals>.enum_t'>))

classmethod load(value)

Load IME value

class pyzwave.commandclass.Zip.IMERouteChanged

Bases: pyzwave.commandclass.Zip.IMEValue, pyzwave.types.uint8_t

Route changed

class pyzwave.commandclass.Zip.IMETransmissionTime

Bases: pyzwave.commandclass.Zip.IMEValue, pyzwave.types.uint16_t

Transmission time

class pyzwave.commandclass.Zip.IMETransmitChannel

Bases: pyzwave.commandclass.Zip.IMEValue, pyzwave.types.uint8_t

Transmit channel

class pyzwave.commandclass.Zip.IMEType

Bases: enum.IntEnum

IME Type

ACK_CHANNEL = 4

LAST_FAILED_LINK = 8

LAST_WORKING_ROUTE = 2

ROUTE_CHANGED = 0

ROUTING_ATTEMPTS = 7

ROUTING_SCHEME = 6

RSSI = 3

TRANSMISION_TIME = 1

TRANSMIT_CHANNEL = 5

class pyzwave.commandclass.Zip.IMEUnknownValue

Bases: pyzwave.commandclass.Zip.IMEValue, pyzwave.types.bytes_t

Type not yet implemented

class pyzwave.commandclass.Zip.IMEValue

Bases: object

Default base type for IME values

classmethod load(value)

Load IME value

class pyzwave.commandclass.Zip.ZIPPacketOption(critical, optionType, optionData)

Bases: pyzwave.util.AttributesMixin

ZIP Packet option

attributes = (('critical', <class 'pyzwave.types.flag_t'>), ('optionType', <class 'pyzwave.types.enum_t.<locals>.enum_t'>), ('optionData', <class 'pyzwave.commandclass.Zip.ZIPPacketOptionData'>))

parse_optionData(stream: pyzwave.types.BitStreamReader)

Parse attribute optionData

class pyzwave.commandclass.Zip.ZIPPacketOptionData

Bases: object

ZIP Packet Option Data

class pyzwave.commandclass.Zip.ZIPPacketOptionEncapsulationFormatInfo(security2SecurityClass, -, crc16)

Bases: pyzwave.commandclass.Zip.ZIPPacketOptionData, pyzwave.util.AttributesMixin

Zip packet option encapsulation format info

attributes = (('security2SecurityClass', <class 'pyzwave.types.bits_t.<locals>.bits_t'>), ('-', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('crc16', <class 'pyzwave.types.flag_t'>))

class pyzwave.commandclass.Zip.ZIPPacketOptionExpectedDelay

Bases: pyzwave.commandclass.Zip.ZIPPacketOptionData, pyzwave.types.int24_t

Zip Packet option expexted delay

class pyzwave.commandclass.Zip.ZIPPacketOptionMaintenanceReport

Bases: pyzwave.commandclass.Zip.ZIPPacketOptionData, pyzwave.commandclass.CommandClass.VarDictAttributeType

Maintenance report

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize ZIP Maintenance Report

class pyzwave.commandclass.Zip.ZIPPacketOptionType

Bases: enum.IntEnum

ZIP Packet option type

ENCAPSULATION_FORMAT_INFORMATION = 4

EXPECTED_DELAY = 1

MAINTENANCE_GET = 2

MAINTENANCE_REPORT = 3

ZWAVE_MULTICAST_ADDRESSING = 5

class pyzwave.commandclass.Zip.ZipKeepAlive(ackRequest, ackResponse, _)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_ZIP COMMAND_ZIP_KEEP_ALIVE

NAME = 'ZIP_KEEP_ALIVE'

attributes = (('ackRequest', <class 'pyzwave.types.flag_t'>), ('ackResponse', <class 'pyzwave.types.flag_t'>), ('_', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>))

class pyzwave.commandclass.Zip.ZipPacket(ackRequest, ackResponse, nackResponse, nackWaiting, nackQueueFull, nackOptionError, _, headerExtIncluded, zwCmdIncluded, moreInformation, secureOrigin, _, seqNo, -, sourceEP, -, destEP, headerExtension, command)

Bases: pyzwave.message.Message

Command Class message COMMAND_CLASS_ZIP COMMAND_ZIP_PACKET

NAME = 'ZIP_PACKET'

attributes = (('ackRequest', <class 'pyzwave.types.flag_t'>), ('ackResponse', <class 'pyzwave.types.flag_t'>), ('nackResponse', <class 'pyzwave.types.flag_t'>), ('nackWaiting', <class 'pyzwave.types.flag_t'>), ('nackQueueFull', <class 'pyzwave.types.flag_t'>), ('nackOptionError', <class 'pyzwave.types.flag_t'>), ('_', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('headerExtIncluded', <class 'pyzwave.types.flag_t'>), ('zwCmdIncluded', <class 'pyzwave.types.flag_t'>), ('moreInformation', <class 'pyzwave.types.flag_t'>), ('secureOrigin', <class 'pyzwave.types.flag_t'>), ('_', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('seqNo', <class 'pyzwave.types.uint8_t'>), ('-', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('sourceEP', <class 'pyzwave.types.uint7_t'>), ('-', <class 'pyzwave.types.reserved_t.<locals>.reserved_t'>), ('destEP', <class 'pyzwave.types.uint7_t'>), ('headerExtension', <class 'pyzwave.commandclass.Zip.HeaderExtension'>), ('command', <class 'pyzwave.message.Message'>))

parse_headerExtension(stream: pyzwave.types.BitStreamReader)

Parse header extension if supplied

response(success: bool, nackWaiting: bool = False, nackQueueFull: bool = False, nackOptionError: bool = False) → pyzwave.message.Message

Generate an ackResponse for this messsage. Use if ackRequest is set