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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_reauth_validate (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_user_validate (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_validation (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)
 

Public Attributes

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

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

ValidateResult _async_auth_or_validate (self)
 
AugustGateway _async_get_gateway (self)
 
None _async_reset_access_token_cache_if_needed (self, AugustGateway gateway, str username, str|None access_token_cache_file)
 
None _async_shutdown_gateway (self)
 
ConfigFlowResult _async_update_or_create_entry (self, dict[str, Any] info)
 

Private Attributes

 _aiohttp_session
 
 _august_gateway
 
 _needs_reset
 
 _user_auth_details
 

Additional Inherited Members

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

Detailed Description

Handle a config flow for August.

Definition at line 85 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.august.config_flow.AugustConfigFlow.__init__ (   self)
Store an AugustGateway().

Definition at line 90 of file config_flow.py.

Member Function Documentation

◆ _async_auth_or_validate()

ValidateResult homeassistant.components.august.config_flow.AugustConfigFlow._async_auth_or_validate (   self)
private
Authenticate or validate.

Definition at line 238 of file config_flow.py.

◆ _async_get_gateway()

AugustGateway homeassistant.components.august.config_flow.AugustConfigFlow._async_get_gateway (   self)
private
Set up the gateway.

Definition at line 168 of file config_flow.py.

◆ _async_reset_access_token_cache_if_needed()

None homeassistant.components.august.config_flow.AugustConfigFlow._async_reset_access_token_cache_if_needed (   self,
AugustGateway  gateway,
str  username,
str | None   access_token_cache_file 
)
private
Reset the access token cache if needed.

Definition at line 225 of file config_flow.py.

◆ _async_shutdown_gateway()

None homeassistant.components.august.config_flow.AugustConfigFlow._async_shutdown_gateway (   self)
private
Shutdown the gateway.

Definition at line 179 of file config_flow.py.

◆ _async_update_or_create_entry()

ConfigFlowResult homeassistant.components.august.config_flow.AugustConfigFlow._async_update_or_create_entry (   self,
dict[str, Any]   info 
)
private
Update existing entry or create a new one.

Definition at line 272 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.august.config_flow.AugustConfigFlow.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle configuration by re-auth.

Definition at line 185 of file config_flow.py.

◆ async_step_reauth_validate()

ConfigFlowResult homeassistant.components.august.config_flow.AugustConfigFlow.async_step_reauth_validate (   self,
dict[str, Any] | None   user_input = None 
)
Handle reauth and validation.

Definition at line 192 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.august.config_flow.AugustConfigFlow.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle the initial step.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 98 of file config_flow.py.

◆ async_step_user_validate()

ConfigFlowResult homeassistant.components.august.config_flow.AugustConfigFlow.async_step_user_validate (   self,
dict[str, Any] | None   user_input = None 
)
Handle authentication.

Definition at line 104 of file config_flow.py.

◆ async_step_validation()

ConfigFlowResult homeassistant.components.august.config_flow.AugustConfigFlow.async_step_validation (   self,
dict[str, Any] | None   user_input = None 
)
Handle validation (2fa) step.

Definition at line 144 of file config_flow.py.

Member Data Documentation

◆ _aiohttp_session

homeassistant.components.august.config_flow.AugustConfigFlow._aiohttp_session
private

Definition at line 172 of file config_flow.py.

◆ _august_gateway

homeassistant.components.august.config_flow.AugustConfigFlow._august_gateway
private

Definition at line 173 of file config_flow.py.

◆ _needs_reset

homeassistant.components.august.config_flow.AugustConfigFlow._needs_reset
private

Definition at line 95 of file config_flow.py.

◆ _user_auth_details

homeassistant.components.august.config_flow.AugustConfigFlow._user_auth_details
private

Definition at line 189 of file config_flow.py.

◆ source

homeassistant.components.august.config_flow.AugustConfigFlow.source

Definition at line 149 of file config_flow.py.

◆ VERSION

int homeassistant.components.august.config_flow.AugustConfigFlow.VERSION = 1
static

Definition at line 88 of file config_flow.py.


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