homeassistant.components.random.config_flow Namespace Reference

Classes
class	_FlowType
class	RandomConfigFlowHandler

Functions
vol.Schema	_generate_schema (str domain, _FlowType flow_type)
None	_validate_unit (dict[str, Any] options)
str	choose_options_step (dict[str, Any] options)
Callable[[SchemaCommonFlowHandler, dict[str, Any]], Coroutine[Any, Any, dict[str, Any]],]	validate_user_input (str entity_type)

Variables
dictionary	CONFIG_FLOW
dictionary	OPTIONS_FLOW
list	RANDOM_TYPES

Detailed Description

Config flow for Random helper.

Function Documentation

_generate_schema()

vol.Schema homeassistant.components.random.config_flow._generate_schema ( str  domain, _FlowType  flow_type  )

private

Generate schema.

Definition at line 43 of file config_flow.py.

_validate_unit()

None homeassistant.components.random.config_flow._validate_unit ( dict[str, Any]  options )

private

Validate unit of measurement.

Definition at line 102 of file config_flow.py.

choose_options_step()

str homeassistant.components.random.config_flow.choose_options_step

(

dict[str, Any]

options

)

Return next step_id for options flow according to entity_type.

Definition at line 97 of file config_flow.py.

validate_user_input()

Callable[ [SchemaCommonFlowHandler, dict[str, Any]], Coroutine[Any, Any, dict[str, Any]], ] homeassistant.components.random.config_flow.validate_user_input

(

str

entity_type

)

Do post validation of user input.

For sensors: Validate unit of measurement.

Definition at line 124 of file config_flow.py.

Variable Documentation

CONFIG_FLOW

dictionary homeassistant.components.random.config_flow.CONFIG_FLOW

Initial value:

=  {
    "user": SchemaFlowMenuStep(RANDOM_TYPES),
    Platform.BINARY_SENSOR: SchemaFlowFormStep(
        _generate_schema(Platform.BINARY_SENSOR, _FlowType.CONFIG),
        validate_user_input=validate_user_input(Platform.BINARY_SENSOR),
    ),
    Platform.SENSOR: SchemaFlowFormStep(
        _generate_schema(Platform.SENSOR, _FlowType.CONFIG),
        validate_user_input=validate_user_input(Platform.SENSOR),
    ),
}

Definition at line 152 of file config_flow.py.

OPTIONS_FLOW

dictionary homeassistant.components.random.config_flow.OPTIONS_FLOW

Initial value:

=  {
    "init": SchemaFlowFormStep(next_step=choose_options_step),
    Platform.BINARY_SENSOR: SchemaFlowFormStep(
        _generate_schema(Platform.BINARY_SENSOR, _FlowType.OPTION),
        validate_user_input=validate_user_input(Platform.BINARY_SENSOR),
    ),
    Platform.SENSOR: SchemaFlowFormStep(
        _generate_schema(Platform.SENSOR, _FlowType.OPTION),
        validate_user_input=validate_user_input(Platform.SENSOR),
    ),
}

Definition at line 165 of file config_flow.py.

RANDOM_TYPES

list homeassistant.components.random.config_flow.RANDOM_TYPES

Initial value:

=  [
    Platform.BINARY_SENSOR.value,
    Platform.SENSOR.value,
]

Definition at line 147 of file config_flow.py.