homeassistant.components.statistics.config_flow Namespace Reference

Classes
class	StatisticsConfigFlowHandler

Functions
vol.Schema	get_state_characteristics (SchemaCommonFlowHandler handler)
dict[str, Any]	validate_options (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
None	ws_start_preview (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
dictionary	CONFIG_FLOW
	DATA_SCHEMA_OPTIONS
	DATA_SCHEMA_SETUP
dictionary	OPTIONS_FLOW

Detailed Description

Config flow for statistics.

Function Documentation

get_state_characteristics()

vol.Schema homeassistant.components.statistics.config_flow.get_state_characteristics

(

SchemaCommonFlowHandler

handler

)

Return schema with state characteristics.

Definition at line 54 of file config_flow.py.

validate_options()

dict[str, Any] homeassistant.components.statistics.config_flow.validate_options	(	SchemaCommonFlowHandler	handler,
		dict[str, Any]	user_input
	)

Validate options selected.

Definition at line 78 of file config_flow.py.

ws_start_preview()

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

Generate a preview.

Definition at line 173 of file config_flow.py.

Variable Documentation

CONFIG_FLOW

dictionary homeassistant.components.statistics.config_flow.CONFIG_FLOW

Initial value:

=  {
    "user": SchemaFlowFormStep(
        schema=DATA_SCHEMA_SETUP,
        next_step="state_characteristic",
    ),
    "state_characteristic": SchemaFlowFormStep(
        schema=get_state_characteristics, next_step="options"
    ),
    "options": SchemaFlowFormStep(
        schema=DATA_SCHEMA_OPTIONS,
        validate_user_input=validate_options,
        preview="statistics",
    ),
}

Definition at line 125 of file config_flow.py.

DATA_SCHEMA_OPTIONS

homeassistant.components.statistics.config_flow.DATA_SCHEMA_OPTIONS

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_SAMPLES_MAX_BUFFER_SIZE): NumberSelector(
            NumberSelectorConfig(min=0, step=1, mode=NumberSelectorMode.BOX)
        ),
        vol.Optional(CONF_MAX_AGE): DurationSelector(
            DurationSelectorConfig(enable_day=False, allow_negative=False)
        ),
        vol.Optional(CONF_KEEP_LAST_SAMPLE, default=False): BooleanSelector(),
        vol.Optional(CONF_PERCENTILE, default=50): NumberSelector(
            NumberSelectorConfig(min=1, max=99, step=1, mode=NumberSelectorMode.BOX)
        ),
        vol.Optional(CONF_PRECISION, default=DEFAULT_PRECISION): NumberSelector(
            NumberSelectorConfig(min=0, step=1, mode=NumberSelectorMode.BOX)
        ),
    }
)

Definition at line 107 of file config_flow.py.

DATA_SCHEMA_SETUP

homeassistant.components.statistics.config_flow.DATA_SCHEMA_SETUP

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME, default=DEFAULT_NAME): TextSelector(),
        vol.Required(CONF_ENTITY_ID): EntitySelector(
            EntitySelectorConfig(domain=[BINARY_SENSOR_DOMAIN, SENSOR_DOMAIN])
        ),
    }
)

Definition at line 99 of file config_flow.py.

OPTIONS_FLOW

dictionary homeassistant.components.statistics.config_flow.OPTIONS_FLOW

Initial value:

=  {
    "init": SchemaFlowFormStep(
        DATA_SCHEMA_OPTIONS,
        validate_user_input=validate_options,
        preview="statistics",
    ),
}

Definition at line 139 of file config_flow.py.