circuitmatter.clusters.general.on_off
=====================================

.. py:module:: circuitmatter.clusters.general.on_off


Classes
-------

.. autoapisummary::

   circuitmatter.clusters.general.on_off.FeatureBitmap
   circuitmatter.clusters.general.on_off.StartUpOnOffEnum
   circuitmatter.clusters.general.on_off.OnOff


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

.. py:class:: FeatureBitmap

   Bases: :py:obj:`enum.IntFlag`


   Support for integer-based Flags


   .. py:attribute:: LIGHTING


   .. py:attribute:: DEAD_FRONT_BEHAVIOR


   .. py:attribute:: OFF_ONLY


.. py:class:: StartUpOnOffEnum

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


   Enum where members are also (and must be) ints


   .. py:attribute:: OFF
      :value: 0



   .. py:attribute:: ON
      :value: 1



   .. py:attribute:: TOGGLE
      :value: 2



.. py:class:: OnOff

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


   .. py:attribute:: CLUSTER_ID
      :value: 6



   .. py:attribute:: OnOff


   .. py:attribute:: GlobalSceneControl


   .. py:attribute:: OnTime


   .. py:attribute:: OffWaitTime


   .. py:attribute:: StartUpOnOff


   .. py:attribute:: off


   .. py:attribute:: on


   .. py:attribute:: toggle


   .. py:class:: OffWithEffect

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


      .. py:attribute:: EffectIdentifier


      .. py:attribute:: EffectVariant


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


   .. py:attribute:: on_with_recall_global_scene


   .. py:attribute:: on_with_timed_off


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