homeassistant.config_entries.OptionsFlow Class Reference

Inherits homeassistant.config_entries.ConfigEntryBaseFlow.

Inherited by homeassistant.components.airnow.config_flow.AirNowOptionsFlowHandler, homeassistant.components.alarmdecoder.config_flow.AlarmDecoderOptionsFlowHandler, homeassistant.components.analytics_insights.config_flow.HomeassistantAnalyticsOptionsFlowHandler, homeassistant.components.androidtv.config_flow.OptionsFlowHandler, homeassistant.components.androidtv_remote.config_flow.AndroidTVRemoteOptionsFlowHandler, homeassistant.components.anthropic.config_flow.AnthropicOptionsFlow, homeassistant.components.axis.config_flow.AxisOptionsFlowHandler, homeassistant.components.bmw_connected_drive.config_flow.BMWOptionsFlow, homeassistant.components.canary.config_flow.CanaryOptionsFlowHandler, homeassistant.components.cast.config_flow.CastOptionsFlowHandler, homeassistant.components.coinbase.config_flow.OptionsFlowHandler, homeassistant.components.control4.config_flow.OptionsFlowHandler, homeassistant.components.crownstone.config_flow.CrownstoneOptionsFlowHandler, homeassistant.components.deconz.config_flow.DeconzOptionsFlowHandler, homeassistant.components.demo.config_flow.OptionsFlowHandler, homeassistant.components.denonavr.config_flow.OptionsFlowHandler, homeassistant.components.dlna_dmr.config_flow.DlnaDmrOptionsFlowHandler, homeassistant.components.dnsip.config_flow.DnsIPOptionsFlowHandler, homeassistant.components.doorbird.config_flow.OptionsFlowHandler, homeassistant.components.dsmr.config_flow.DSMROptionFlowHandler, homeassistant.components.elevenlabs.config_flow.ElevenLabsOptionsFlow, homeassistant.components.emoncms.config_flow.EmoncmsOptionsFlow, homeassistant.components.enphase_envoy.config_flow.EnvoyOptionsFlowHandler, homeassistant.components.esphome.config_flow.OptionsFlowHandler, homeassistant.components.ezviz.config_flow.EzvizOptionsFlowHandler, homeassistant.components.feedreader.config_flow.FeedReaderOptionsFlowHandler, homeassistant.components.file.config_flow.FileOptionsFlowHandler, homeassistant.components.flux_led.config_flow.FluxLedOptionsFlow, homeassistant.components.forecast_solar.config_flow.ForecastSolarOptionFlowHandler, homeassistant.components.forked_daapd.config_flow.ForkedDaapdOptionsFlowHandler, homeassistant.components.fritz.config_flow.FritzBoxToolsOptionsFlowHandler, homeassistant.components.fritzbox_callmonitor.config_flow.FritzBoxCallMonitorOptionsFlowHandler, homeassistant.components.generic.config_flow.GenericOptionsFlowHandler, homeassistant.components.github.config_flow.OptionsFlowHandler, homeassistant.components.google.config_flow.OptionsFlowHandler, homeassistant.components.google_assistant_sdk.config_flow.OptionsFlowHandler, homeassistant.components.google_cloud.config_flow.GoogleCloudOptionsFlowHandler, homeassistant.components.google_generative_ai_conversation.config_flow.GoogleGenerativeAIOptionsFlow, homeassistant.components.google_travel_time.config_flow.GoogleOptionsFlow, homeassistant.components.harmony.config_flow.OptionsFlowHandler, homeassistant.components.here_travel_time.config_flow.HERETravelTimeOptionsFlow, homeassistant.components.hive.config_flow.HiveOptionsFlowHandler, homeassistant.components.homeassistant_green.config_flow.HomeAssistantGreenOptionsFlow, homeassistant.components.homeassistant_hardware.firmware_config_flow.BaseFirmwareOptionsFlow, homeassistant.components.homeassistant_hardware.silabs_multiprotocol_addon.OptionsFlowHandler, homeassistant.components.homeassistant_yellow.config_flow.BaseHomeAssistantYellowOptionsFlow, homeassistant.components.homekit.config_flow.OptionsFlowHandler, homeassistant.components.honeywell.config_flow.HoneywellOptionsFlowHandler, homeassistant.components.huawei_lte.config_flow.OptionsFlowHandler, homeassistant.components.hue.config_flow.HueV1OptionsFlowHandler, homeassistant.components.hue.config_flow.HueV2OptionsFlowHandler, homeassistant.components.hvv_departures.config_flow.OptionsFlowHandler, homeassistant.components.hyperion.config_flow.HyperionOptionsFlow, homeassistant.components.ibeacon.config_flow.IBeaconOptionsFlow, homeassistant.components.imap.config_flow.ImapOptionsFlow, homeassistant.components.islamic_prayer_times.config_flow.IslamicPrayerOptionsFlowHandler, homeassistant.components.iss.config_flow.OptionsFlowHandler, homeassistant.components.isy994.config_flow.OptionsFlowHandler, homeassistant.components.jellyfin.config_flow.OptionsFlowHandler, homeassistant.components.jewish_calendar.config_flow.JewishCalendarOptionsFlowHandler, homeassistant.components.keenetic_ndms2.config_flow.KeeneticOptionsFlowHandler, homeassistant.components.kitchen_sink.config_flow.OptionsFlowHandler, homeassistant.components.kmtronic.config_flow.KMTronicOptionsFlow, homeassistant.components.knx.config_flow.KNXOptionsFlow, homeassistant.components.konnected.config_flow.OptionsFlowHandler, homeassistant.components.kraken.config_flow.KrakenOptionsFlowHandler, homeassistant.components.lamarzocco.config_flow.LmOptionsFlowHandler, homeassistant.components.lastfm.config_flow.LastFmOptionsFlowHandler, homeassistant.components.litejet.config_flow.LiteJetOptionsFlow, homeassistant.components.met.config_flow.MetOptionsFlowHandler, homeassistant.components.mikrotik.config_flow.MikrotikOptionsFlowHandler, homeassistant.components.mjpeg.config_flow.MJPEGOptionsFlowHandler, homeassistant.components.monoprice.config_flow.MonopriceOptionsFlowHandler, homeassistant.components.mopeka.config_flow.MopekaOptionsFlow, homeassistant.components.motion_blinds.config_flow.OptionsFlowHandler, homeassistant.components.motionblinds_ble.config_flow.OptionsFlowHandler, homeassistant.components.motioneye.config_flow.MotionEyeOptionsFlow, homeassistant.components.mqtt.config_flow.MQTTOptionsFlowHandler, homeassistant.components.netatmo.config_flow.NetatmoOptionsFlowHandler, homeassistant.components.netgear.config_flow.OptionsFlowHandler, homeassistant.components.nina.config_flow.OptionsFlowHandler, homeassistant.components.nmap_tracker.config_flow.OptionsFlowHandler, homeassistant.components.nobo_hub.config_flow.OptionsFlowHandler, homeassistant.components.nut.config_flow.OptionsFlowHandler, homeassistant.components.ollama.config_flow.OllamaOptionsFlow, homeassistant.components.omnilogic.config_flow.OptionsFlowHandler, homeassistant.components.onewire.config_flow.OnewireOptionsFlowHandler, homeassistant.components.onkyo.config_flow.OnkyoOptionsFlowHandler, homeassistant.components.onvif.config_flow.OnvifOptionsFlowHandler, homeassistant.components.openai_conversation.config_flow.OpenAIOptionsFlow, homeassistant.components.opensky.config_flow.OpenSkyOptionsFlowHandler, homeassistant.components.opentherm_gw.config_flow.OpenThermGwOptionsFlow, homeassistant.components.openweathermap.config_flow.OpenWeatherMapOptionsFlow, homeassistant.components.ping.config_flow.OptionsFlowHandler, homeassistant.components.plaato.config_flow.PlaatoOptionsFlowHandler, homeassistant.components.plex.config_flow.PlexOptionsFlowHandler, homeassistant.components.proximity.config_flow.ProximityOptionsFlow, homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler, homeassistant.components.pvpc_hourly_pricing.config_flow.PVPCOptionsFlowHandler, homeassistant.components.rachio.config_flow.OptionsFlowHandler, homeassistant.components.rainbird.config_flow.RainBirdOptionsFlowHandler, homeassistant.components.rainmachine.config_flow.RainMachineOptionsFlowHandler, homeassistant.components.recollect_waste.config_flow.RecollectWasteOptionsFlowHandler, homeassistant.components.reolink.config_flow.ReolinkOptionsFlowHandler, homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow, homeassistant.components.risco.config_flow.RiscoOptionsFlowHandler, homeassistant.components.roborock.config_flow.RoborockOptionsFlowHandler, homeassistant.components.roku.config_flow.RokuOptionsFlowHandler, homeassistant.components.roomba.config_flow.RoombaOptionsFlowHandler, homeassistant.components.rtsp_to_webrtc.config_flow.OptionsFlowHandler, homeassistant.components.screenlogic.config_flow.ScreenLogicOptionsFlowHandler, homeassistant.components.sentry.config_flow.SentryOptionsFlow, homeassistant.components.shelly.config_flow.OptionsFlowHandler, homeassistant.components.sia.config_flow.SIAOptionsFlowHandler, homeassistant.components.simplisafe.config_flow.SimpliSafeOptionsFlowHandler, homeassistant.components.somfy_mylink.config_flow.OptionsFlowHandler, homeassistant.components.sonarr.config_flow.SonarrOptionsFlowHandler, homeassistant.components.speedtestdotnet.config_flow.SpeedTestOptionsFlowHandler, homeassistant.components.sql.config_flow.SQLOptionsFlowHandler, homeassistant.components.steam_online.config_flow.SteamOptionsFlowHandler, homeassistant.components.subaru.config_flow.OptionsFlowHandler, homeassistant.components.switchbot.config_flow.SwitchbotOptionsFlowHandler, homeassistant.components.synology_dsm.config_flow.SynologyDSMOptionsFlowHandler, homeassistant.components.tado.config_flow.OptionsFlowHandler, homeassistant.components.tankerkoenig.config_flow.OptionsFlowHandler, homeassistant.components.tomorrowio.config_flow.TomorrowioOptionsConfigFlow, homeassistant.components.totalconnect.config_flow.TotalConnectOptionsFlowHandler, homeassistant.components.trafikverket_train.config_flow.TVTrainOptionsFlowHandler, homeassistant.components.transmission.config_flow.TransmissionOptionsFlowHandler, homeassistant.components.unifi.config_flow.UnifiOptionsFlowHandler, homeassistant.components.unifiprotect.config_flow.OptionsFlowHandler, homeassistant.components.upcloud.config_flow.UpCloudOptionsFlow, homeassistant.components.upnp.config_flow.UpnpOptionsFlowHandler, homeassistant.components.vera.config_flow.OptionsFlowHandler, homeassistant.components.verisure.config_flow.VerisureOptionsFlowHandler, homeassistant.components.vizio.config_flow.VizioOptionsConfigFlow, homeassistant.components.vodafone_station.config_flow.VodafoneStationOptionsFlowHandler, homeassistant.components.voip.config_flow.VoipOptionsFlowHandler, homeassistant.components.watttime.config_flow.WattTimeOptionsFlowHandler, homeassistant.components.waze_travel_time.config_flow.WazeOptionsFlow, homeassistant.components.webostv.config_flow.OptionsFlowHandler, homeassistant.components.wemo.config_flow.WemoOptionsFlow, homeassistant.components.wiffi.config_flow.OptionsFlowHandler, homeassistant.components.wled.config_flow.WLEDOptionsFlowHandler, homeassistant.components.workday.config_flow.WorkdayOptionsFlowHandler, homeassistant.components.ws66i.config_flow.Ws66iOptionsFlowHandler, homeassistant.components.xiaomi_miio.config_flow.OptionsFlowHandler, homeassistant.components.yale_smart_alarm.config_flow.YaleOptionsFlowHandler, homeassistant.components.yalexs_ble.config_flow.YaleXSBLEOptionsFlowHandler, homeassistant.components.yeelight.config_flow.OptionsFlowHandler, homeassistant.components.youtube.config_flow.YouTubeOptionsFlowHandler, homeassistant.components.zha.config_flow.ZhaOptionsFlowHandler, homeassistant.components.zwave_js.config_flow.OptionsFlowHandler, homeassistant.config_entries.OptionsFlowWithConfigEntry, and homeassistant.helpers.schema_config_entry_flow.SchemaOptionsFlowHandler.

Collaboration diagram for homeassistant.config_entries.OptionsFlow:

Public Member Functions
ConfigEntry	config_entry (self)
None	config_entry (self, ConfigEntry value)
Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
vol.Schema	add_suggested_values_to_schema (self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
_FlowResultT	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
None	async_cancel_progress_task (self)
_FlowResultT	async_create_entry (self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step (self, *str|None step_id=None, str url, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_external_step_done (self, *str next_step_id)
asyncio.Task[Any]|None	async_get_progress_task (self)
None	async_remove (self)
None	async_set_progress_task (self, asyncio.Task[Any] progress_task)
_FlowResultT	async_show_form (self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
_FlowResultT	async_show_menu (self, *str|None step_id=None, Container[str] menu_options, Mapping[str, str]|None description_placeholders=None)
_FlowResultT	async_show_progress (self, *str|None step_id=None, str progress_action, Mapping[str, str]|None description_placeholders=None, asyncio.Task[Any]|None progress_task=None)
_FlowResultT	async_show_progress_done (self, *str next_step_id)
bool	show_advanced_options (self)
str|None	source (self)

Private Member Functions
None	_async_abort_entries_match (self, dict[str, Any]|None match_dict=None)
str	_config_entry_id (self)

Private Attributes
	_config_entry

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress
Static Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	Any
bool	deprecated_show_progress = False
	HomeAssistant
string	init_step = "init"
int	MINOR_VERSION = 1
	None
	str
int	VERSION = 1

Detailed Description

Base class for config options flows.

Definition at line 3091 of file config_entries.py.

Member Function Documentation

_async_abort_entries_match()

None homeassistant.config_entries.OptionsFlow._async_abort_entries_match (   self, dict[str, Any] | None   match_dict = None  )

private

Abort if another current entry matches all data.

Requires `already_configured` in strings.json in user visible flows.

Definition at line 3100 of file config_entries.py.

_config_entry_id()

str homeassistant.config_entries.OptionsFlow._config_entry_id (   self )

private

Return config entry id.

Please note that this is not available inside `__init__` method, and
can only be referenced after initialisation.

Definition at line 3119 of file config_entries.py.

config_entry() [1/2]

ConfigEntry homeassistant.config_entries.OptionsFlow.config_entry

(

self

)

Return the config entry linked to the current options flow.

Please note that this is not available inside `__init__` method, and
can only be referenced after initialisation.

Definition at line 3133 of file config_entries.py.

config_entry() [2/2]

None homeassistant.config_entries.OptionsFlow.config_entry	(		self,
		ConfigEntry	value
	)

Set the config entry value.

Definition at line 3148 of file config_entries.py.

Member Data Documentation

_config_entry

homeassistant.config_entries.OptionsFlow._config_entry

private

Definition at line 3157 of file config_entries.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/config_entries.py