PumpConfigurationAndControl¶
Attributes¶
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxPressure¶
- ID: number¶
0x0000 the ID of this attribute
- NAME: str¶
“MaxPressure” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxPressure(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MaxPressure => 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 MaxPressure 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxSpeed¶
- ID: number¶
0x0001 the ID of this attribute
- NAME: str¶
“MaxSpeed” 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 MaxSpeed(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: MaxSpeed => 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 MaxSpeed 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxFlow¶
- ID: number¶
0x0002 the ID of this attribute
- NAME: str¶
“MaxFlow” 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 MaxFlow(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: MaxFlow => 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 MaxFlow 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MinConstPressure¶
- ID: number¶
0x0003 the ID of this attribute
- NAME: str¶
“MinConstPressure” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinConstPressure(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MinConstPressure => 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 MinConstPressure 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxConstPressure¶
- ID: number¶
0x0004 the ID of this attribute
- NAME: str¶
“MaxConstPressure” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxConstPressure(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MaxConstPressure => 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 MaxConstPressure 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MinCompPressure¶
- ID: number¶
0x0005 the ID of this attribute
- NAME: str¶
“MinCompPressure” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinCompPressure(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MinCompPressure => 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 MinCompPressure 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxCompPressure¶
- ID: number¶
0x0006 the ID of this attribute
- NAME: str¶
“MaxCompPressure” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxCompPressure(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MaxCompPressure => 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 MaxCompPressure 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MinConstSpeed¶
- ID: number¶
0x0007 the ID of this attribute
- NAME: str¶
“MinConstSpeed” 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 MinConstSpeed(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: MinConstSpeed => 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 MinConstSpeed 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxConstSpeed¶
- ID: number¶
0x0008 the ID of this attribute
- NAME: str¶
“MaxConstSpeed” 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 MaxConstSpeed(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: MaxConstSpeed => 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 MaxConstSpeed 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MinConstFlow¶
- ID: number¶
0x0009 the ID of this attribute
- NAME: str¶
“MinConstFlow” 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 MinConstFlow(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: MinConstFlow => 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 MinConstFlow 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxConstFlow¶
- ID: number¶
0x000A the ID of this attribute
- NAME: str¶
“MaxConstFlow” 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 MaxConstFlow(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: MaxConstFlow => 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 MaxConstFlow 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MinConstTemp¶
- ID: number¶
0x000B the ID of this attribute
- NAME: str¶
“MinConstTemp” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MinConstTemp(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MinConstTemp => 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 MinConstTemp 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.MaxConstTemp¶
- ID: number¶
0x000C the ID of this attribute
- NAME: str¶
“MaxConstTemp” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the MaxConstTemp(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: MaxConstTemp => 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 MaxConstTemp 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.PumpStatus¶
- ID: number¶
0x0010 the ID of this attribute
- NAME: str¶
“PumpStatus” the name of this attribute
- data_type: st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.PumpStatusBitmap¶
the data type of this attribute
- new_value(...)¶
Create a PumpStatusBitmap object of this attribute with any additional features provided for the attribute
This is also usable with the PumpStatus(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a PumpStatusBitmap- Return type:
st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.PumpStatusBitmap
- 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: PumpStatus => 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 PumpStatus 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.EffectiveOperationMode¶
- ID: number¶
0x0011 the ID of this attribute
- NAME: str¶
“EffectiveOperationMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.OperationModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a OperationModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the EffectiveOperationMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OperationModeEnum- Return type:
st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.OperationModeEnum
- 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: EffectiveOperationMode => 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 EffectiveOperationMode 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.EffectiveControlMode¶
- ID: number¶
0x0012 the ID of this attribute
- NAME: str¶
“EffectiveControlMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.ControlModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ControlModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the EffectiveControlMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ControlModeEnum- Return type:
st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.ControlModeEnum
- 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: EffectiveControlMode => 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 EffectiveControlMode 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.Capacity¶
- ID: number¶
0x0013 the ID of this attribute
- NAME: str¶
“Capacity” the name of this attribute
- data_type: st.matter.data_types.Int16¶
the data type of this attribute
- new_value(...)¶
Create a Int16 object of this attribute with any additional features provided for the attribute
This is also usable with the Capacity(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Int16- 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: Capacity => 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 Capacity 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.Speed¶
- ID: number¶
0x0014 the ID of this attribute
- NAME: str¶
“Speed” 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 Speed(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a Uint16- 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: Speed => 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 Speed 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.LifetimeRunningHours¶
- ID: number¶
0x0015 the ID of this attribute
- NAME: str¶
“LifetimeRunningHours” 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 LifetimeRunningHours(…) 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:
- 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.Uint32) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: LifetimeRunningHours => 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 LifetimeRunningHours 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.Power¶
- ID: number¶
0x0016 the ID of this attribute
- NAME: str¶
“Power” 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 Power(…) 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: Power => 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 Power 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.LifetimeEnergyConsumed¶
- ID: number¶
0x0017 the ID of this attribute
- NAME: str¶
“LifetimeEnergyConsumed” 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 LifetimeEnergyConsumed(…) 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:
- 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.Uint32) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: LifetimeEnergyConsumed => 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 LifetimeEnergyConsumed 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.OperationMode¶
- ID: number¶
0x0020 the ID of this attribute
- NAME: str¶
“OperationMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.OperationModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a OperationModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the OperationMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a OperationModeEnum- Return type:
st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.OperationModeEnum
- 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.PumpConfigurationAndControl.types.OperationModeEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: OperationMode => 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 OperationMode 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.generated.zap_clusters.PumpConfigurationAndControl.server.attributes.ControlMode¶
- ID: number¶
0x0021 the ID of this attribute
- NAME: str¶
“ControlMode” the name of this attribute
- data_type: st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.ControlModeEnum¶
the data type of this attribute
- new_value(...)¶
Create a ControlModeEnum object of this attribute with any additional features provided for the attribute
This is also usable with the ControlMode(…) syntax
- Parameters:
vararg (
vararg) – the values needed to construct a ControlModeEnum- Return type:
st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.ControlModeEnum
- 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.PumpConfigurationAndControl.types.ControlModeEnum) – the value to write
- Return type:
- subscribe(device, endpoint_id)¶
Reporting policy: ControlMode => 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 ControlMode 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.generated.zap_clusters.PumpConfigurationAndControl.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:
- 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
- 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.generated.zap_clusters.PumpConfigurationAndControl.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:
- 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
- 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)
Events¶
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.SupplyVoltageLow: st.matter.data_types.Structure¶
- ID: number¶
0x0000 the ID of this event
- NAME: str¶
“SupplyVoltageLow” the name of this event
- 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 SupplyVoltageLow 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.SupplyVoltageHigh: st.matter.data_types.Structure¶
- ID: number¶
0x0001 the ID of this event
- NAME: str¶
“SupplyVoltageHigh” the name of this event
- 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 SupplyVoltageHigh 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.PowerMissingPhase: st.matter.data_types.Structure¶
- ID: number¶
0x0002 the ID of this event
- NAME: str¶
“PowerMissingPhase” the name of this event
- 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 PowerMissingPhase 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.SystemPressureLow: st.matter.data_types.Structure¶
- ID: number¶
0x0003 the ID of this event
- NAME: str¶
“SystemPressureLow” the name of this event
- 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 SystemPressureLow 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.SystemPressureHigh: st.matter.data_types.Structure¶
- ID: number¶
0x0004 the ID of this event
- NAME: str¶
“SystemPressureHigh” the name of this event
- 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 SystemPressureHigh 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.DryRunning: st.matter.data_types.Structure¶
- ID: number¶
0x0005 the ID of this event
- NAME: str¶
“DryRunning” the name of this event
- 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 DryRunning 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.MotorTemperatureHigh: st.matter.data_types.Structure¶
- ID: number¶
0x0006 the ID of this event
- NAME: str¶
“MotorTemperatureHigh” the name of this event
- 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 MotorTemperatureHigh 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.PumpMotorFatalFailure: st.matter.data_types.Structure¶
- ID: number¶
0x0007 the ID of this event
- NAME: str¶
“PumpMotorFatalFailure” the name of this event
- 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 PumpMotorFatalFailure 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.ElectronicTemperatureHigh: st.matter.data_types.Structure¶
- ID: number¶
0x0008 the ID of this event
- NAME: str¶
“ElectronicTemperatureHigh” the name of this event
- 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 ElectronicTemperatureHigh 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.PumpBlocked: st.matter.data_types.Structure¶
- ID: number¶
0x0009 the ID of this event
- NAME: str¶
“PumpBlocked” the name of this event
- 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 PumpBlocked 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.SensorFailure: st.matter.data_types.Structure¶
- ID: number¶
0x000A the ID of this event
- NAME: str¶
“SensorFailure” the name of this event
- 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 SensorFailure 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.ElectronicNonFatalFailure: st.matter.data_types.Structure¶
- ID: number¶
0x000B the ID of this event
- NAME: str¶
“ElectronicNonFatalFailure” the name of this event
- 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 ElectronicNonFatalFailure 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.ElectronicFatalFailure: st.matter.data_types.Structure¶
- ID: number¶
0x000C the ID of this event
- NAME: str¶
“ElectronicFatalFailure” the name of this event
- 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 ElectronicFatalFailure 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.GeneralFault: st.matter.data_types.Structure¶
- ID: number¶
0x000D the ID of this event
- NAME: str¶
“GeneralFault” the name of this event
- 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 GeneralFault 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.Leakage: st.matter.data_types.Structure¶
- ID: number¶
0x000E the ID of this event
- NAME: str¶
“Leakage” the name of this event
- 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 Leakage 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.AirDetection: st.matter.data_types.Structure¶
- ID: number¶
0x000F the ID of this event
- NAME: str¶
“AirDetection” the name of this event
- 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 AirDetection 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)
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.server.events.TurbineOperation: st.matter.data_types.Structure¶
- ID: number¶
0x0010 the ID of this event
- NAME: str¶
“TurbineOperation” the name of this event
- 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 TurbineOperation 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)
Bitmap types¶
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.Feature¶
- CONSTANT_PRESSURE: number¶
1
- COMPENSATED_PRESSURE: number¶
2
- CONSTANT_FLOW: number¶
4
- CONSTANT_SPEED: number¶
8
- CONSTANT_TEMPERATURE: number¶
16
- AUTOMATIC: number¶
32
- LOCAL_OPERATION: number¶
64
- is_constant_pressure_set()¶
- Returns:
True if the value of CONSTANT_PRESSURE is non-zero
- Return type:
boolean
- set_constant_pressure()¶
Set the value of the bit in the CONSTANT_PRESSURE field to 1
- unset_constant_pressure()¶
Set the value of the bits in the CONSTANT_PRESSURE field to 0
- is_compensated_pressure_set()¶
- Returns:
True if the value of COMPENSATED_PRESSURE is non-zero
- Return type:
boolean
- set_compensated_pressure()¶
Set the value of the bit in the COMPENSATED_PRESSURE field to 1
- unset_compensated_pressure()¶
Set the value of the bits in the COMPENSATED_PRESSURE field to 0
- is_constant_flow_set()¶
- Returns:
True if the value of CONSTANT_FLOW is non-zero
- Return type:
boolean
- set_constant_flow()¶
Set the value of the bit in the CONSTANT_FLOW field to 1
- unset_constant_flow()¶
Set the value of the bits in the CONSTANT_FLOW field to 0
- is_constant_speed_set()¶
- Returns:
True if the value of CONSTANT_SPEED is non-zero
- Return type:
boolean
- set_constant_speed()¶
Set the value of the bit in the CONSTANT_SPEED field to 1
- unset_constant_speed()¶
Set the value of the bits in the CONSTANT_SPEED field to 0
- is_constant_temperature_set()¶
- Returns:
True if the value of CONSTANT_TEMPERATURE is non-zero
- Return type:
boolean
- set_constant_temperature()¶
Set the value of the bit in the CONSTANT_TEMPERATURE field to 1
- unset_constant_temperature()¶
Set the value of the bits in the CONSTANT_TEMPERATURE field to 0
- is_automatic_set()¶
- Returns:
True if the value of AUTOMATIC is non-zero
- Return type:
boolean
- set_automatic()¶
Set the value of the bit in the AUTOMATIC field to 1
- unset_automatic()¶
Set the value of the bits in the AUTOMATIC field to 0
- is_local_operation_set()¶
- Returns:
True if the value of LOCAL_OPERATION is non-zero
- Return type:
boolean
- set_local_operation()¶
Set the value of the bit in the LOCAL_OPERATION field to 1
- unset_local_operation()¶
Set the value of the bits in the LOCAL_OPERATION field to 0
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.PumpStatusBitmap¶
- DEVICE_FAULT: number¶
1
- SUPPLY_FAULT: number¶
2
- SPEED_LOW: number¶
4
- SPEED_HIGH: number¶
8
- LOCAL_OVERRIDE: number¶
16
- RUNNING: number¶
32
- REMOTE_PRESSURE: number¶
64
- REMOTE_FLOW: number¶
128
- REMOTE_TEMPERATURE: number¶
256
- is_device_fault_set()¶
- Returns:
True if the value of DEVICE_FAULT is non-zero
- Return type:
boolean
- set_device_fault()¶
Set the value of the bit in the DEVICE_FAULT field to 1
- unset_device_fault()¶
Set the value of the bits in the DEVICE_FAULT field to 0
- is_supply_fault_set()¶
- Returns:
True if the value of SUPPLY_FAULT is non-zero
- Return type:
boolean
- set_supply_fault()¶
Set the value of the bit in the SUPPLY_FAULT field to 1
- unset_supply_fault()¶
Set the value of the bits in the SUPPLY_FAULT field to 0
- is_speed_low_set()¶
- Returns:
True if the value of SPEED_LOW is non-zero
- Return type:
boolean
- set_speed_low()¶
Set the value of the bit in the SPEED_LOW field to 1
- unset_speed_low()¶
Set the value of the bits in the SPEED_LOW field to 0
- is_speed_high_set()¶
- Returns:
True if the value of SPEED_HIGH is non-zero
- Return type:
boolean
- set_speed_high()¶
Set the value of the bit in the SPEED_HIGH field to 1
- unset_speed_high()¶
Set the value of the bits in the SPEED_HIGH field to 0
- is_local_override_set()¶
- Returns:
True if the value of LOCAL_OVERRIDE is non-zero
- Return type:
boolean
- set_local_override()¶
Set the value of the bit in the LOCAL_OVERRIDE field to 1
- unset_local_override()¶
Set the value of the bits in the LOCAL_OVERRIDE field to 0
- is_running_set()¶
- Returns:
True if the value of RUNNING is non-zero
- Return type:
boolean
- set_running()¶
Set the value of the bit in the RUNNING field to 1
- unset_running()¶
Set the value of the bits in the RUNNING field to 0
- is_remote_pressure_set()¶
- Returns:
True if the value of REMOTE_PRESSURE is non-zero
- Return type:
boolean
- set_remote_pressure()¶
Set the value of the bit in the REMOTE_PRESSURE field to 1
- unset_remote_pressure()¶
Set the value of the bits in the REMOTE_PRESSURE field to 0
- is_remote_flow_set()¶
- Returns:
True if the value of REMOTE_FLOW is non-zero
- Return type:
boolean
- set_remote_flow()¶
Set the value of the bit in the REMOTE_FLOW field to 1
- unset_remote_flow()¶
Set the value of the bits in the REMOTE_FLOW field to 0
- is_remote_temperature_set()¶
- Returns:
True if the value of REMOTE_TEMPERATURE is non-zero
- Return type:
boolean
- set_remote_temperature()¶
Set the value of the bit in the REMOTE_TEMPERATURE field to 1
- unset_remote_temperature()¶
Set the value of the bits in the REMOTE_TEMPERATURE field to 0
Enum types¶
- class st.matter.generated.zap_clusters.PumpConfigurationAndControl.types.ControlModeEnum: st.matter.data_types.Uint8¶
- byte_length: number¶
1
- CONSTANT_SPEED: number¶
0
- CONSTANT_PRESSURE: number¶
1
- PROPORTIONAL_PRESSURE: number¶
2
- CONSTANT_FLOW: number¶
3
- CONSTANT_TEMPERATURE: number¶
5
- AUTOMATIC: number¶
7