circuitmatter.interaction_model

Classes

`StatusCode`	Enum where members are also (and must be) ints
`AttributePathIB`	Section 10.6.2
`EventPathIB`	Section 10.6.8
`EventFilterIB`	Section 10.6.6
`ClusterPathIB`
`DataVersionFilterIB`
`StatusIB`
`AttributeDataIB`
`AttributeStatusIB`
`AttributeReportIB`
`InteractionModelMessage`
`ChunkedMessage`	Chunked messages take multiple encodes or decodes before they are complete.
`ReadRequestMessage`
`WriteRequestMessage`	Chunked messages take multiple encodes or decodes before they are complete.
`WriteResponseMessage`
`EventStatusIB`
`EventDataIB`
`EventReportIB`
`ReportDataMessage`	Chunked messages take multiple encodes or decodes before they are complete.
`CommandPathIB`
`CommandDataIB`
`CommandStatusIB`
`InvokeResponseIB`
`InvokeRequestMessage`
`InvokeResponseMessage`
`SubscribeRequestMessage`
`StatusResponseMessage`
`SubscribeResponseMessage`

Module Contents

class circuitmatter.interaction_model.StatusCode

Bases: enum.IntEnum

Enum where members are also (and must be) ints

SUCCESS = 0: Operation was successful.

FAILURE = 1: Operation was not successful.

INVALID_SUBSCRIPTION = 125: Subscription ID is not active.

UNSUPPORTED_ACCESS = 126: The sender of the action or command does not have authorization or access.

UNSUPPORTED_ENDPOINT = 127: The endpoint indicated is unsupported on the node.

INVALID_ACTION = 128: The action is malformed, has missing fields, or fields with invalid values. Action not carried out.

UNSUPPORTED_COMMAND = 129: The indicated command ID is not supported on the cluster instance. Command not carried out.

INVALID_COMMAND = 133: The cluster command is malformed, has missing fields, or fields with invalid values. Command not carried out.

UNSUPPORTED_ATTRIBUTE = 134: The indicated attribute ID, field ID or list entry does not exist for an attribute path.

CONSTRAINT_ERROR = 135: Out of range error or set to a reserved value. Attribute keeps its old value. Note that an attribute value may be out of range if an attribute is related to another, e.g. with minimum and maximum attributes. See the individual attribute descriptions for specific details.

UNSUPPORTED_WRITE = 136: Attempt to write a read-only attribute.

RESOURCE_EXHAUSTED = 137: An action or operation failed due to insufficient available resources.

NOT_FOUND = 139: The indicated data field or entry could not be found.

UNREPORTABLE_ATTRIBUTE = 140: Reports cannot be issued for this attribute.

INVALID_DATA_TYPE = 141: The data type indicated is undefined or invalid for the indicated data field. Command or action not carried out.

UNSUPPORTED_READ = 143: Attempt to read a write-only attribute.

DATA_VERSION_MISMATCH = 146: Cluster instance data version did not match request path.

TIMEOUT = 148: The transaction was aborted due to time being exceeded.

UNSUPPORTED_NODE = 155: The node ID indicated is not supported on the node.

BUSY = 156: The receiver is busy processing another action that prevents the execution of the incoming action.

UNSUPPORTED_CLUSTER = 195: The cluster indicated is not supported on the endpoint.

NO_UPSTREAM_SUBSCRIPTION = 197: Used by proxies to convey to clients the lack of an upstream subscription to a source.

NEEDS_TIMED_INTERACTION = 198: A Untimed Write or Untimed Invoke interaction was used for an attribute or command that requires a Timed Write or Timed Invoke.

UNSUPPORTED_EVENT = 199: The indicated event ID is not supported on the cluster instance.

PATHS_EXHAUSTED = 200: The receiver has insufficient resources to support the specified number of paths in the request.

TIMED_REQUEST_MISMATCH = 201: A request with TimedRequest field set to TRUE was issued outside a Timed transaction or a request with TimedRequest set to FALSE was issued inside a Timed transaction.

FAILSAFE_REQUIRED = 202: A request requiring a Fail-safe context was invoked without the Fail-Safe context.

INVALID_IN_STATE = 203: The received request cannot be handled due to the current operational state of the device.

NO_COMMAND_RESPONSE = 204: A CommandDataIB is missing a response in the InvokeResponses of an Invoke Response action.

class circuitmatter.interaction_model.AttributePathIB

Bases: circuitmatter.tlv.List

Section 10.6.2

EnableTagCompression

Node

Endpoint

Cluster

Attribute

ListIndex

WildcardPathFlags

items = []

values

__iter__()

__str__()

encode() → memoryview

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

classmethod from_value(value)

set_value(tag, value)

delete_value(tag)

copy()

classmethod max_length()

class circuitmatter.interaction_model.EventPathIB

Bases: circuitmatter.tlv.List

Section 10.6.8

Node

Endpoint

Cluster

Event

IsUrgent

items = []

values

__iter__()

__str__()

encode() → memoryview

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

classmethod from_value(value)

set_value(tag, value)

delete_value(tag)

copy()

classmethod max_length()

class circuitmatter.interaction_model.EventFilterIB

Bases: circuitmatter.tlv.Structure

Section 10.6.6

Node

EventMinimumInterval

__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)

class circuitmatter.interaction_model.ClusterPathIB

Bases: circuitmatter.tlv.List

Node

Endpoint

Cluster

items = []

values

__iter__()

__str__()

encode() → memoryview

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

classmethod from_value(value)

set_value(tag, value)

delete_value(tag)

copy()

classmethod max_length()

class circuitmatter.interaction_model.DataVersionFilterIB

Bases: circuitmatter.tlv.Structure

Path

DataVersion

__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)

class circuitmatter.interaction_model.StatusIB

Bases: circuitmatter.tlv.Structure

Status

ClusterStatus

__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)

class circuitmatter.interaction_model.AttributeDataIB

Bases: circuitmatter.tlv.Structure

DataVersion

Path

Data

__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)

class circuitmatter.interaction_model.AttributeStatusIB

Bases: circuitmatter.tlv.Structure

Path

Status

__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)

class circuitmatter.interaction_model.AttributeReportIB

Bases: circuitmatter.tlv.Structure

AttributeStatus

AttributeData

__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)

class circuitmatter.interaction_model.InteractionModelMessage

Bases: circuitmatter.tlv.Structure

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.ChunkedMessage

Bases: InteractionModelMessage

Chunked messages take multiple encodes or decodes before they are complete.

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

PROTOCOL_ID

InteractionModelRevision

__str__()

encode() → memoryview

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)

class circuitmatter.interaction_model.ReadRequestMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

AttributeRequests

EventRequests

EventFilters

FabricFiltered

DataVersionFilters

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.WriteRequestMessage

Bases: ChunkedMessage

Chunked messages take multiple encodes or decodes before they are complete.

PROTOCOL_OPCODE

SuppressResponse

TimedRequest

WriteRequests

MoreChunkedMessages

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

PROTOCOL_ID

InteractionModelRevision

__str__()

encode() → memoryview

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)

class circuitmatter.interaction_model.WriteResponseMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

WriteResponses

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.EventStatusIB

Bases: circuitmatter.tlv.Structure

Path

Status

__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)

class circuitmatter.interaction_model.EventDataIB

Bases: circuitmatter.tlv.Structure

Path

EventNumber

PriorityLevel

EpochTimestamp

SystemTimestamp

DeltaEpochTimestamp

DeltaSystemTimestamp

Data

__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)

class circuitmatter.interaction_model.EventReportIB

Bases: circuitmatter.tlv.Structure

EventStatus

EventData

__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)

class circuitmatter.interaction_model.ReportDataMessage

Bases: ChunkedMessage

Chunked messages take multiple encodes or decodes before they are complete.

PROTOCOL_OPCODE

SubscriptionId

AttributeReports

EventReports

MoreChunkedMessages

SuppressResponse

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

PROTOCOL_ID

InteractionModelRevision

__str__()

encode() → memoryview

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)

class circuitmatter.interaction_model.CommandPathIB

Bases: circuitmatter.tlv.List

Endpoint

Cluster

Command

items = []

values

__iter__()

__str__()

encode() → memoryview

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

classmethod from_value(value)

set_value(tag, value)

delete_value(tag)

copy()

classmethod max_length()

class circuitmatter.interaction_model.CommandDataIB

Bases: circuitmatter.tlv.Structure

CommandPath

CommandFields

CommandRef

__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)

class circuitmatter.interaction_model.CommandStatusIB

Bases: circuitmatter.tlv.Structure

CommandPath

Status

CommandRef

__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)

class circuitmatter.interaction_model.InvokeResponseIB

Bases: circuitmatter.tlv.Structure

Command

Status

__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)

class circuitmatter.interaction_model.InvokeRequestMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

SuppressResponse

TimedRequest

InvokeRequests

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.InvokeResponseMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

SuppressResponse

InvokeResponses

MoreChunkedMessages

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.SubscribeRequestMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

KeepSubscriptions

MinIntervalFloor

MaxIntervalCeiling

AttributeRequests

EventRequests

EventFilters

FabricFiltered

DataVersionFilters

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.StatusResponseMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

Status

PROTOCOL_ID

InteractionModelRevision

__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)

class circuitmatter.interaction_model.SubscribeResponseMessage

Bases: InteractionModelMessage

PROTOCOL_OPCODE

SubscriptionId

MaxInterval

PROTOCOL_ID

InteractionModelRevision

__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)