OnOff¶

Attributes¶

class st.matter.generated.zap_clusters.OnOff.server.attributes.OnOff¶

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

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

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

new_value(...)¶

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

This is also usable with the OnOff(…) syntax

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

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: OnOff => 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 OnOff 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.OnOff.server.attributes.GlobalSceneControl¶

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

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

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

new_value(...)¶

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

This is also usable with the GlobalSceneControl(…) syntax

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

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: GlobalSceneControl => 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 GlobalSceneControl 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.OnOff.server.attributes.OnTime¶

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

NAME: str¶: “OnTime” 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 OnTime(…) 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

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.Uint16) – the value to write

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: OnTime => 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 OnTime 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.OnOff.server.attributes.OffWaitTime¶

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

NAME: str¶: “OffWaitTime” 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 OffWaitTime(…) 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

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.Uint16) – the value to write

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: OffWaitTime => 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 OffWaitTime 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.OnOff.server.attributes.StartUpOnOff¶

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

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

data_type: st.matter.generated.zap_clusters.OnOff.types.StartUpOnOffEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the StartUpOnOff(…) syntax

Parameters:: vararg (vararg) – the values needed to construct a StartUpOnOffEnum
Return type:: st.matter.generated.zap_clusters.OnOff.types.StartUpOnOffEnum

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.generated.zap_clusters.OnOff.types.StartUpOnOffEnum) – the value to write

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Reporting policy: StartUpOnOff => 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 StartUpOnOff 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.OnOff.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.OnOff.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.OnOff.server.commands.Off: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an Off 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)¶

Initialize the Off command

Parameters:: device (st.matter.Device) – the device to build this message to
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)

class st.matter.generated.zap_clusters.OnOff.server.commands.On: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an On 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)¶

Initialize the On command

Parameters:: device (st.matter.Device) – the device to build this message to
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)

class st.matter.generated.zap_clusters.OnOff.server.commands.Toggle: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an Toggle 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)¶

Initialize the Toggle command

Parameters:: device (st.matter.Device) – the device to build this message to
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)

class st.matter.generated.zap_clusters.OnOff.server.commands.OffWithEffect: st.matter.data_types.Structure ¶

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

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

effect_identifier: st.matter.generated.zap_clusters.OnOff.types.EffectIdentifierEnum¶

effect_variant: st.matter.data_types.Uint8¶

build_test_command_response(device, endpoint_id, status)¶

Builds an OffWithEffect 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, effect_identifier, effect_variant)¶

Initialize the OffWithEffect command

Parameters:

device (st.matter.Device) – the device to build this message to
effect_identifier (st.matter.generated.zap_clusters.OnOff.types.EffectIdentifierEnum)
effect_variant (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)

class st.matter.generated.zap_clusters.OnOff.server.commands.OnWithRecallGlobalScene: st.matter.data_types.Structure ¶

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

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

build_test_command_response(device, endpoint_id, status)¶

Builds an OnWithRecallGlobalScene 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)¶

Initialize the OnWithRecallGlobalScene command

Parameters:: device (st.matter.Device) – the device to build this message to
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)

class st.matter.generated.zap_clusters.OnOff.server.commands.OnWithTimedOff: st.matter.data_types.Structure ¶

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

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

on_off_control: st.matter.generated.zap_clusters.OnOff.types.OnOffControlBitmap¶

on_time: st.matter.data_types.Uint16¶

off_wait_time: st.matter.data_types.Uint16¶

build_test_command_response(device, endpoint_id, status)¶

Builds an OnWithTimedOff 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, on_off_control, on_time, off_wait_time)¶

Initialize the OnWithTimedOff command

Parameters:

device (st.matter.Device) – the device to build this message to
on_off_control (st.matter.generated.zap_clusters.OnOff.types.OnOffControlBitmap)
on_time (st.matter.data_types.Uint16)
off_wait_time (st.matter.data_types.Uint16)

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.OnOff.types.Feature¶

LIGHTING: number¶: 1

DEAD_FRONT_BEHAVIOR: number¶: 2

OFF_ONLY: number¶: 4

is_lighting_set()¶

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

set_lighting()¶: Set the value of the bit in the LIGHTING field to 1

unset_lighting()¶: Set the value of the bits in the LIGHTING field to 0

is_dead_front_behavior_set()¶

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

set_dead_front_behavior()¶: Set the value of the bit in the DEAD_FRONT_BEHAVIOR field to 1

unset_dead_front_behavior()¶: Set the value of the bits in the DEAD_FRONT_BEHAVIOR field to 0

is_off_only_set()¶

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

set_off_only()¶: Set the value of the bit in the OFF_ONLY field to 1

unset_off_only()¶: Set the value of the bits in the OFF_ONLY field to 0

class st.matter.generated.zap_clusters.OnOff.types.OnOffControlBitmap¶

ACCEPT_ONLY_WHEN_ON: number¶: 1

is_accept_only_when_on_set()¶

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

set_accept_only_when_on()¶: Set the value of the bit in the ACCEPT_ONLY_WHEN_ON field to 1

unset_accept_only_when_on()¶: Set the value of the bits in the ACCEPT_ONLY_WHEN_ON field to 0

Enum types¶

class st.matter.generated.zap_clusters.OnOff.types.DelayedAllOffEffectVariantEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

DELAYED_OFF_FAST_FADE: number¶: 0

NO_FADE: number¶: 1

DELAYED_OFF_SLOW_FADE: number¶: 2

class st.matter.generated.zap_clusters.OnOff.types.DyingLightEffectVariantEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

DYING_LIGHT_FADE_OFF: number¶: 0

class st.matter.generated.zap_clusters.OnOff.types.EffectIdentifierEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

DELAYED_ALL_OFF: number¶: 0

DYING_LIGHT: number¶: 1

class st.matter.generated.zap_clusters.OnOff.types.StartUpOnOffEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

OFF: number¶: 0

ON: number¶: 1

TOGGLE: number¶: 2