circuitmatter.protocol

Classes

SecureProtocolOpcode

Enum where members are also (and must be) ints

InteractionModelOpcode

Enum where members are also (and must be) ints

ProtocolId

Enum where members are also (and must be) ints

Module Contents

class circuitmatter.protocol.SecureProtocolOpcode

Bases: enum.IntEnum

Enum where members are also (and must be) ints

MSG_COUNTER_SYNC_REQ = 0

The Message Counter Synchronization Request message queries the current message counter from a peer to bootstrap replay protection.

MSG_COUNTER_SYNC_RSP = 1

The Message Counter Synchronization Response message provides the current message counter from a peer to bootstrap replay protection.

MRP_STANDALONE_ACK = 16

This message is dedicated for the purpose of sending a stand-alone acknowledgement when there is no other data message available to piggyback an acknowledgement on top of.

PBKDF_PARAM_REQUEST = 32

The request for PBKDF parameters necessary to complete the PASE protocol.

PBKDF_PARAM_RESPONSE = 33

The PBKDF parameters sent in response to PBKDF-ParamRequest during the PASE protocol.

PASE_PAKE1 = 34

The first PAKE message of the PASE protocol.

PASE_PAKE2 = 35

The second PAKE message of the PASE protocol.

PASE_PAKE3 = 36

The third PAKE message of the PASE protocol.

CASE_SIGMA1 = 48

The first message of the CASE protocol.

CASE_SIGMA2 = 49

The second message of the CASE protocol.

CASE_SIGMA3 = 50

The third message of the CASE protocol.

CASE_SIGMA2_RESUME = 51

The second resumption message of the CASE protocol.

STATUS_REPORT = 64

The Status Report message encodes the result of an operation in the Secure Channel as well as other protocols.

ICD_CHECK_IN = 80

The Check-in message notifies a client that the ICD is available for communication.

class circuitmatter.protocol.InteractionModelOpcode

Bases: enum.IntEnum

Enum where members are also (and must be) ints

STATUS_RESPONSE = 1
READ_REQUEST = 2
SUBSCRIBE_REQUEST = 3
SUBSCRIBE_RESPONSE = 4
REPORT_DATA = 5
WRITE_REQUEST = 6
WRITE_RESPONSE = 7
INVOKE_REQUEST = 8
INVOKE_RESPONSE = 9
TIMED_REQUEST = 10
class circuitmatter.protocol.ProtocolId

Bases: enum.IntEnum

Enum where members are also (and must be) ints

SECURE_CHANNEL = 0
INTERACTION_MODEL = 1
BDX = 2
USER_DIRECTED_COMMISSIONING = 3
FOR_TESTING = 4
ProtocolOpcode(opcode_id: int)