circuitmatter.clusters.device_management.node_operational_credentials

Attributes

RESP_MAX

Classes

`CertificateChainTypeEnum`	Enum where members are also (and must be) ints
`NodeOperationalCertStatusEnum`	Enum where members are also (and must be) ints
`NodeOperationalCredentialsCluster`

Module Contents

class circuitmatter.clusters.device_management.node_operational_credentials.CertificateChainTypeEnum

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

DAC = 1

PAI = 2

class circuitmatter.clusters.device_management.node_operational_credentials.NodeOperationalCertStatusEnum

Bases: circuitmatter.data_model.Enum8

Enum where members are also (and must be) ints

OK = 0: OK, no error

INVALID_PUBLIC_KEY = 1: Public Key in the NOC does not match the public key in the NOCSR

INVALID_NODE_OP_ID = 2: The Node Operational ID in the NOC is not formatted correctly.

INVALID_NOC = 3: Any other validation error in NOC chain

MISSING_CSR = 4: No record of prior CSR for which this NOC could match

TABLE_FULL = 5: NOCs table full, cannot add another one

INVALID_ADMIN_SUBJECT = 6: Invalid CaseAdminSubject field for an AddNOC command.

FABRIC_CONFLICT = 9: Trying to AddNOC instead of UpdateNOC against an existing Fabric.

LABEL_CONFLICT = 10: Label already exists on another Fabric.

INVALID_FABRIC_INDEX = 11: FabricIndex argument is invalid.

circuitmatter.clusters.device_management.node_operational_credentials.RESP_MAX = 900

class circuitmatter.clusters.device_management.node_operational_credentials.NodeOperationalCredentialsCluster

Bases: circuitmatter.data_model.Cluster

CLUSTER_ID = 62

class NOCStruct

Bases: circuitmatter.tlv.Structure

NOC

ICAC

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

Bases: circuitmatter.tlv.Structure

RootPublicKey

VendorID

FabricID

NodeID

Label

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

Bases: circuitmatter.tlv.Structure

AttestationNonce

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

Bases: circuitmatter.tlv.Structure

AttestationElements

AttestationSignature

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

Bases: circuitmatter.tlv.Structure

CertificateType

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

Bases: circuitmatter.tlv.Structure

Certificate

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

Bases: circuitmatter.tlv.Structure

CSRNonce

IsForUpdateNOC

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

Bases: circuitmatter.tlv.Structure

NOCSRElements

AttestationSignature

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

Bases: circuitmatter.tlv.Structure

NOCValue

ICACValue

IPKValue

CaseAdminSubject

AdminVendorId

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

Bases: circuitmatter.tlv.Structure

NOCValue

ICACValue

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

Bases: circuitmatter.tlv.Structure

StatusCode

FabricIndex

DebugText

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

Bases: circuitmatter.tlv.Structure

Label

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

Bases: circuitmatter.tlv.Structure

FabricIndex

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

Bases: circuitmatter.tlv.Structure

RootCACertificate

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

nocs

fabrics

supported_fabrics

commissioned_fabrics

trusted_root_certificates

current_fabric_index

attestation_request

certificate_chain_request

csr_request

add_noc

update_noc

update_fabric_label

remove_fabric

add_trusted_root_certificate

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