Identify¶

Attributes¶

class st.matter.generated.zap_clusters.Identify.server.attributes.IdentifyTime¶

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

NAME: str¶: “IdentifyTime” 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 IdentifyTime(…) 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: IdentifyTime => 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 IdentifyTime 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.Identify.server.attributes.IdentifyType¶

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

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

data_type: st.matter.generated.zap_clusters.Identify.types.IdentifyTypeEnum¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the IdentifyType(…) syntax

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

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: IdentifyType => 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 IdentifyType 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.Identify.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.Identify.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.Identify.server.commands.Identify: st.matter.data_types.Structure ¶

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

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

identify_time: st.matter.data_types.Uint16¶

build_test_command_response(device, endpoint_id, status)¶

Builds an Identify 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, identify_time)¶

Initialize the Identify command

Parameters:

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

class st.matter.generated.zap_clusters.Identify.server.commands.TriggerEffect: st.matter.data_types.Structure ¶

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

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

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

effect_variant: st.matter.generated.zap_clusters.Identify.types.EffectVariantEnum¶

build_test_command_response(device, endpoint_id, status)¶

Builds an TriggerEffect 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 TriggerEffect command

Parameters:

device (st.matter.Device) – the device to build this message to
effect_identifier (st.matter.generated.zap_clusters.Identify.types.EffectIdentifierEnum)
effect_variant (st.matter.generated.zap_clusters.Identify.types.EffectVariantEnum)

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)

Enum types¶

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

byte_length: number¶: 1

BLINK: number¶: 0

BREATHE: number¶: 1

OKAY: number¶: 2

CHANNEL_CHANGE: number¶: 11

FINISH_EFFECT: number¶: 254

STOP_EFFECT: number¶: 255

class st.matter.generated.zap_clusters.Identify.types.EffectVariantEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

DEFAULT: number¶: 0

class st.matter.generated.zap_clusters.Identify.types.IdentifyTypeEnum: st.matter.data_types.Uint8 ¶

byte_length: number¶: 1

NONE: number¶: 0

LIGHT_OUTPUT: number¶: 1

VISIBLE_INDICATOR: number¶: 2

AUDIBLE_BEEP: number¶: 3

DISPLAY: number¶: 4

ACTUATOR: number¶: 5