FanControl

Attributes

class st.matter.generated.zap_clusters.FanControl.server.attributes.FanMode
ID: number

0x0000 the ID of this attribute

NAME: str

“FanMode” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.FanModeEnum

the data type of this attribute

new_value(...)

Create a FanModeEnum 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 FanModeEnum

Return type:

st.matter.generated.zap_clusters.FanControl.types.FanModeEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.FanModeSequence
ID: number

0x0001 the ID of this attribute

NAME: str

“FanModeSequence” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.FanModeSequenceEnum

the data type of this attribute

new_value(...)

Create a FanModeSequenceEnum 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 FanModeSequenceEnum

Return type:

st.matter.generated.zap_clusters.FanControl.types.FanModeSequenceEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.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:

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.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:

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.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:

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.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:

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.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:

st.matter.data_types.Uint8

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.RockSupport
ID: number

0x0007 the ID of this attribute

NAME: str

“RockSupport” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.RockBitmap

the data type of this attribute

new_value(...)

Create a RockBitmap 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 RockBitmap

Return type:

st.matter.generated.zap_clusters.FanControl.types.RockBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.RockSetting
ID: number

0x0008 the ID of this attribute

NAME: str

“RockSetting” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.RockBitmap

the data type of this attribute

new_value(...)

Create a RockBitmap 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 RockBitmap

Return type:

st.matter.generated.zap_clusters.FanControl.types.RockBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.WindSupport
ID: number

0x0009 the ID of this attribute

NAME: str

“WindSupport” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.WindBitmap

the data type of this attribute

new_value(...)

Create a WindBitmap 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 WindBitmap

Return type:

st.matter.generated.zap_clusters.FanControl.types.WindBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.WindSetting
ID: number

0x000A the ID of this attribute

NAME: str

“WindSetting” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.WindBitmap

the data type of this attribute

new_value(...)

Create a WindBitmap 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 WindBitmap

Return type:

st.matter.generated.zap_clusters.FanControl.types.WindBitmap

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

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

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 for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.AirflowDirection
ID: number

0x000B the ID of this attribute

NAME: str

“AirflowDirection” the name of this attribute

data_type: st.matter.generated.zap_clusters.FanControl.types.AirflowDirectionEnum

the data type of this attribute

new_value(...)

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

This is also usable with the AirflowDirection(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a AirflowDirectionEnum

Return type:

st.matter.generated.zap_clusters.FanControl.types.AirflowDirectionEnum

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

write(device, endpoint_id, value)

Constructs an st.matter.interaction_model.InteractionRequest to write

this attribute to a device

Parameters:
Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AirflowDirection => 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 AirflowDirection test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.AcceptedCommandList
ID: number

0xFFF9 the ID of this attribute

NAME: str

“AcceptedCommandList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

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

This is also usable with the AcceptedCommandList(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Array

Return type:

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AcceptedCommandList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an AcceptedCommandList test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

class st.matter.generated.zap_clusters.FanControl.server.attributes.AttributeList
ID: number

0xFFFB the ID of this attribute

NAME: str

“AttributeList” the name of this attribute

data_type: st.matter.data_types.Array

the data type of this attribute

augment_type(data_type_obj)

Add additional functionality to the base type object

Parameters:

data_type_obj (st.matter.data_types.Array) – the base data type object to add functionality to

new_value(...)

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

This is also usable with the AttributeList(…) syntax

Parameters:

vararg (vararg) – the values needed to construct a Array

Return type:

st.matter.data_types.Array

read(device, endpoint_id)

Constructs an st.matter.interaction_model.InteractionRequest to read

this attribute from a device

Parameters:
Returns:

containing an Interaction Request

Return type:

st.matter.interaction_model.InteractionRequest

subscribe(device, endpoint_id)

Reporting policy: AttributeList => true => mandatory

Sets up a Subscribe Interaction

Parameters:

  • device (any)

  • endpoint_id (number or nil)

Return type:

any

build_test_report_data(device, endpoint_id, value, status)

Builds an AttributeList test attribute reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message for

  • endpoint_id (number or nil)

  • value (any)

  • status (str) – Interaction status associated with the path

Returns:

of type REPORT_DATA

Return type:

st.matter.interaction_model.InteractionResponse

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Server Commands

class st.matter.generated.zap_clusters.FanControl.server.commands.Step: st.matter.data_types.Structure
ID: number

0x0000 the ID of this command

NAME: str

“Step” the name of this command

direction: st.matter.generated.zap_clusters.FanControl.types.StepDirectionEnum
wrap: st.matter.data_types.Boolean
lowest_off: st.matter.data_types.Boolean
build_test_command_response(device, endpoint_id, status)

Builds an Step test command reponse for the driver integration testing framework

Parameters:

  • device (st.matter.Device) – the device to build this message to

  • endpoint_id (number or nil)

  • status (str) – Interaction status associated with the path

Returns:

of type COMMAND_RESPONSE

Return type:

st.matter.st.matter.interaction_model.InteractionResponse

init(device, direction, wrap, lowest_off)

Initialize the Step command

Parameters:
Returns:

of type INVOKE

Return type:

st.matter.interaction_model.InteractionRequest

augment_type(base_type_obj)

Add field names to each command field

Parameters:

base_type_obj (st.matter.data_types.Structure)

deserialize(tlv_buf)
Parameters:

tlv_buf (any)

Bitmap types

class st.matter.generated.zap_clusters.FanControl.types.Feature
MULTI_SPEED: number

1

AUTO: number

2

ROCKING: number

4

WIND: number

8

STEP: number

16

AIRFLOW_DIRECTION: number

32

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

is_step_set()
Returns:

True if the value of STEP is non-zero

Return type:

boolean

set_step()

Set the value of the bit in the STEP field to 1

unset_step()

Set the value of the bits in the STEP field to 0

is_airflow_direction_set()
Returns:

True if the value of AIRFLOW_DIRECTION is non-zero

Return type:

boolean

set_airflow_direction()

Set the value of the bit in the AIRFLOW_DIRECTION field to 1

unset_airflow_direction()

Set the value of the bits in the AIRFLOW_DIRECTION field to 0

class st.matter.generated.zap_clusters.FanControl.types.RockBitmap
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.generated.zap_clusters.FanControl.types.WindBitmap
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

Enum types

class st.matter.generated.zap_clusters.FanControl.types.AirflowDirectionEnum: st.matter.data_types.Uint8
byte_length: number

1

FORWARD: number

0

REVERSE: number

1

class st.matter.generated.zap_clusters.FanControl.types.FanModeEnum: st.matter.data_types.Uint8
byte_length: number

1

OFF: number

0

LOW: number

1

MEDIUM: number

2

HIGH: number

3

ON: number

4

AUTO: number

5

SMART: number

6

class st.matter.generated.zap_clusters.FanControl.types.FanModeSequenceEnum: st.matter.data_types.Uint8
byte_length: number

1

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_HIGH_AUTO: number

4

OFF_HIGH: number

5

class st.matter.generated.zap_clusters.FanControl.types.StepDirectionEnum: st.matter.data_types.Uint8
byte_length: number

1

INCREASE: number

0

DECREASE: number

1