circuitmatter.clusters.device_management.general_commissioning
==============================================================

.. py:module:: circuitmatter.clusters.device_management.general_commissioning


Classes
-------

.. autoapisummary::

   circuitmatter.clusters.device_management.general_commissioning.CommissioningErrorEnum
   circuitmatter.clusters.device_management.general_commissioning.RegulatoryLocationType
   circuitmatter.clusters.device_management.general_commissioning.GeneralCommissioningCluster


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

.. py:class:: CommissioningErrorEnum

   Bases: :py:obj:`circuitmatter.data_model.Enum8`


   Enum where members are also (and must be) ints


   .. py:attribute:: OK
      :value: 0



   .. py:attribute:: VALUE_OUTSIDE_RANGE
      :value: 1



   .. py:attribute:: INVALID_AUTHENTICATION
      :value: 2



   .. py:attribute:: NO_FAIL_SAFE
      :value: 3



   .. py:attribute:: BUSY_WITH_OTHER_ADMIN
      :value: 4



.. py:class:: RegulatoryLocationType

   Bases: :py:obj:`circuitmatter.data_model.Enum8`


   Enum where members are also (and must be) ints


   .. py:attribute:: INDOOR
      :value: 0



   .. py:attribute:: OUTDOOR
      :value: 1



   .. py:attribute:: INDOOR_OUTDOOR
      :value: 2



.. py:class:: GeneralCommissioningCluster

   Bases: :py:obj:`circuitmatter.data_model.Cluster`


   .. py:attribute:: CLUSTER_ID
      :value: 48



   .. py:class:: BasicCommissioningInfo

      Bases: :py:obj:`circuitmatter.tlv.Structure`


      .. py:attribute:: FailSafeExpiryLengthSeconds


      .. py:attribute:: MaxCumulativeFailsafeSeconds


      .. py:method:: __str__()


      .. py:method:: encode() -> memoryview


      .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


      .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
         :classmethod:



      .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
         :classmethod:



      .. py:method:: construct_containers()


      .. py:method:: from_value(value)
         :classmethod:



      .. py:attribute:: values


      .. py:method:: max_length()
         :classmethod:



      .. py:method:: set_value(tag, value)


      .. py:method:: delete_value(tag)



   .. py:attribute:: breadcrumb


   .. py:attribute:: basic_commissioning_info


   .. py:attribute:: regulatory_config


   .. py:attribute:: location_capability


   .. py:attribute:: support_concurrent_connection


   .. py:class:: ArmFailSafe

      Bases: :py:obj:`circuitmatter.tlv.Structure`


      .. py:attribute:: ExpiryLengthSeconds


      .. py:attribute:: Breadcrumb


      .. py:method:: __str__()


      .. py:method:: encode() -> memoryview


      .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


      .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
         :classmethod:



      .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
         :classmethod:



      .. py:method:: construct_containers()


      .. py:method:: from_value(value)
         :classmethod:



      .. py:attribute:: values


      .. py:method:: max_length()
         :classmethod:



      .. py:method:: set_value(tag, value)


      .. py:method:: delete_value(tag)



   .. py:class:: CommissioningResponse

      Bases: :py:obj:`circuitmatter.tlv.Structure`


      .. py:attribute:: ErrorCode


      .. py:attribute:: DebugText


      .. py:method:: __str__()


      .. py:method:: encode() -> memoryview


      .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


      .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
         :classmethod:



      .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
         :classmethod:



      .. py:method:: construct_containers()


      .. py:method:: from_value(value)
         :classmethod:



      .. py:attribute:: values


      .. py:method:: max_length()
         :classmethod:



      .. py:method:: set_value(tag, value)


      .. py:method:: delete_value(tag)



   .. py:attribute:: ArmFailSafeResponse


   .. py:attribute:: arm_fail_safe


   .. py:class:: SetRegulatoryConfig

      Bases: :py:obj:`circuitmatter.tlv.Structure`


      .. py:attribute:: NewRegulatoryConfig


      .. py:attribute:: CountryCode


      .. py:attribute:: Breadcrumb


      .. py:method:: __str__()


      .. py:method:: encode() -> memoryview


      .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


      .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
         :classmethod:



      .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
         :classmethod:



      .. py:method:: construct_containers()


      .. py:method:: from_value(value)
         :classmethod:



      .. py:attribute:: values


      .. py:method:: max_length()
         :classmethod:



      .. py:method:: set_value(tag, value)


      .. py:method:: delete_value(tag)



   .. py:attribute:: SetRegulatoryConfigResponse


   .. py:attribute:: set_regulatory_config


   .. py:attribute:: CommissioningCompleteResponse


   .. py:attribute:: commissioning_complete


   .. py:attribute:: cluster_revision


   .. py:attribute:: feature_map


   .. py:attribute:: attribute_list


   .. py:attribute:: event_list


   .. py:attribute:: accepted_command_list


   .. py:attribute:: generated_command_list


   .. py:attribute:: data_version


   .. py:method:: __contains__(descriptor_id)


   .. py:method:: restore(nonvolatile)


   .. py:method:: get_attribute_data(session, path, subscription=None) -> list[circuitmatter.interaction_model.AttributeDataIB]


   .. py:method:: set_attribute(context, attribute_data) -> circuitmatter.interaction_model.AttributeStatusIB


   .. py:method:: invoke(session, path, fields) -> circuitmatter.interaction_model.CommandDataIB | circuitmatter.interaction_model.StatusCode | None