Chime

Attributes

class st.matter.generated.zap_clusters.Chime.server.attributes.InstalledChimeSounds

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

NAME: str: “InstalledChimeSounds” 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 InstalledChimeSounds(…) 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: InstalledChimeSounds => 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 InstalledChimeSounds 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.Chime.server.attributes.SelectedChime

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

NAME: str: “SelectedChime” 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 SelectedChime(…) 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: SelectedChime => 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 SelectedChime 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.Chime.server.attributes.Enabled

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

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

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

Return type

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: Enabled => 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 Enabled 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.Chime.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.Chime.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.Chime.server.commands.PlayChimeSound: st.matter.data_types.Structure 

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

NAME: str: “PlayChimeSound” the name of this command

build_test_command_response(device, endpoint_id, status)

Builds an PlayChimeSound 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 PlayChimeSound 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) –

Struct types

class st.matter.generated.zap_clusters.Chime.types.ChimeSoundStruct: st.matter.data_types.Structure 

chime_id: st.matter.data_types.Uint8

name: st.matter.data_types.UTF8String1