Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.group.fan Namespace Reference

Classes

class  FanGroup
 

Functions

FanGroup async_create_preview_fan (HomeAssistant hass, str name, dict[str, Any] validated_config)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string DEFAULT_NAME = "Fan Group"
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA
 
dictionary SUPPORTED_FLAGS
 

Detailed Description

Platform allowing several fans to be grouped into one fan.

Function Documentation

◆ async_create_preview_fan()

FanGroup homeassistant.components.group.fan.async_create_preview_fan ( HomeAssistant  hass,
str  name,
dict[str, Any]   validated_config 
)
Create a preview sensor.

Definition at line 97 of file fan.py.

◆ async_setup_entry()

None homeassistant.components.group.fan.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Initialize Fan Group config entry.

Definition at line 82 of file fan.py.

◆ async_setup_platform()

None homeassistant.components.group.fan.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Fan Group platform.

Definition at line 70 of file fan.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 67 of file fan.py.

◆ DEFAULT_NAME

string homeassistant.components.group.fan.DEFAULT_NAME = "Fan Group"

Definition at line 54 of file fan.py.

◆ PARALLEL_UPDATES

int homeassistant.components.group.fan.PARALLEL_UPDATES = 0

Definition at line 57 of file fan.py.

◆ PLATFORM_SCHEMA

homeassistant.components.group.fan.PLATFORM_SCHEMA
Initial value:
1 = FAN_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_ENTITIES): cv.entities_domain(FAN_DOMAIN),
4  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
5  vol.Optional(CONF_UNIQUE_ID): cv.string,
6  }
7 )

Definition at line 59 of file fan.py.

◆ SUPPORTED_FLAGS

dictionary homeassistant.components.group.fan.SUPPORTED_FLAGS
Initial value:
1 = {
2  FanEntityFeature.SET_SPEED,
3  FanEntityFeature.DIRECTION,
4  FanEntityFeature.OSCILLATE,
5  FanEntityFeature.TURN_OFF,
6  FanEntityFeature.TURN_ON,
7 }

Definition at line 46 of file fan.py.