Config Flow with Custom Component

I’m working on a component that’s not quite ready for prime time (keeping it in custom_components for now) but I want to implement Config Flow for it.

The documentation states the component has to be added to config_entries.FLOWS which is part of HA.

Is there a way to make this work?

1 Like

I’m also interested in getting the answer.

I’m also in process of developing custom component - it will be kept in custom_components folder. I will try to develop it with minimal scope.

Found answer by myself. So in short: CUSTOM_COMPONENTS don’t use config_flow (as for HA 0.93.2).
Usage of config flow is defined in file ( and is hard coded for now for closed list of compoenents. So unless custom_component doesn’t overwrite one of those components - it will not be able (AFAIK) to run

I am interested to know what the future plans for config_flow with custom components is.
The docs say:

This option is currently only available for built-in components.

which makes it sound like there are plans to enable it for custom components. Does anyone have any details on this?

PR was merged to allow this, latest version works.

1 Like

Has anyone managed to make this work by following the documentation? I am struggling at the moment, and would love to see an example of a very simple config flow

There is a lyric component that is waiting to be merged that I’ve been using as a custom component with success.

Thanks kylerw, I think I am up and running now.


Any idea of when the native Lyric will be added? I’d like to avoid doing this via custom components, if I can help it.

If you don’t have the final version in the pipeline yet, what form will the final implementation take? Will it be like the “cover: myq” platform integration for my garage door opener?


  • platform: myq
    username: !secret myq_user
    password: !secret myq_pass
    type: liftmaster