homeassistant.components.group.config_flow Namespace Reference

Classes
class	GroupConfigFlowHandler

Functions
None	_async_hide_members (HomeAssistant hass, list[str] members, er.RegistryEntryHider|None hidden_by)
vol.Schema	basic_group_config_schema (str|list[str] domain)
vol.Schema	basic_group_options_schema (str|list[str] domain, SchemaCommonFlowHandler|None handler)
vol.Schema	binary_sensor_options_schema (SchemaCommonFlowHandler|None handler)
str	choose_options_step (dict[str, Any] options)
vol.Schema	light_switch_options_schema (str domain, SchemaCommonFlowHandler|None handler)
vol.Schema	sensor_options_schema (str domain, SchemaCommonFlowHandler|None handler)
Callable[[SchemaCommonFlowHandler, dict[str, Any]], Coroutine[Any, Any, dict[str, Any]]]	set_group_type (str group_type)
None	ws_start_preview (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
list	_STATISTIC_MEASURES
vol.Schema	BINARY_SENSOR_CONFIG_SCHEMA
dictionary	CONFIG_FLOW
list	GROUP_TYPES
dictionary	OPTIONS_FLOW
dictionary	SENSOR_CONFIG_EXTENDS
vol.Schema	SENSOR_CONFIG_SCHEMA
dictionary	SENSOR_OPTIONS

Detailed Description

Config flow for Group integration.

Function Documentation

_async_hide_members()

None homeassistant.components.group.config_flow._async_hide_members ( HomeAssistant  hass, list[str]  members, er.RegistryEntryHider | None   hidden_by  )

private

Hide or unhide group members.

Definition at line 363 of file config_flow.py.

basic_group_config_schema()

vol.Schema homeassistant.components.group.config_flow.basic_group_config_schema

(

str | list[str]

domain

)

Generate config schema.

Definition at line 75 of file config_flow.py.

basic_group_options_schema()

vol.Schema homeassistant.components.group.config_flow.basic_group_options_schema	(	str | list[str]	domain,
		SchemaCommonFlowHandler | None	handler
	)

Generate options schema.

Definition at line 52 of file config_flow.py.

binary_sensor_options_schema()

vol.Schema homeassistant.components.group.config_flow.binary_sensor_options_schema

(

SchemaCommonFlowHandler | None

handler

)

Generate options schema.

Definition at line 88 of file config_flow.py.

choose_options_step()

str homeassistant.components.group.config_flow.choose_options_step

(

dict[str, Any]

options

)

Return next step_id for options flow according to group_type.

Definition at line 164 of file config_flow.py.

light_switch_options_schema()

vol.Schema homeassistant.components.group.config_flow.light_switch_options_schema	(	str	domain,
		SchemaCommonFlowHandler | None	handler
	)

Generate options schema.

Definition at line 136 of file config_flow.py.

sensor_options_schema()

vol.Schema homeassistant.components.group.config_flow.sensor_options_schema	(	str	domain,
		SchemaCommonFlowHandler | None	handler
	)

Generate options schema.

Definition at line 122 of file config_flow.py.

set_group_type()

Callable[ [SchemaCommonFlowHandler, dict[str, Any]], Coroutine[Any, Any, dict[str, Any]] ] homeassistant.components.group.config_flow.set_group_type

(

str

group_type

)

Set group type.

Definition at line 169 of file config_flow.py.

ws_start_preview()

None homeassistant.components.group.config_flow.ws_start_preview	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Generate a preview.

Definition at line 385 of file config_flow.py.

Variable Documentation

_STATISTIC_MEASURES

list homeassistant.components.group.config_flow._STATISTIC_MEASURES

private

Initial value:

=  [
    "last",
    "max",
    "mean",
    "median",
    "min",
    "product",
    "range",
    "stdev",
    "sum",
]

Definition at line 39 of file config_flow.py.

BINARY_SENSOR_CONFIG_SCHEMA

vol.Schema homeassistant.components.group.config_flow.BINARY_SENSOR_CONFIG_SCHEMA

Initial value:

=  basic_group_config_schema("binary_sensor").extend(
    {
        vol.Required(CONF_ALL, default=False): selector.BooleanSelector(),
    }
)

Definition at line 99 of file config_flow.py.

CONFIG_FLOW

dictionary homeassistant.components.group.config_flow.CONFIG_FLOW

Definition at line 185 of file config_flow.py.

GROUP_TYPES

list homeassistant.components.group.config_flow.GROUP_TYPES

Initial value:

=  [
    "binary_sensor",
    "button",
    "cover",
    "event",
    "fan",
    "light",
    "lock",
    "media_player",
    "notify",
    "sensor",
    "switch",
]

Definition at line 149 of file config_flow.py.

OPTIONS_FLOW

dictionary homeassistant.components.group.config_flow.OPTIONS_FLOW

Definition at line 245 of file config_flow.py.

SENSOR_CONFIG_EXTENDS

dictionary homeassistant.components.group.config_flow.SENSOR_CONFIG_EXTENDS

Initial value:

=  {
    vol.Required(CONF_TYPE): selector.SelectSelector(
        selector.SelectSelectorConfig(
            options=_STATISTIC_MEASURES, translation_key=CONF_TYPE
        ),
    ),
}

Definition at line 105 of file config_flow.py.

SENSOR_CONFIG_SCHEMA

vol.Schema homeassistant.components.group.config_flow.SENSOR_CONFIG_SCHEMA

Initial value:

=  basic_group_config_schema(
    ["sensor", "number", "input_number"]
).extend(SENSOR_CONFIG_EXTENDS)

Definition at line 131 of file config_flow.py.

SENSOR_OPTIONS

dictionary homeassistant.components.group.config_flow.SENSOR_OPTIONS

Initial value:

=  {
    vol.Optional(CONF_IGNORE_NON_NUMERIC, default=False): selector.BooleanSelector(),
    vol.Required(CONF_TYPE): selector.SelectSelector(
        selector.SelectSelectorConfig(
            options=_STATISTIC_MEASURES, translation_key=CONF_TYPE
        ),
    ),
}

Definition at line 112 of file config_flow.py.