Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.xiaomi_miio.fan Namespace Reference

Classes

class  XiaomiAirFresh
 
class  XiaomiAirFreshA1
 
class  XiaomiAirFreshT2017
 
class  XiaomiAirPurifier
 
class  XiaomiAirPurifierMB4
 
class  XiaomiAirPurifierMiot
 
class  XiaomiFan
 
class  XiaomiFan1C
 
class  XiaomiFanMiot
 
class  XiaomiFanP5
 
class  XiaomiFanZA5
 
class  XiaomiGenericAirPurifier
 
class  XiaomiGenericDevice
 
class  XiaomiGenericFan
 

Functions

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

Variables

 _LOGGER = logging.getLogger(__name__)
 
 AIRPURIFIER_SERVICE_SCHEMA = vol.Schema({vol.Optional(ATTR_ENTITY_ID): cv.entity_ids})
 
string ATTR_BRIGHTNESS = "brightness"
 
string ATTR_BUTTON_PRESSED = "button_pressed"
 
string ATTR_EXTRA_FEATURES = "extra_features"
 
string ATTR_FAN_LEVEL = "fan_level"
 
string ATTR_FAVORITE_RPM = "favorite_rpm"
 
string ATTR_FAVORITE_SPEED = "favorite_speed"
 
string ATTR_FEATURES = "features"
 
string ATTR_MODE_NATURE = "nature"
 
string ATTR_MODE_NORMAL = "normal"
 
string ATTR_MOTOR_SPEED = "motor_speed"
 
string ATTR_SLEEP_LEARN_COUNT = "sleep_mode_learn_count"
 
string ATTR_SLEEP_MODE = "sleep_mode"
 
string ATTR_SLEEP_TIME = "sleep_time"
 
string ATTR_TURBO_MODE_SUPPORTED = "turbo_mode_supported"
 
string ATTR_USE_TIME = "use_time"
 
dictionary AVAILABLE_ATTRIBUTES_AIRFRESH
 
dictionary AVAILABLE_ATTRIBUTES_AIRPURIFIER
 
dictionary AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON
 
dictionary AVAILABLE_ATTRIBUTES_AIRPURIFIER_MIOT = {ATTR_USE_TIME: "use_time"}
 
dictionary AVAILABLE_ATTRIBUTES_AIRPURIFIER_PRO
 
dictionary AVAILABLE_ATTRIBUTES_AIRPURIFIER_PRO_V7 = AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON
 
dictionary AVAILABLE_ATTRIBUTES_AIRPURIFIER_V3
 
string DATA_KEY = "fan.xiaomi_miio"
 
dictionary FAN_DIRECTIONS_MAP
 
list PRESET_MODES_AIRFRESH = ["Auto", "Interval"]
 
list PRESET_MODES_AIRFRESH_A1 = ["Auto", "Sleep", "Favorite"]
 
list PRESET_MODES_AIRPURIFIER = ["Auto", "Silent", "Favorite", "Idle"]
 
list PRESET_MODES_AIRPURIFIER_2S = ["Auto", "Silent", "Favorite"]
 
list PRESET_MODES_AIRPURIFIER_3C = ["Auto", "Silent", "Favorite"]
 
list PRESET_MODES_AIRPURIFIER_4_LITE = ["Auto", "Silent", "Favorite"]
 
list PRESET_MODES_AIRPURIFIER_MIOT = ["Auto", "Silent", "Favorite", "Fan"]
 
list PRESET_MODES_AIRPURIFIER_PRO = ["Auto", "Silent", "Favorite"]
 
list PRESET_MODES_AIRPURIFIER_PRO_V7 = PRESET_MODES_AIRPURIFIER_PRO
 
list PRESET_MODES_AIRPURIFIER_V3
 
list PRESET_MODES_AIRPURIFIER_ZA1 = ["Auto", "Silent", "Favorite"]
 
 SERVICE_SCHEMA_EXTRA_FEATURES
 
dictionary SERVICE_TO_METHOD
 

Detailed Description

Support for Xiaomi Mi Air Purifier and Xiaomi Mi Air Humidifier.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.xiaomi_miio.fan.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
) 
Set up the Fan from a config entry.

Definition at line 205 of file fan.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.xiaomi_miio.fan._LOGGER = logging.getLogger(__name__)
private

Definition at line 99 of file fan.py.

◆ AIRPURIFIER_SERVICE_SCHEMA

homeassistant.components.xiaomi_miio.fan.AIRPURIFIER_SERVICE_SCHEMA = vol.Schema({vol.Optional(ATTR_ENTITY_ID): cv.entity_ids})

Definition at line 185 of file fan.py.

◆ ATTR_BRIGHTNESS

string homeassistant.components.xiaomi_miio.fan.ATTR_BRIGHTNESS = "brightness"

Definition at line 107 of file fan.py.

◆ ATTR_BUTTON_PRESSED

string homeassistant.components.xiaomi_miio.fan.ATTR_BUTTON_PRESSED = "button_pressed"

Definition at line 116 of file fan.py.

◆ ATTR_EXTRA_FEATURES

string homeassistant.components.xiaomi_miio.fan.ATTR_EXTRA_FEATURES = "extra_features"

Definition at line 111 of file fan.py.

◆ ATTR_FAN_LEVEL

string homeassistant.components.xiaomi_miio.fan.ATTR_FAN_LEVEL = "fan_level"

Definition at line 108 of file fan.py.

◆ ATTR_FAVORITE_RPM

string homeassistant.components.xiaomi_miio.fan.ATTR_FAVORITE_RPM = "favorite_rpm"

Definition at line 122 of file fan.py.

◆ ATTR_FAVORITE_SPEED

string homeassistant.components.xiaomi_miio.fan.ATTR_FAVORITE_SPEED = "favorite_speed"

Definition at line 119 of file fan.py.

◆ ATTR_FEATURES

string homeassistant.components.xiaomi_miio.fan.ATTR_FEATURES = "features"

Definition at line 112 of file fan.py.

◆ ATTR_MODE_NATURE

string homeassistant.components.xiaomi_miio.fan.ATTR_MODE_NATURE = "nature"

Definition at line 103 of file fan.py.

◆ ATTR_MODE_NORMAL

string homeassistant.components.xiaomi_miio.fan.ATTR_MODE_NORMAL = "normal"

Definition at line 104 of file fan.py.

◆ ATTR_MOTOR_SPEED

string homeassistant.components.xiaomi_miio.fan.ATTR_MOTOR_SPEED = "motor_speed"

Definition at line 123 of file fan.py.

◆ ATTR_SLEEP_LEARN_COUNT

string homeassistant.components.xiaomi_miio.fan.ATTR_SLEEP_LEARN_COUNT = "sleep_mode_learn_count"

Definition at line 110 of file fan.py.

◆ ATTR_SLEEP_MODE

string homeassistant.components.xiaomi_miio.fan.ATTR_SLEEP_MODE = "sleep_mode"

Definition at line 114 of file fan.py.

◆ ATTR_SLEEP_TIME

string homeassistant.components.xiaomi_miio.fan.ATTR_SLEEP_TIME = "sleep_time"

Definition at line 109 of file fan.py.

◆ ATTR_TURBO_MODE_SUPPORTED

string homeassistant.components.xiaomi_miio.fan.ATTR_TURBO_MODE_SUPPORTED = "turbo_mode_supported"

Definition at line 113 of file fan.py.

◆ ATTR_USE_TIME

string homeassistant.components.xiaomi_miio.fan.ATTR_USE_TIME = "use_time"

Definition at line 115 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRFRESH

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRFRESH
Initial value:
1 = {
2  ATTR_USE_TIME: "use_time",
3  ATTR_EXTRA_FEATURES: "extra_features",
4 }

Definition at line 160 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRPURIFIER

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRPURIFIER
Initial value:
1 = {
2  **AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON,
3  ATTR_SLEEP_TIME: "sleep_time",
4  ATTR_SLEEP_LEARN_COUNT: "sleep_mode_learn_count",
5  ATTR_USE_TIME: "use_time",
6  ATTR_SLEEP_MODE: "sleep_mode",
7 }

Definition at line 132 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON
Initial value:
1 = {
2  ATTR_EXTRA_FEATURES: "extra_features",
3  ATTR_TURBO_MODE_SUPPORTED: "turbo_mode_supported",
4  ATTR_BUTTON_PRESSED: "button_pressed",
5 }

Definition at line 126 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRPURIFIER_MIOT

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRPURIFIER_MIOT = {ATTR_USE_TIME: "use_time"}

Definition at line 147 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRPURIFIER_PRO

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRPURIFIER_PRO
Initial value:
1 = {
2  **AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON,
3  ATTR_USE_TIME: "use_time",
4  ATTR_SLEEP_TIME: "sleep_time",
5  ATTR_SLEEP_LEARN_COUNT: "sleep_mode_learn_count",
6 }

Definition at line 140 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRPURIFIER_PRO_V7

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRPURIFIER_PRO_V7 = AVAILABLE_ATTRIBUTES_AIRPURIFIER_COMMON

Definition at line 149 of file fan.py.

◆ AVAILABLE_ATTRIBUTES_AIRPURIFIER_V3

dictionary homeassistant.components.xiaomi_miio.fan.AVAILABLE_ATTRIBUTES_AIRPURIFIER_V3
Initial value:
1 = {
2  # Common set isn't used here. It's a very basic version of the device.
3  ATTR_SLEEP_TIME: "sleep_time",
4  ATTR_SLEEP_LEARN_COUNT: "sleep_mode_learn_count",
5  ATTR_EXTRA_FEATURES: "extra_features",
6  ATTR_USE_TIME: "use_time",
7  ATTR_BUTTON_PRESSED: "button_pressed",
8 }

Definition at line 151 of file fan.py.

◆ DATA_KEY

string homeassistant.components.xiaomi_miio.fan.DATA_KEY = "fan.xiaomi_miio"

Definition at line 101 of file fan.py.

◆ FAN_DIRECTIONS_MAP

dictionary homeassistant.components.xiaomi_miio.fan.FAN_DIRECTIONS_MAP
Initial value:
1 = {
2  "forward": "right",
3  "reverse": "left",
4 }

Definition at line 199 of file fan.py.

◆ PRESET_MODES_AIRFRESH

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRFRESH = ["Auto", "Interval"]

Definition at line 182 of file fan.py.

◆ PRESET_MODES_AIRFRESH_A1

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRFRESH_A1 = ["Auto", "Sleep", "Favorite"]

Definition at line 183 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER = ["Auto", "Silent", "Favorite", "Idle"]

Definition at line 165 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_2S

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_2S = ["Auto", "Silent", "Favorite"]

Definition at line 170 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_3C

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_3C = ["Auto", "Silent", "Favorite"]

Definition at line 171 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_4_LITE

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_4_LITE = ["Auto", "Silent", "Favorite"]

Definition at line 166 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_MIOT

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_MIOT = ["Auto", "Silent", "Favorite", "Fan"]

Definition at line 167 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_PRO

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_PRO = ["Auto", "Silent", "Favorite"]

Definition at line 168 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_PRO_V7

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_PRO_V7 = PRESET_MODES_AIRPURIFIER_PRO

Definition at line 169 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_V3

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_V3
Initial value:
1 = [
2  "Auto",
3  "Silent",
4  "Favorite",
5  "Idle",
6  "Medium",
7  "High",
8  "Strong",
9 ]

Definition at line 173 of file fan.py.

◆ PRESET_MODES_AIRPURIFIER_ZA1

list homeassistant.components.xiaomi_miio.fan.PRESET_MODES_AIRPURIFIER_ZA1 = ["Auto", "Silent", "Favorite"]

Definition at line 172 of file fan.py.

◆ SERVICE_SCHEMA_EXTRA_FEATURES

homeassistant.components.xiaomi_miio.fan.SERVICE_SCHEMA_EXTRA_FEATURES
Initial value:
1 = AIRPURIFIER_SERVICE_SCHEMA.extend(
2  {vol.Required(ATTR_FEATURES): cv.positive_int}
3 )

Definition at line 187 of file fan.py.

◆ SERVICE_TO_METHOD

dictionary homeassistant.components.xiaomi_miio.fan.SERVICE_TO_METHOD
Initial value:
1 = {
2  SERVICE_RESET_FILTER: ServiceMethodDetails(method="async_reset_filter"),
3  SERVICE_SET_EXTRA_FEATURES: ServiceMethodDetails(
4  method="async_set_extra_features",
5  schema=SERVICE_SCHEMA_EXTRA_FEATURES,
6  ),
7 }

Definition at line 191 of file fan.py.