pyzwave.types module

class pyzwave.types.BitStreamReader(value)

Bases: object

Class for parsing streams bitwise

advance(length)

Advance the stream length bits

bit(advance: bool = True) → int

Return the next bit in the stream

bits(size: int = 8, advance=True) → int

Return size number of bits in the stream

byte(advance: bool = True) → int

Return one byte from the stream

bytesLeft() → int

Return the number of bytes remaining from the stream

peekByte() → int

Return the next byte from the stream without advancing the stream

peekValue(size: int) → bytes

Return the next value from the stream without advancing the stream

remaining(advance: bool = True) → bytes

Return all the remaining bytes in the stream

value(size: int, advance: bool = True) → bytes

Return the next size number of bytes from the stream

class pyzwave.types.BitStreamWriter

Bases: bytearray

Class for wringing a butearray bitwise

addBits(value, size)

Add size number of bits to the stream

addBytes(value, size, signed, endian='big')

Add size number of bytes to the stream

class pyzwave.types.BitsBase(value: int)

Bases: object

Base type for bit values

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize bits from stream

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize bits into stream

sizeBits = 1

class pyzwave.types.HomeID

Bases: pyzwave.types.uint32_t

Type for Z-Wave Home ID

class pyzwave.types.IPv6(address)

Bases: ipaddress.IPv6Address

Type for a IPv6 address

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize an IPv6 address

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize the IPv6 address

pyzwave.types.bits_t(size)

Return the type for size number of bits

class pyzwave.types.bytes_t

Bases: bytes

Variable size bytes

default = b''

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize bytes from stream

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize into stream

class pyzwave.types.dsk_t(dsk=None)

Bases: object

Type for a DSK key

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize 16 bytes DSK

static deserializeN(stream: pyzwave.types.BitStreamReader, length: int)

Deserialize variable length DSK

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize DSK

pyzwave.types.enum_t(enumType, baseType)

Return a new enum type based on the specified type

class pyzwave.types.flag_t(value: int)

Bases: pyzwave.types.BitsBase

Type represeting one bit

class pyzwave.types.float_t(_value=0, size=1, scale=0)

Bases: float

Type for representing signed float values.

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize float value from stream

property scale

The scale this value represents

class pyzwave.types.int24_t

Bases: pyzwave.types.int_t

Signed 24 bits value

size = 3

class pyzwave.types.int_t

Bases: int

Base class for any int like type

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize unsigned value from stream

endian = 'big'

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize into stream

signed = True

size = 0

pyzwave.types.reserved_t(size)

Return the type for bits that are reserved and must not be used

class pyzwave.types.str_t

Bases: str

Unicode string

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize unicode string

class pyzwave.types.uint16_t

Bases: pyzwave.types.uint_t

Unsigned word

size = 2

class pyzwave.types.uint32_t

Bases: pyzwave.types.uint_t

Unsigned 32 bits value

size = 4

class pyzwave.types.uint3_t

Bases: int

Type representing 3 bits value

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize bits from stream

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize bits into stream

class pyzwave.types.uint4_t

Bases: int

Type representing 4 bits value

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize bits from stream

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize bits into stream

class pyzwave.types.uint5_t

Bases: int

Type representing 5 bits value

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize bits from stream

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize bits into stream

class pyzwave.types.uint7_t

Bases: int

Type representing 7 bits value

classmethod deserialize(stream: pyzwave.types.BitStreamReader)

Deserialize bits from stream

serialize(stream: pyzwave.types.BitStreamWriter)

Serialize bits into stream

class pyzwave.types.uint8_t

Bases: pyzwave.types.uint_t

Unsigned byte

size = 1

class pyzwave.types.uint_t

Bases: pyzwave.types.int_t

Base class for any unsigned int like type

signed = False

size = 1