circuitmatter.clusters.system_model.access_control
==================================================

.. py:module:: circuitmatter.clusters.system_model.access_control


Classes
-------

.. autoapisummary::

   circuitmatter.clusters.system_model.access_control.AccessControlEntryPrivilegeEnum
   circuitmatter.clusters.system_model.access_control.AccessControlEntryAuthModeEnum
   circuitmatter.clusters.system_model.access_control.AccessControlTargetStruct
   circuitmatter.clusters.system_model.access_control.AccessControlCluster


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

.. py:class:: AccessControlEntryPrivilegeEnum

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


   Enum where members are also (and must be) ints


   .. py:attribute:: VIEW
      :value: 1


      Can read and observe all (except Access Control Cluster and as seen by a non-Proxy)


   .. py:attribute:: PROXY_VIEW
      :value: 2


      Can read and observe all (as seen by a Proxy)


   .. py:attribute:: OPERATE
      :value: 3


      View privileges, and can perform the primary function of this Node (except Access Control
      Cluster)


   .. py:attribute:: MANAGE
      :value: 4


      Operate privileges, and can modify persistent configuration of this Node (except Access
      Control Cluster)


   .. py:attribute:: ADMINISTER
      :value: 5


      Manage privileges, and can observe and modify the Access Control Cluster


.. py:class:: AccessControlEntryAuthModeEnum

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


   Enum where members are also (and must be) ints


   .. py:attribute:: PASE
      :value: 1


      Passcode authenticated session


   .. py:attribute:: CASE
      :value: 2


      Certificate authenticated session


   .. py:attribute:: GROUP
      :value: 3


      Group authenticated session


.. py:class:: AccessControlTargetStruct

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


   .. py:attribute:: Cluster


   .. py:attribute:: Endpoint


   .. py:attribute:: DeviceType


   .. 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:: AccessControlCluster

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


   .. py:attribute:: CLUSTER_ID
      :value: 31



   .. py:class:: AccessControlEntryStruct

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


      .. py:attribute:: Privilege


      .. py:attribute:: AuthMode


      .. py:attribute:: Subjects


      .. py:attribute:: Targets


      .. 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:: AccessControlExtensionStruct

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


      .. py:attribute:: Data


      .. 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:: ACL


   .. py:attribute:: Extension


   .. py:attribute:: SubjectsPerAccessControlEntry


   .. py:attribute:: TargetsPerAccessControlEntry


   .. py:attribute:: AccessControlEntriesPerFabric


   .. 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