LaundryWasherControls
Attributes
- class st.matter.clusters.LaundryWasherControls.SpinSpeeds
- ID: number
0x0000 the ID of this attribute
- NAME: str
“SpinSpeeds” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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 SpinSpeeds(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Array- Return type
- 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
- subscribe(device, endpoint_id)
Reporting policy: SpinSpeeds => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an SpinSpeeds test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.LaundryWasherControls.SpinSpeedCurrent
- ID: number
0x0001 the ID of this attribute
- NAME: str
“SpinSpeedCurrent” 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 SpinSpeedCurrent(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Uint8- Return type
- 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
- 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
- subscribe(device, endpoint_id)
Reporting policy: SpinSpeedCurrent => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an SpinSpeedCurrent test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.LaundryWasherControls.NumberOfRinses
- ID: number
0x0002 the ID of this attribute
- NAME: str
“NumberOfRinses” the name of this attribute
- data_type: st.matter.generated.zap_clusters.LaundryWasherControls.types.NumberOfRinsesEnum
the data type of this attribute
- new_value(...)
Create a NumberOfRinsesEnum object of this attribute with any additional features provided for the attribute
This is also usable with the NumberOfRinses(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a NumberOfRinsesEnum- Return type
st.matter.generated.zap_clusters.LaundryWasherControls.types.NumberOfRinsesEnum
- 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
- 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.LaundryWasherControls.types.NumberOfRinsesEnum
) – the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: NumberOfRinses => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an NumberOfRinses test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.LaundryWasherControls.SupportedRinses
- ID: number
0x0003 the ID of this attribute
- NAME: str
“SupportedRinses” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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 SupportedRinses(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Array- Return type
- 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
- subscribe(device, endpoint_id)
Reporting policy: SupportedRinses => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an SupportedRinses test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.LaundryWasherControls.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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
- 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
- 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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 forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.LaundryWasherControls.EventList
- ID: number
0xFFFA the ID of this attribute
- NAME: str
“EventList” the name of this attribute
- data_type: st.matter.data_types.Array
the data type of this attribute
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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 EventList(…) syntax
- Parameters
vararg (
vararg
) – the values needed to construct a Array- Return type
- 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
- subscribe(device, endpoint_id)
Reporting policy: EventList => true => mandatory
Sets up a Subscribe Interaction
- Parameters
device (
any
) –endpoint_id (
number or nil
) –
- Return type
any
- set_parent_cluster(cluster)
- Parameters
cluster (
any
) –
- build_test_report_data(device, endpoint_id, value, status)
Builds an EventList test attribute reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device
) – the device to build this message forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
- class st.matter.clusters.LaundryWasherControls.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(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_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
- 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
- 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
- set_parent_cluster(cluster)
- Parameters
cluster (
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 forendpoint_id (
number or nil
) –value (
any
) –status (
str
) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any
) –
Bitmap types
- class st.matter.clusters.LaundryWasherControls.types.Feature
- SPIN: number
1
- RINSE: number
2
- is_spin_set()
- Returns
True if the value of SPIN is non-zero
- Return type
boolean
- set_spin()
Set the value of the bit in the SPIN field to 1
- unset_spin()
Set the value of the bits in the SPIN field to 0
- is_rinse_set()
- Returns
True if the value of RINSE is non-zero
- Return type
boolean
- set_rinse()
Set the value of the bit in the RINSE field to 1
- unset_rinse()
Set the value of the bits in the RINSE field to 0