homeassistant.components.matter.fan Namespace Reference

Classes
class	MatterFan

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
list	DISCOVERY_SCHEMAS
dictionary	FAN_MODE_MAP
dictionary	FAN_MODE_MAP_REVERSE = {v: k for k, v in FAN_MODE_MAP.items()}
	FanControlFeature = clusters.FanControl.Bitmaps.Feature
	FanModeSequenceEnum = clusters.FanControl.Enums.FanModeSequenceEnum
string	PRESET_AUTO = "auto"
string	PRESET_HIGH = "high"
string	PRESET_LOW = "low"
string	PRESET_MEDIUM = "medium"
string	PRESET_NATURAL_WIND = "natural_wind"
string	PRESET_SLEEP_WIND = "sleep_wind"
	WindBitmap = clusters.FanControl.Bitmaps.WindBitmap

Detailed Description

Matter Fan platform support.

Function Documentation

async_setup_entry()

None homeassistant.components.matter.fan.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Set up Matter fan from Config Entry.

Definition at line 46 of file fan.py.

Variable Documentation

DISCOVERY_SCHEMAS

list homeassistant.components.matter.fan.DISCOVERY_SCHEMAS

Initial value:

=  [
    MatterDiscoverySchema(
        platform=Platform.FAN,
        entity_description=FanEntityDescription(
            key="MatterFan",
            name=None,
        ),
        entity_class=MatterFan,
        # FanEntityFeature
        required_attributes=(
            clusters.FanControl.Attributes.FanMode,
            clusters.FanControl.Attributes.PercentCurrent,
        ),
        optional_attributes=(
            clusters.FanControl.Attributes.SpeedSetting,
            clusters.FanControl.Attributes.RockSetting,
            clusters.FanControl.Attributes.WindSetting,
            clusters.FanControl.Attributes.AirflowDirection,
            clusters.OnOff.Attributes.OnOff,
        ),
    ),
]

Definition at line 329 of file fan.py.

FAN_MODE_MAP

dictionary homeassistant.components.matter.fan.FAN_MODE_MAP

Initial value:

=  {
    PRESET_LOW: clusters.FanControl.Enums.FanModeEnum.kLow,
    PRESET_MEDIUM: clusters.FanControl.Enums.FanModeEnum.kMedium,
    PRESET_HIGH: clusters.FanControl.Enums.FanModeEnum.kHigh,
    PRESET_AUTO: clusters.FanControl.Enums.FanModeEnum.kAuto,
}

Definition at line 34 of file fan.py.

FAN_MODE_MAP_REVERSE

dictionary homeassistant.components.matter.fan.FAN_MODE_MAP_REVERSE = {v: k for k, v in FAN_MODE_MAP.items()}

Definition at line 40 of file fan.py.

FanControlFeature

homeassistant.components.matter.fan.FanControlFeature = clusters.FanControl.Bitmaps.Feature

Definition at line 26 of file fan.py.

FanModeSequenceEnum

homeassistant.components.matter.fan.FanModeSequenceEnum = clusters.FanControl.Enums.FanModeSequenceEnum

Definition at line 28 of file fan.py.

PRESET_AUTO

string homeassistant.components.matter.fan.PRESET_AUTO = "auto"

Definition at line 33 of file fan.py.

PRESET_HIGH

string homeassistant.components.matter.fan.PRESET_HIGH = "high"

Definition at line 32 of file fan.py.

PRESET_LOW

string homeassistant.components.matter.fan.PRESET_LOW = "low"

Definition at line 30 of file fan.py.

PRESET_MEDIUM

string homeassistant.components.matter.fan.PRESET_MEDIUM = "medium"

Definition at line 31 of file fan.py.

PRESET_NATURAL_WIND

string homeassistant.components.matter.fan.PRESET_NATURAL_WIND = "natural_wind"

Definition at line 42 of file fan.py.

PRESET_SLEEP_WIND

string homeassistant.components.matter.fan.PRESET_SLEEP_WIND = "sleep_wind"

Definition at line 43 of file fan.py.

WindBitmap

homeassistant.components.matter.fan.WindBitmap = clusters.FanControl.Bitmaps.WindBitmap

Definition at line 27 of file fan.py.