Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hyperion.config_flow.HyperionConfigFlow Class Reference
Inheritance diagram for homeassistant.components.hyperion.config_flow.HyperionConfigFlow:
[legend]
Collaboration diagram for homeassistant.components.hyperion.config_flow.HyperionConfigFlow:
[legend]

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_auth (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_create_token (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_create_token_external (self, dict[str, Any]|None auth_resp=None)
 
ConfigFlowResult async_step_create_token_fail (self, dict[str, Any]|None _=None)
 
ConfigFlowResult async_step_create_token_success (self, dict[str, Any]|None _=None)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
- Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
None __init_subclass__ (cls, *str|None domain=None, **Any kwargs)
 
ConfigFlowResult async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
 
ConfigFlowResult async_create_entry (self, *str title, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None, Mapping[str, Any]|None options=None)
 
ConfigEntry|None async_set_unique_id (self, str|None unique_id=None, *bool raise_on_progress=True)
 
ConfigFlowResult 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)
 
ConfigFlowResult async_step_bluetooth (self, BluetoothServiceInfoBleak discovery_info)
 
ConfigFlowResult async_step_dhcp (self, DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_hassio (self, HassioServiceInfo discovery_info)
 
ConfigFlowResult async_step_homekit (self, ZeroconfServiceInfo discovery_info)
 
ConfigFlowResult async_step_ignore (self, dict[str, Any] user_input)
 
ConfigFlowResult async_step_integration_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_mqtt (self, MqttServiceInfo discovery_info)
 
ConfigFlowResult async_step_ssdp (self, SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_usb (self, UsbServiceInfo discovery_info)
 
ConfigFlowResult async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)
 
bool async_supports_options_flow (cls, ConfigEntry config_entry)
 
ConfigFlowResult async_update_reload_and_abort (self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
 
bool is_matching (self, Self other_flow)
 
str|None unique_id (self)
 
- 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)
 
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_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)
 

Static Public Member Functions

HyperionOptionsFlow async_get_options_flow (ConfigEntry config_entry)
 
- Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None async_setup_preview (HomeAssistant hass)
 

Static Public Attributes

int VERSION = 1
 
- 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
 

Private Member Functions

ConfigFlowResult _advance_to_auth_step_if_necessary (self, client.HyperionClient hyperion_client)
 
bool|None _can_login (self)
 
None _cancel_request_token_task (self)
 
client.HyperionClient _create_client (self, bool raw_connection=False)
 
str _get_hyperion_url (self)
 
None _request_token_task_func (self, str auth_id)
 

Private Attributes

 _auth_id
 
 _data
 
 _port_ui
 
 _request_token_task
 
 _require_confirm
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Detailed Description

Handle a Hyperion config flow.

Definition at line 109 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hyperion.config_flow.HyperionConfigFlow.__init__ (   self)
Instantiate config flow.

Definition at line 116 of file config_flow.py.

Member Function Documentation

◆ _advance_to_auth_step_if_necessary()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow._advance_to_auth_step_if_necessary (   self,
client.HyperionClient   hyperion_client 
)
private
Determine if auth is required.

Definition at line 133 of file config_flow.py.

◆ _can_login()

bool | None homeassistant.components.hyperion.config_flow.HyperionConfigFlow._can_login (   self)
private
Verify login details.

Definition at line 288 of file config_flow.py.

◆ _cancel_request_token_task()

None homeassistant.components.hyperion.config_flow.HyperionConfigFlow._cancel_request_token_task (   self)
private
Cancel the request token task if it exists.

Definition at line 255 of file config_flow.py.

◆ _create_client()

client.HyperionClient homeassistant.components.hyperion.config_flow.HyperionConfigFlow._create_client (   self,
bool   raw_connection = False 
)
private
Create and connect a client instance.

Definition at line 124 of file config_flow.py.

◆ _get_hyperion_url()

str homeassistant.components.hyperion.config_flow.HyperionConfigFlow._get_hyperion_url (   self)
private
Return the URL of the Hyperion UI.

Definition at line 278 of file config_flow.py.

◆ _request_token_task_func()

None homeassistant.components.hyperion.config_flow.HyperionConfigFlow._request_token_task_func (   self,
str  auth_id 
)
private
Send an async_request_token request.

Definition at line 265 of file config_flow.py.

◆ async_get_options_flow()

HyperionOptionsFlow homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_get_options_flow ( ConfigEntry  config_entry)
static
Get the Hyperion Options flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 427 of file config_flow.py.

◆ async_step_auth()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_auth (   self,
dict[str, Any] | None   user_input = None 
)
Handle the auth step of a flow.

Definition at line 299 of file config_flow.py.

◆ async_step_confirm()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Get final confirmation before entry creation.

Definition at line 392 of file config_flow.py.

◆ async_step_create_token()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_create_token (   self,
dict[str, Any] | None   user_input = None 
)
Send a request for a new token.

Definition at line 329 of file config_flow.py.

◆ async_step_create_token_external()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_create_token_external (   self,
dict[str, Any] | None   auth_resp = None 
)
Handle completion of the request for a new token.

Definition at line 355 of file config_flow.py.

◆ async_step_create_token_fail()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_create_token_fail (   self,
dict[str, Any] | None   _ = None 
)
Show an error on the auth form.

Definition at line 384 of file config_flow.py.

◆ async_step_create_token_success()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_create_token_success (   self,
dict[str, Any] | None   _ = None 
)
Create an entry after successful token creation.

Definition at line 368 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle a reauthentication flow.

Definition at line 147 of file config_flow.py.

◆ async_step_ssdp()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_ssdp (   self,
ssdp.SsdpServiceInfo   discovery_info 
)
Handle a flow initiated by SSDP.

Definition at line 157 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.hyperion.config_flow.HyperionConfigFlow.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a flow initiated by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 228 of file config_flow.py.

Member Data Documentation

◆ _auth_id

homeassistant.components.hyperion.config_flow.HyperionConfigFlow._auth_id
private

Definition at line 334 of file config_flow.py.

◆ _data

homeassistant.components.hyperion.config_flow.HyperionConfigFlow._data
private

Definition at line 151 of file config_flow.py.

◆ _port_ui

homeassistant.components.hyperion.config_flow.HyperionConfigFlow._port_ui
private

Definition at line 198 of file config_flow.py.

◆ _request_token_task

homeassistant.components.hyperion.config_flow.HyperionConfigFlow._request_token_task
private

Definition at line 263 of file config_flow.py.

◆ _require_confirm

homeassistant.components.hyperion.config_flow.HyperionConfigFlow._require_confirm
private

Definition at line 195 of file config_flow.py.

◆ VERSION

int homeassistant.components.hyperion.config_flow.HyperionConfigFlow.VERSION = 1
static

Definition at line 112 of file config_flow.py.


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