circuitmatter.protocol
======================

.. py:module:: circuitmatter.protocol


Classes
-------

.. autoapisummary::

   circuitmatter.protocol.SecureProtocolOpcode
   circuitmatter.protocol.InteractionModelOpcode
   circuitmatter.protocol.ProtocolId


Module Contents
---------------

.. py:class:: SecureProtocolOpcode

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints


   .. py:attribute:: MSG_COUNTER_SYNC_REQ
      :value: 0


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


   .. py:attribute:: MSG_COUNTER_SYNC_RSP
      :value: 1


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


   .. py:attribute:: MRP_STANDALONE_ACK
      :value: 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.


   .. py:attribute:: PBKDF_PARAM_REQUEST
      :value: 32


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


   .. py:attribute:: PBKDF_PARAM_RESPONSE
      :value: 33


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


   .. py:attribute:: PASE_PAKE1
      :value: 34


      The first PAKE message of the PASE protocol.


   .. py:attribute:: PASE_PAKE2
      :value: 35


      The second PAKE message of the PASE protocol.


   .. py:attribute:: PASE_PAKE3
      :value: 36


      The third PAKE message of the PASE protocol.


   .. py:attribute:: CASE_SIGMA1
      :value: 48


      The first message of the CASE protocol.


   .. py:attribute:: CASE_SIGMA2
      :value: 49


      The second message of the CASE protocol.


   .. py:attribute:: CASE_SIGMA3
      :value: 50


      The third message of the CASE protocol.


   .. py:attribute:: CASE_SIGMA2_RESUME
      :value: 51


      The second resumption message of the CASE protocol.


   .. py:attribute:: STATUS_REPORT
      :value: 64


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


   .. py:attribute:: ICD_CHECK_IN
      :value: 80


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


.. py:class:: InteractionModelOpcode

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints


   .. py:attribute:: STATUS_RESPONSE
      :value: 1



   .. py:attribute:: READ_REQUEST
      :value: 2



   .. py:attribute:: SUBSCRIBE_REQUEST
      :value: 3



   .. py:attribute:: SUBSCRIBE_RESPONSE
      :value: 4



   .. py:attribute:: REPORT_DATA
      :value: 5



   .. py:attribute:: WRITE_REQUEST
      :value: 6



   .. py:attribute:: WRITE_RESPONSE
      :value: 7



   .. py:attribute:: INVOKE_REQUEST
      :value: 8



   .. py:attribute:: INVOKE_RESPONSE
      :value: 9



   .. py:attribute:: TIMED_REQUEST
      :value: 10



.. py:class:: ProtocolId

   Bases: :py:obj:`enum.IntEnum`


   Enum where members are also (and must be) ints


   .. py:attribute:: SECURE_CHANNEL
      :value: 0



   .. py:attribute:: INTERACTION_MODEL
      :value: 1



   .. py:attribute:: BDX
      :value: 2



   .. py:attribute:: USER_DIRECTED_COMMISSIONING
      :value: 3



   .. py:attribute:: FOR_TESTING
      :value: 4



   .. py:method:: ProtocolOpcode(opcode_id: int)