ModeSelect¶

Attributes¶

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.Description¶

ID: number¶: 0x0000 the ID of this attribute

NAME: str¶: “Description” the name of this attribute

data_type: st.matter.data_types.UTF8String1¶: the data type of this attribute

new_value(...)¶

Create a UTF8String1 object of this attribute with any additional features provided for the attribute

This is also usable with the Description(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a UTF8String1
Return type:: st.matter.data_types.UTF8String1

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: Description => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an Description test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.StandardNamespace¶

ID: number¶: 0x0001 the ID of this attribute

NAME: str¶: “StandardNamespace” the name of this attribute

data_type: st.matter.data_types.Uint16¶: the data type of this attribute

new_value(...)¶

Create a Uint16 object of this attribute with any additional features provided for the attribute

This is also usable with the StandardNamespace(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Uint16
Return type:: st.matter.data_types.Uint16

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: StandardNamespace => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an StandardNamespace test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.SupportedModes¶

ID: number¶: 0x0002 the ID of this attribute

NAME: str¶: “SupportedModes” the name of this attribute

data_type: st.matter.data_types.Array¶: the data type of this attribute

augment_type(data_type_obj)¶

Add additional functionality to the base type object

Parameters:: data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)¶

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the SupportedModes(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Array
Return type:: st.matter.data_types.Array

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: SupportedModes => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an SupportedModes test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.CurrentMode¶

ID: number¶: 0x0003 the ID of this attribute

NAME: str¶: “CurrentMode” the name of this attribute

data_type: st.matter.data_types.Uint8¶: the data type of this attribute

new_value(...)¶

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the CurrentMode(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Uint8
Return type:: st.matter.data_types.Uint8

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: CurrentMode => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an CurrentMode test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.StartUpMode¶

ID: number¶: 0x0004 the ID of this attribute

NAME: str¶: “StartUpMode” the name of this attribute

data_type: st.matter.data_types.Uint8¶: the data type of this attribute

new_value(...)¶

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the StartUpMode(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Uint8
Return type:: st.matter.data_types.Uint8

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)¶

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)
value (st.matter.data_types.Uint8) – the value to write

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: StartUpMode => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an StartUpMode test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.OnMode¶

ID: number¶: 0x0005 the ID of this attribute

NAME: str¶: “OnMode” the name of this attribute

data_type: st.matter.data_types.Uint8¶: the data type of this attribute

new_value(...)¶

Create a Uint8 object of this attribute with any additional features provided for the attribute

This is also usable with the OnMode(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Uint8
Return type:: st.matter.data_types.Uint8

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)¶

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)
value (st.matter.data_types.Uint8) – the value to write

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: OnMode => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an OnMode test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.AcceptedCommandList¶

ID: number¶: 0xFFF9 the ID of this attribute

NAME: str¶: “AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array¶: the data type of this attribute

augment_type(data_type_obj)¶

Add additional functionality to the base type object

Parameters:: data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)¶

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AcceptedCommandList(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Array
Return type:: st.matter.data_types.Array

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

class st.matter.generated.zap_clusters.ModeSelect.server.attributes.AttributeList¶

ID: number¶: 0xFFFB the ID of this attribute

NAME: str¶: “AttributeList” the name of this attribute

data_type: st.matter.data_types.Array¶: the data type of this attribute

augment_type(data_type_obj)¶

Add additional functionality to the base type object

Parameters:: data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)¶

Create a Array object of this attribute with any additional features provided for the attribute

This is also usable with the AttributeList(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a Array
Return type:: st.matter.data_types.Array

read(device, endpoint_id)¶

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:

device (st.matter.Device)
endpoint_id (number or nil)

Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)¶

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
value (any)
status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Server Commands¶

class st.matter.generated.zap_clusters.ModeSelect.server.commands.ChangeToMode: st.matter.data_types.Structure ¶

ID: number¶: 0x0000 the ID of this command

NAME: str¶: “ChangeToMode” the name of this command

new_mode: st.matter.data_types.Uint8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an ChangeToMode test command reponse for the driver integration testing framework

Parameters:

device (st.matter.Device) – the device to build this message to
endpoint_id (number or nil)
status (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, new_mode)¶

Initialize the ChangeToMode command

Parameters:

device (st.matter.Device) – the device to build this message to
new_mode (st.matter.data_types.Uint8)

Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)¶

Add field names to each command field

Parameters:: base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)¶

Parameters:: tlv_buf (any)

Bitmap types¶

class st.matter.generated.zap_clusters.ModeSelect.types.Feature¶

ON_OFF: number¶: 1

is_on_off_set()¶

Returns:: True if the value of ON_OFF is non-zero
Return type:: boolean

set_on_off()¶: Set the value of the bit in the ON_OFF field to 1

unset_on_off()¶: Set the value of the bits in the ON_OFF field to 0

Struct types¶

class st.matter.generated.zap_clusters.ModeSelect.types.SemanticTagStruct: st.matter.data_types.Structure ¶

mfg_code: st.matter.data_types.Uint16¶

value: st.matter.data_types.Uint16¶

class st.matter.generated.zap_clusters.ModeSelect.types.ModeOptionStruct: st.matter.data_types.Structure ¶

label: st.matter.data_types.UTF8String1¶

mode: st.matter.data_types.Uint8¶

semantic_tags: st.matter.data_types.Array¶