DishwasherAlarm¶

Attributes¶

class st.matter.generated.zap_clusters.DishwasherAlarm.server.attributes.Mask¶

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

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

data_type: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the Mask(…) syntax

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

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: Mask => 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 Mask 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.DishwasherAlarm.server.attributes.Latch¶

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

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

data_type: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the Latch(…) syntax

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

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: Latch => 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 Latch 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.DishwasherAlarm.server.attributes.State¶

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

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

data_type: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the State(…) syntax

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

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: State => 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 State 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.DishwasherAlarm.server.attributes.Supported¶

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

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

data_type: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶: the data type of this attribute

new_value(...)¶

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

This is also usable with the Supported(…) syntax

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

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: Supported => 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 Supported 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.DishwasherAlarm.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.DishwasherAlarm.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.DishwasherAlarm.server.commands.Reset: st.matter.data_types.Structure ¶

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

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

alarms: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

build_test_command_response(device, endpoint_id, status)¶

Builds an Reset 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, alarms)¶

Initialize the Reset command

Parameters:

device (st.matter.Device) – the device to build this message to
alarms (st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap)

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.DishwasherAlarm.server.commands.ModifyEnabledAlarms: st.matter.data_types.Structure ¶

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

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

mask: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

build_test_command_response(device, endpoint_id, status)¶

Builds an ModifyEnabledAlarms 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, mask)¶

Initialize the ModifyEnabledAlarms command

Parameters:

device (st.matter.Device) – the device to build this message to
mask (st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap)

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)

Events¶

class st.matter.generated.zap_clusters.DishwasherAlarm.server.events.Notify: st.matter.data_types.Structure ¶

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

NAME: str¶: “Notify” the name of this event

active: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

inactive: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

state: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

mask: st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

augment_type(base_type_obj)¶

Add field names to each event field

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

read(device, endpoint_id)¶

Constructs a read InteractionRequest for the Event

Parameters:

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

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)¶

Constructs a subscribe InteractionRequest for the Event

Parameters:

device (any)
endpoint_id (number or nil)

Return type:

st.matter.interaction_model.InteractionRequest

build_test_event_report(device, endpoint_id, fields, status)¶

Builds an Notify test event report reponse to be used by

the driver integration testing framework.

Parameters:

device (st.matter.Device) – the device to build this message for
endpoint_id (number or nil)
fields (table) – containing the event fields
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)

Bitmap types¶

class st.matter.generated.zap_clusters.DishwasherAlarm.types.AlarmBitmap¶

INFLOW_ERROR: number¶: 1

DRAIN_ERROR: number¶: 2

DOOR_ERROR: number¶: 4

TEMP_TOO_LOW: number¶: 8

TEMP_TOO_HIGH: number¶: 16

WATER_LEVEL_ERROR: number¶: 32

is_inflow_error_set()¶

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

set_inflow_error()¶: Set the value of the bit in the INFLOW_ERROR field to 1

unset_inflow_error()¶: Set the value of the bits in the INFLOW_ERROR field to 0

is_drain_error_set()¶

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

set_drain_error()¶: Set the value of the bit in the DRAIN_ERROR field to 1

unset_drain_error()¶: Set the value of the bits in the DRAIN_ERROR field to 0

is_door_error_set()¶

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

set_door_error()¶: Set the value of the bit in the DOOR_ERROR field to 1

unset_door_error()¶: Set the value of the bits in the DOOR_ERROR field to 0

is_temp_too_low_set()¶

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

set_temp_too_low()¶: Set the value of the bit in the TEMP_TOO_LOW field to 1

unset_temp_too_low()¶: Set the value of the bits in the TEMP_TOO_LOW field to 0

is_temp_too_high_set()¶

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

set_temp_too_high()¶: Set the value of the bit in the TEMP_TOO_HIGH field to 1

unset_temp_too_high()¶: Set the value of the bits in the TEMP_TOO_HIGH field to 0

is_water_level_error_set()¶

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

set_water_level_error()¶: Set the value of the bit in the WATER_LEVEL_ERROR field to 1

unset_water_level_error()¶: Set the value of the bits in the WATER_LEVEL_ERROR field to 0

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

RESET: number¶: 1

is_reset_set()¶

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

set_reset()¶: Set the value of the bit in the RESET field to 1

unset_reset()¶: Set the value of the bits in the RESET field to 0