circuitmatter.clusters.system_model.access_control

Classes

`AccessControlEntryPrivilegeEnum`	Enum where members are also (and must be) ints
`AccessControlEntryAuthModeEnum`	Enum where members are also (and must be) ints
`AccessControlTargetStruct`
`AccessControlCluster`

Module Contents

class circuitmatter.clusters.system_model.access_control.AccessControlEntryPrivilegeEnum

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

VIEW = 1: Can read and observe all (except Access Control Cluster and as seen by a non-Proxy)

PROXY_VIEW = 2: Can read and observe all (as seen by a Proxy)

OPERATE = 3: View privileges, and can perform the primary function of this Node (except Access Control Cluster)

MANAGE = 4: Operate privileges, and can modify persistent configuration of this Node (except Access Control Cluster)

ADMINISTER = 5: Manage privileges, and can observe and modify the Access Control Cluster

class circuitmatter.clusters.system_model.access_control.AccessControlEntryAuthModeEnum

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

PASE = 1: Passcode authenticated session

CASE = 2: Certificate authenticated session

GROUP = 3: Group authenticated session

class circuitmatter.clusters.system_model.access_control.AccessControlTargetStruct

Bases: circuitmatter.tlv.Structure

Cluster

Endpoint

DeviceType

__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.clusters.system_model.access_control.AccessControlCluster

Bases: circuitmatter.data_model.Cluster

CLUSTER_ID = 31

class AccessControlEntryStruct

Bases: circuitmatter.tlv.Structure

Privilege

AuthMode

Subjects

Targets

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

Bases: circuitmatter.tlv.Structure

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

ACL

Extension

SubjectsPerAccessControlEntry

TargetsPerAccessControlEntry

AccessControlEntriesPerFabric

cluster_revision

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