circuitmatter.clusters.lighting.color_control

Classes

`FeatureBitmap`	Support for integer-based Flags
`OptionsBitmap`	Support for integer-based Flags
`Direction`	Enum where members are also (and must be) ints
`MoveMode`	Enum where members are also (and must be) ints
`StepMode`	Enum where members are also (and must be) ints
`ColorMode`	Enum where members are also (and must be) ints
`ColorControl`

Module Contents

class circuitmatter.clusters.lighting.color_control.FeatureBitmap

Bases: enum.IntFlag

Support for integer-based Flags

HUE_SATURATION

ENHANCED_HUE

COLOR_LOOP

XY

COLOR_TEMPERATURE

class circuitmatter.clusters.lighting.color_control.OptionsBitmap

Bases: circuitmatter.data_model.Map8

Support for integer-based Flags

EXECUTE_IF_OFF

class circuitmatter.clusters.lighting.color_control.Direction

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

SHORTEST_DISTANCE = 0

LONGEST_DISTANCE = 1

UP = 2

DOWN = 3

class circuitmatter.clusters.lighting.color_control.MoveMode

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

STOP = 0

UP = 1

DOWN = 3

class circuitmatter.clusters.lighting.color_control.StepMode

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

UP = 1

DOWN = 3

class circuitmatter.clusters.lighting.color_control.ColorMode

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

HUE_SATURATION = 0

XY = 1

COLOR_TEMPERATURE = 2

class circuitmatter.clusters.lighting.color_control.ColorControl

Bases: circuitmatter.data_model.Cluster

CLUSTER_ID = 768

cluster_revision = 6

current_hue

current_saturation

remaining_time

current_x

current_y

drift_compensation

compensation_text

color_temperature

color_mode

options

color_capabilities

color_temp_physical_min_mireds

color_temp_physical_max_mireds

class MoveToHue

Bases: circuitmatter.tlv.Structure

Hue

Direction

TransitionTime

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

move_to_hue

class MoveHue

Bases: circuitmatter.tlv.Structure

MoveMode

Rate

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

move_hue

class StepHue

Bases: circuitmatter.tlv.Structure

StepMode

StepSize

TransitionTime

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

step_hue

class MoveToSaturation

Bases: circuitmatter.tlv.Structure

Saturation

TransitionTime

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

move_to_saturation

class MoveSaturation

Bases: circuitmatter.tlv.Structure

MoveMode

Rate

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

move_saturation

class StepSaturation

Bases: circuitmatter.tlv.Structure

StepMode

StepSize

TransitionTime

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

step_saturation

class MoveToHueAndSaturation

Bases: circuitmatter.tlv.Structure

Hue

Saturation

TransitionTime

OptionsMask

OptionsOverride

__str__()

encode() → memoryview

encode_into(buffer: bytearray, offset: int = 0) → int

classmethod decode(buffer: memoryview, offset=0) → Structure

classmethod decode_member(control_octet, buffer, offset=0, depth=0) → tuple[dict, int]

construct_containers()

classmethod from_value(value)

values

classmethod max_length()

set_value(tag, value)

delete_value(tag)

move_to_hue_and_saturation

feature_map

attribute_list

event_list

accepted_command_list

generated_command_list

data_version

__contains__(descriptor_id)

restore(nonvolatile)

get_attribute_data(session, path, subscription=None) → list[circuitmatter.interaction_model.AttributeDataIB]

set_attribute(context, attribute_data) → circuitmatter.interaction_model.AttributeStatusIB

invoke(session, path, fields) → circuitmatter.interaction_model.CommandDataIB | circuitmatter.interaction_model.StatusCode | None