RvcOperationalState
Attributes
- class st.matter.clusters.RvcOperationalState.PhaseList
- ID: number
0x0000 the ID of this attribute
- NAME: str
“PhaseList” 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 PhaseList(…) 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: PhaseList => 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 PhaseList 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.RvcOperationalState.CurrentPhase
- ID: number
0x0001 the ID of this attribute
- NAME: str
“CurrentPhase” 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 CurrentPhase(…) 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
- subscribe(device, endpoint_id)
Reporting policy: CurrentPhase => 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 CurrentPhase 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.RvcOperationalState.CountdownTime
- ID: number
0x0002 the ID of this attribute
- NAME: str
“CountdownTime” the name of this attribute
- data_type: st.matter.data_types.Uint32
the data type of this attribute
- new_value(...)
Create a Uint32 object of this attribute with any additional features provided for the attribute
This is also usable with the CountdownTime(…) syntax
- Parameters
vararg (
vararg) – the values needed to construct a Uint32- 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: CountdownTime => 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 CountdownTime 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.RvcOperationalState.OperationalStateList
- ID: number
0x0003 the ID of this attribute
- NAME: str
“OperationalStateList” 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 OperationalStateList(…) 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: OperationalStateList => 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 OperationalStateList 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.RvcOperationalState.OperationalState
- ID: number
0x0004 the ID of this attribute
- NAME: str
“OperationalState” 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 OperationalState(…) 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
- subscribe(device, endpoint_id)
Reporting policy: OperationalState => 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 OperationalState 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.RvcOperationalState.OperationalError
- ID: number
0x0000 the ID of this event
- NAME: str
“OperationalError” the name of this event
- error_state: st.matter.generated.zap_clusters.RvcOperationalState.types.ErrorStateStruct
- 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
- subscribe(device, endpoint_id)
Constructs a subscribe InteractionRequest for the Event
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
- build_test_event_report(device, endpoint_id, fields, status)
Builds an OperationalError test event report reponse to be used by
the driver integration testing framework.
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- class st.matter.clusters.RvcOperationalState.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.RvcOperationalState.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.RvcOperationalState.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) –
Client Commands
- class st.matter.clusters.RvcOperationalState.OperationalCommandResponse
- ID: number
0x0004 the ID of this command
- NAME: str
“OperationalCommandResponse” the name of this command
- command_response_state: st.matter.generated.zap_clusters.RvcOperationalState.types.ErrorStateStruct
- augment_type(base_type_obj)
Add field names to each command field
- Parameters
base_type_obj (
st.matter.data_types.Structure) –
- build_test_command_response(device, endpoint_id, command_response_state)
Builds an OperationalCommandResponse test command reponse for the driver integration testing framework
- Parameters
device (
st.matter.Device) – the device to build this message toendpoint_id (
number or nil) –command_response_state (
st.matter.generated.zap_clusters.RvcOperationalState.types.ErrorStateStruct) –
- Returns
of type COMMAND_RESPONSE
- Return type
st.matter.st.matter.interaction_model.InteractionResponse
- init()
Initialize the OperationalCommandResponse command
- Return type
nil
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
Server Commands
- class st.matter.clusters.RvcOperationalState.Pause
- ID: number
0x0000 the ID of this command
- NAME: str
“Pause” the name of this command
- init(self, device)
Refer to OperationalCommandResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the Pause command
- Parameters
self (
Pause) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.RvcOperationalState.Resume
- ID: number
0x0003 the ID of this command
- NAME: str
“Resume” the name of this command
- init(self, device)
Refer to OperationalCommandResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the Resume command
- Parameters
self (
Resume) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.RvcOperationalState.GoHome
- ID: number
0x0080 the ID of this command
- NAME: str
“GoHome” the name of this command
- init(self, device)
Refer to OperationalCommandResponse:build_test_command_response for
building a test command reponse for the driver integration testing framework Initialize the GoHome command
- Parameters
self (
GoHome) – the template class for this commanddevice (
st.matter.Device) – the device to build this message to
- Returns
of type INVOKE
- Return type
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- 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.clusters.RvcOperationalState.OperationalError
- ID: number
0x0000 the ID of this event
- NAME: str
“OperationalError” the name of this event
- error_state: st.matter.generated.zap_clusters.RvcOperationalState.types.ErrorStateStruct
- 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
- subscribe(device, endpoint_id)
Constructs a subscribe InteractionRequest for the Event
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
- build_test_event_report(device, endpoint_id, fields, status)
Builds an OperationalError test event report reponse to be used by
the driver integration testing framework.
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
- class st.matter.clusters.RvcOperationalState.OperationCompletion
- ID: number
0x0001 the ID of this event
- NAME: str
“OperationCompletion” the name of this event
- completion_error_code: st.matter.data_types.Uint8
- total_operational_time: st.matter.data_types.Uint32
- paused_time: st.matter.data_types.Uint32
- 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
- subscribe(device, endpoint_id)
Constructs a subscribe InteractionRequest for the Event
- Parameters
device (
any) –endpoint_id (
number or nil) –
- Return type
- build_test_event_report(device, endpoint_id, fields, status)
Builds an OperationCompletion test event report reponse to be used by
the driver integration testing framework.
- Parameters
device (
st.matter.Device) – the device to build this message forendpoint_id (
number or nil) –fields (
table) – containing the event fieldsstatus (
str) – Interaction status associated with the path
- Returns
of type REPORT_DATA
- Return type
- deserialize(tlv_buf)
- Parameters
tlv_buf (
any) –
- set_parent_cluster(cluster)
- Parameters
cluster (
any) –
Enum types
- class st.matter.clusters.RvcOperationalState.types.ErrorStateEnum: st.matter.data_types.Uint8
- byte_length: number
1
- FAILED_TO_FIND_CHARGING_DOCK: number
64
- STUCK: number
65
- DUST_BIN_MISSING: number
66
- DUST_BIN_FULL: number
67
- WATER_TANK_EMPTY: number
68
- WATER_TANK_MISSING: number
69
- WATER_TANK_LID_OPEN: number
70
- MOP_CLEANING_PAD_MISSING: number
71
Struct types
- class st.matter.clusters.RvcOperationalState.types.ErrorStateStruct: st.matter.data_types.Structure
- error_state_id: st.matter.data_types.Uint8
- error_state_label: st.matter.data_types.UTF8String1
- error_state_details: st.matter.data_types.UTF8String1
- class st.matter.clusters.RvcOperationalState.types.OperationalStateStruct: st.matter.data_types.Structure
- operational_state_id: st.matter.data_types.Uint8
- operational_state_label: st.matter.data_types.UTF8String1