FanControl
Attributes
- class st.matter.clusters.FanControl.FanMode
- ID: number
0x0000 the ID of this attribute
- NAME: str
“FanMode” the name of this attribute
- data_type: st.matter.data_types.Uint8
the data type of this attribute
- OFF: number
0
- LOW: number
1
- MEDIUM: number
2
- HIGH: number
3
- ON: number
4
- AUTO: number
5
- SMART: number
6
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Uint8) – the base data type object to add functionality to
- new_value(...)
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the FanMode(…) 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) –
- Returns
the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: FanMode => 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 FanMode 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.FanControl.FanModeSequence
- ID: number
0x0001 the ID of this attribute
- NAME: str
“FanModeSequence” the name of this attribute
- data_type: st.matter.data_types.Uint8
the data type of this attribute
- OFF_LOW_MED_HIGH: number
0
- OFF_LOW_HIGH: number
1
- OFF_LOW_MED_HIGH_AUTO: number
2
- OFF_LOW_HIGH_AUTO: number
3
- OFF_ON_AUTO: number
4
- OFF_ON: number
5
- augment_type(base_type_obj)
Add additional functionality to the base type object
- Parameters
base_type_obj (
st.matter.data_types.Uint8) – the base data type object to add functionality to
- new_value(...)
Create a Uint8 object of this attribute with any additional features provided for the attribute
This is also usable with the FanModeSequence(…) 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) –
- Returns
the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: FanModeSequence => 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 FanModeSequence 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.FanControl.PercentSetting
- ID: number
0x0002 the ID of this attribute
- NAME: str
“PercentSetting” 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 PercentSetting(…) 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) –
- Returns
the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: PercentSetting => 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 PercentSetting 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.FanControl.PercentCurrent
- ID: number
0x0003 the ID of this attribute
- NAME: str
“PercentCurrent” 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 PercentCurrent(…) 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: PercentCurrent => 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 PercentCurrent 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.FanControl.SpeedMax
- ID: number
0x0004 the ID of this attribute
- NAME: str
“SpeedMax” 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 SpeedMax(…) 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: SpeedMax => 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 SpeedMax 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.FanControl.SpeedSetting
- ID: number
0x0005 the ID of this attribute
- NAME: str
“SpeedSetting” 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 SpeedSetting(…) 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) –
- Returns
the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: SpeedSetting => 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 SpeedSetting 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.FanControl.SpeedCurrent
- ID: number
0x0006 the ID of this attribute
- NAME: str
“SpeedCurrent” 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 SpeedCurrent(…) 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: SpeedCurrent => 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 SpeedCurrent 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.FanControl.RockSupport
- ID: number
0x0007 the ID of this attribute
- NAME: str
“RockSupport” 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 RockSupport(…) 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: RockSupport => 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 RockSupport 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.FanControl.RockSetting
- ID: number
0x0008 the ID of this attribute
- NAME: str
“RockSetting” 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 RockSetting(…) 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) –
- Returns
the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: RockSetting => 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 RockSetting 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.FanControl.WindSupport
- ID: number
0x0009 the ID of this attribute
- NAME: str
“WindSupport” 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 WindSupport(…) 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: WindSupport => 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 WindSupport 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.FanControl.WindSetting
- ID: number
0x000A the ID of this attribute
- NAME: str
“WindSetting” 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 WindSetting(…) 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) –
- Returns
the value to write
- Return type
- subscribe(device, endpoint_id)
Reporting policy: WindSetting => 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 WindSetting 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.FanControl.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
- 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.FanControl.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
- 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.FanControl.types.FanControlFeature
- MULTI_SPEED: number
1
- AUTO: number
2
- ROCKING: number
4
- WIND: number
8
- is_multi_speed_set()
- Returns
True if the value of MULTI_SPEED is non-zero
- Return type
boolean
- set_multi_speed()
Set the value of the bit in the MULTI_SPEED field to 1
- unset_multi_speed()
Set the value of the bits in the MULTI_SPEED field to 0
- is_auto_set()
- Returns
True if the value of AUTO is non-zero
- Return type
boolean
- set_auto()
Set the value of the bit in the AUTO field to 1
- unset_auto()
Set the value of the bits in the AUTO field to 0
- is_rocking_set()
- Returns
True if the value of ROCKING is non-zero
- Return type
boolean
- set_rocking()
Set the value of the bit in the ROCKING field to 1
- unset_rocking()
Set the value of the bits in the ROCKING field to 0
- is_wind_set()
- Returns
True if the value of WIND is non-zero
- Return type
boolean
- set_wind()
Set the value of the bit in the WIND field to 1
- unset_wind()
Set the value of the bits in the WIND field to 0
- class st.matter.clusters.FanControl.types.RockSupportMask
- ROCK_LEFT_RIGHT: number
1
- ROCK_UP_DOWN: number
2
- ROCK_ROUND: number
4
- is_rock_left_right_set()
- Returns
True if the value of ROCK_LEFT_RIGHT is non-zero
- Return type
boolean
- set_rock_left_right()
Set the value of the bit in the ROCK_LEFT_RIGHT field to 1
- unset_rock_left_right()
Set the value of the bits in the ROCK_LEFT_RIGHT field to 0
- is_rock_up_down_set()
- Returns
True if the value of ROCK_UP_DOWN is non-zero
- Return type
boolean
- set_rock_up_down()
Set the value of the bit in the ROCK_UP_DOWN field to 1
- unset_rock_up_down()
Set the value of the bits in the ROCK_UP_DOWN field to 0
- is_rock_round_set()
- Returns
True if the value of ROCK_ROUND is non-zero
- Return type
boolean
- set_rock_round()
Set the value of the bit in the ROCK_ROUND field to 1
- unset_rock_round()
Set the value of the bits in the ROCK_ROUND field to 0
- class st.matter.clusters.FanControl.types.WindSettingMask
- SLEEP_WIND: number
1
- NATURAL_WIND: number
2
- is_sleep_wind_set()
- Returns
True if the value of SLEEP_WIND is non-zero
- Return type
boolean
- set_sleep_wind()
Set the value of the bit in the SLEEP_WIND field to 1
- unset_sleep_wind()
Set the value of the bits in the SLEEP_WIND field to 0
- is_natural_wind_set()
- Returns
True if the value of NATURAL_WIND is non-zero
- Return type
boolean
- set_natural_wind()
Set the value of the bit in the NATURAL_WIND field to 1
- unset_natural_wind()
Set the value of the bits in the NATURAL_WIND field to 0
- class st.matter.clusters.FanControl.types.WindSupportMask
- SLEEP_WIND: number
1
- NATURAL_WIND: number
2
- is_sleep_wind_set()
- Returns
True if the value of SLEEP_WIND is non-zero
- Return type
boolean
- set_sleep_wind()
Set the value of the bit in the SLEEP_WIND field to 1
- unset_sleep_wind()
Set the value of the bits in the SLEEP_WIND field to 0
- is_natural_wind_set()
- Returns
True if the value of NATURAL_WIND is non-zero
- Return type
boolean
- set_natural_wind()
Set the value of the bit in the NATURAL_WIND field to 1
- unset_natural_wind()
Set the value of the bits in the NATURAL_WIND field to 0