Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.time_date.config_flow Namespace Reference

Classes

class  TimeDateConfigFlowHandler
 

Functions

dict[str, Any] validate_input (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
 
None ws_start_preview (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
dictionary CONFIG_FLOW
 
 USER_SCHEMA
 

Detailed Description

Adds config flow for Time & Date integration.

Function Documentation

◆ validate_input()

dict[str, Any] homeassistant.components.time_date.config_flow.validate_input ( SchemaCommonFlowHandler  handler,
dict[str, Any]   user_input 
)
Validate rest setup.

Definition at line 47 of file config_flow.py.

◆ ws_start_preview()

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

Definition at line 94 of file config_flow.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.time_date.config_flow._LOGGER = logging.getLogger(__name__)
private

Definition at line 32 of file config_flow.py.

◆ CONFIG_FLOW

dictionary homeassistant.components.time_date.config_flow.CONFIG_FLOW
Initial value:
1 = {
2  "user": SchemaFlowFormStep(
3  schema=USER_SCHEMA,
4  preview=DOMAIN,
5  validate_user_input=validate_input,
6  )
7 }

Definition at line 57 of file config_flow.py.

◆ USER_SCHEMA

homeassistant.components.time_date.config_flow.USER_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_DISPLAY_OPTIONS): SelectSelector(
4  SelectSelectorConfig(
5  options=OPTION_TYPES,
6  mode=SelectSelectorMode.DROPDOWN,
7  translation_key="display_options",
8  )
9  ),
10  }
11 )

Definition at line 34 of file config_flow.py.