Home AssistantHome AssistantContributors

    ↑↓ to moveEnter to openEsc to close

    Config flow

    The steps in the UI that set up an integration and create a config entry.

    In code
    ConfigFlowconfig_flow.pyasync_step_user
    Also
    config flows

    A config flow asks the user for what it needs, like a host and a password, checks it, and creates a config entry. It sets a unique ID, so the same device can't be added twice.

    A config flow can also start by itself, when a device is discovered. The user then only confirms.

    New integrations that connect to a device or service are set up with a config flow, not with YAML.

    Related terms

    • Config entryOne set-up instance of an integration, like one Hue bridge, with the configuration Home Assistant stores for it.
    • Options flowThe steps in the UI that change the options of an existing config entry, like how often it polls.
    • ReauthenticationA flow that asks the user for new credentials when a config entry can no longer log in, without setting it up again.
    • Reconfigure flowA flow that changes the settings of a config entry, like its host, without removing and adding it again.
    • DiscoveryFinding devices and services, like on the network or over Bluetooth, so Home Assistant can offer to set them up.