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

Classes

class  ConfigFlowHandler
 

Functions

dict[str, Any] _validate_config (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
 

Variables

dictionary CONFIG_FLOW
 
 CONFIG_SCHEMA
 
list METER_TYPES
 
dictionary OPTIONS_FLOW
 
 OPTIONS_SCHEMA
 

Detailed Description

Config flow for Utility Meter integration.

Function Documentation

◆ _validate_config()

dict[str, Any] homeassistant.components.utility_meter.config_flow._validate_config ( SchemaCommonFlowHandler  handler,
dict[str, Any]   user_input 
)
private
Validate config.

Definition at line 53 of file config_flow.py.

Variable Documentation

◆ CONFIG_FLOW

dictionary homeassistant.components.utility_meter.config_flow.CONFIG_FLOW
Initial value:
1 = {
2  "user": SchemaFlowFormStep(CONFIG_SCHEMA, validate_user_input=_validate_config)
3 }

Definition at line 119 of file config_flow.py.

◆ CONFIG_SCHEMA

homeassistant.components.utility_meter.config_flow.CONFIG_SCHEMA

Definition at line 80 of file config_flow.py.

◆ METER_TYPES

list homeassistant.components.utility_meter.config_flow.METER_TYPES
Initial value:
1 = [
2  "none",
3  QUARTER_HOURLY,
4  HOURLY,
5  DAILY,
6  WEEKLY,
7  MONTHLY,
8  BIMONTHLY,
9  QUARTERLY,
10  YEARLY,
11 ]

Definition at line 40 of file config_flow.py.

◆ OPTIONS_FLOW

dictionary homeassistant.components.utility_meter.config_flow.OPTIONS_FLOW
Initial value:
1 = {
2  "init": SchemaFlowFormStep(OPTIONS_SCHEMA),
3 }

Definition at line 123 of file config_flow.py.

◆ OPTIONS_SCHEMA

homeassistant.components.utility_meter.config_flow.OPTIONS_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_SOURCE_SENSOR): selector.EntitySelector(
4  selector.EntitySelectorConfig(domain=SENSOR_DOMAIN),
5  ),
6  vol.Required(
7  CONF_METER_PERIODICALLY_RESETTING,
8  ): selector.BooleanSelector(),
9  vol.Optional(
10  CONF_SENSOR_ALWAYS_AVAILABLE,
11  default=False,
12  ): selector.BooleanSelector(),
13  }
14 )

Definition at line 65 of file config_flow.py.