circuitmatter.data_model ======================== .. py:module:: circuitmatter.data_model Attributes ---------- .. autoapisummary:: circuitmatter.data_model.ATTRIBUTES_KEY Classes ------- .. autoapisummary:: circuitmatter.data_model.Enum8 circuitmatter.data_model.Enum16 circuitmatter.data_model.Map8 circuitmatter.data_model.Map16 circuitmatter.data_model.Uint16 circuitmatter.data_model.Uint32 circuitmatter.data_model.Uint64 circuitmatter.data_model.NodeId circuitmatter.data_model.GroupId circuitmatter.data_model.ClusterId circuitmatter.data_model.AttributeId circuitmatter.data_model.EventId circuitmatter.data_model.CommandId circuitmatter.data_model.DeviceTypeId circuitmatter.data_model.EndpointNumber circuitmatter.data_model.List circuitmatter.data_model.Attribute circuitmatter.data_model.NumberAttribute circuitmatter.data_model.EnumAttribute circuitmatter.data_model.ListAttribute circuitmatter.data_model.BoolAttribute circuitmatter.data_model.StructAttribute circuitmatter.data_model.OctetStringAttribute circuitmatter.data_model.UTF8StringAttribute circuitmatter.data_model.BitmapAttribute circuitmatter.data_model.Command circuitmatter.data_model.Cluster Module Contents --------------- .. py:data:: ATTRIBUTES_KEY :value: 'a' .. py:class:: Enum8 Bases: :py:obj:`enum.IntEnum` Enum where members are also (and must be) ints .. py:class:: Enum16 Bases: :py:obj:`enum.IntEnum` Enum where members are also (and must be) ints .. py:class:: Map8 Bases: :py:obj:`enum.IntFlag` Support for integer-based Flags .. py:class:: Map16 Bases: :py:obj:`enum.IntFlag` Support for integer-based Flags .. py:class:: Uint16(_id=None, minimum=0, **kwargs) Bases: :py:obj:`circuitmatter.tlv.IntMember` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: Uint32(_id=None, minimum=0, **kwargs) Bases: :py:obj:`circuitmatter.tlv.IntMember` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: Uint64(_id=None, minimum=0, **kwargs) Bases: :py:obj:`circuitmatter.tlv.IntMember` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: NodeId(_id=None, minimum=0, **kwargs) Bases: :py:obj:`Uint64` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: GroupId(_id=None, **kwargs) Bases: :py:obj:`Uint16` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: ClusterId(_id=None, minimum=0, **kwargs) Bases: :py:obj:`Uint16` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: AttributeId(_id=None, minimum=0, **kwargs) Bases: :py:obj:`Uint16` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: EventId(_id=None, minimum=0, **kwargs) Bases: :py:obj:`Uint16` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: CommandId(_id=None, minimum=0, **kwargs) Bases: :py:obj:`Uint16` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: DeviceTypeId(_id=None, minimum=0, **kwargs) Bases: :py:obj:`Uint32` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: EndpointNumber(_id=None, **kwargs) Bases: :py:obj:`Uint16` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: uformat .. py:attribute:: format .. py:attribute:: integer .. py:attribute:: signed .. py:attribute:: max_value_length .. py:method:: __set__(obj, value) .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[_NT, int] :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer, offset) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: List(tag, substruct_class: type[_TLVStruct, Member], *, max_length: int | None = None, optional: _OPT = False, nullable: _NULLABLE = False, **kwargs) Bases: :py:obj:`circuitmatter.tlv.ArrayMember` Helper class that provides a standard way to create an ABC using inheritance. .. py:attribute:: substruct_class .. py:attribute:: max_value_length :value: 1280 .. py:attribute:: max_items .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) :staticmethod: Return the decoded value at ``offset`` in ``buffer``. ``offset`` is after the tag (but before any length) .. py:method:: print(value) Return string representation of ``value`` .. py:method:: encode_element_type(value) Return Element Type Field as defined in Appendix A in the spec .. py:method:: encode_value_into(value, buffer: memoryview, offset: int) -> int Encode ``value`` into ``buffer`` and return the new offset .. py:attribute:: tag .. py:attribute:: optional .. py:attribute:: nullable .. py:attribute:: tag_length :value: 0 .. py:method:: __set_name__(owner, name) .. py:property:: max_length .. py:method:: __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T | None __get__(obj: Structure, objtype: type[Structure] | None = None) -> _T .. py:method:: __set__(obj: Structure, value: _T | None) -> None __set__(obj: Structure, value: _T) -> None .. py:method:: __delete__(obj) .. py:method:: encode(value) .. py:method:: encode_into(obj: Container, buffer: bytearray | memoryview, offset: int, anonymous_ok=False) -> int .. py:method:: decode(buffer: memoryview, offset: int = 0) -> _T Return the decoded value at ``offset`` in ``buffer`` .. py:method:: from_value(value) .. py:attribute:: __slots__ :value: () .. py:class:: Attribute(_id, default=None, optional=False, feature=0, C_changes_omitted=False, F_fixed=False, N_nonvolatile=False, P_reportable=False, Q_quieter_reporting=False, S_scene=False, X_nullable=False) .. py:attribute:: id .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:method:: encode(value) -> bytes .. py:class:: NumberAttribute(_id, *, signed, bits, **kwargs) Bases: :py:obj:`Attribute` .. py:attribute:: signed .. py:attribute:: bits .. py:attribute:: id .. py:method:: encode_number(value, *, signed=True) -> bytes :staticmethod: .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:method:: encode(value) -> bytes .. py:class:: EnumAttribute(_id, enum_type, **kwargs) Bases: :py:obj:`NumberAttribute` .. py:attribute:: enum_type .. py:attribute:: bits .. py:attribute:: signed .. py:attribute:: id .. py:method:: encode_number(value, *, signed=True) -> bytes :staticmethod: .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:method:: encode(value) -> bytes .. py:class:: ListAttribute(_id, element_type, **kwargs) Bases: :py:obj:`Attribute` .. py:attribute:: tlv_type .. py:method:: __get__(instance, cls) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:method:: element_from_value(value) .. py:attribute:: id .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __set__(instance, value) .. py:method:: encode(value) -> bytes .. py:class:: BoolAttribute(_id, default=None, optional=False, feature=0, C_changes_omitted=False, F_fixed=False, N_nonvolatile=False, P_reportable=False, Q_quieter_reporting=False, S_scene=False, X_nullable=False) Bases: :py:obj:`Attribute` .. py:method:: encode(value) -> bytes .. py:attribute:: id .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:class:: StructAttribute(_id, struct_type, default=None) Bases: :py:obj:`Attribute` .. py:attribute:: struct_type .. py:method:: encode(value) -> memoryview .. py:attribute:: id .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:class:: OctetStringAttribute(_id, min_length, max_length, **kwargs) Bases: :py:obj:`Attribute` .. py:attribute:: min_length .. py:attribute:: max_length .. py:attribute:: member .. py:method:: encode(value) .. py:attribute:: id .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:class:: UTF8StringAttribute(_id, min_length=0, max_length=1200, **kwargs) Bases: :py:obj:`Attribute` .. py:attribute:: min_length .. py:attribute:: max_length .. py:attribute:: member .. py:method:: encode(value) .. py:attribute:: id .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:class:: BitmapAttribute(_id, enum_type, **kwargs) Bases: :py:obj:`NumberAttribute` .. py:attribute:: enum_type .. py:attribute:: bits .. py:attribute:: signed .. py:attribute:: id .. py:method:: encode_number(value, *, signed=True) -> bytes :staticmethod: .. py:attribute:: default .. py:attribute:: optional .. py:attribute:: feature .. py:attribute:: nullable .. py:attribute:: nonvolatile .. py:attribute:: omit_changes .. py:method:: __get__(instance, cls) .. py:method:: __set__(instance, value) .. py:method:: to_json(value) .. py:method:: from_json(value) .. py:method:: encode(value) -> bytes .. py:class:: Command(command_id, request_type, response_id=None, response_type=interaction_model.StatusCode) .. py:attribute:: command_id .. py:attribute:: request_type .. py:attribute:: response_id .. py:attribute:: response_type .. py:class:: Cluster .. 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