Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifiprotect.config_flow Namespace Reference

Classes

class  OptionsFlowHandler
 
class  ProtectFlowHandler
 

Functions

bool _async_console_is_offline (HomeAssistant hass, ConfigEntry entry)
 
bool _host_is_direct_connect (str host)
 
str async_local_user_documentation_url (HomeAssistant hass)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
tuple ENTRY_FAILURE_STATES
 

Detailed Description

Config Flow to configure UniFi Protect Integration.

Function Documentation

◆ _async_console_is_offline()

bool homeassistant.components.unifiprotect.config_flow._async_console_is_offline ( HomeAssistant  hass,
ConfigEntry  entry 
)
private
Check if a console is offline.

We define offline by the config entry
is in a failure/retry state or the updates
are failing and the console is unreachable
since protect may be updating.

Definition at line 80 of file config_flow.py.

◆ _host_is_direct_connect()

bool homeassistant.components.unifiprotect.config_flow._host_is_direct_connect ( str  host)
private
Check if a host is a unifi direct connect domain.

Definition at line 75 of file config_flow.py.

◆ async_local_user_documentation_url()

str homeassistant.components.unifiprotect.config_flow.async_local_user_documentation_url ( HomeAssistant  hass)
Get the documentation url for creating a local user.

Definition at line 69 of file config_flow.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.unifiprotect.config_flow._LOGGER = logging.getLogger(__name__)
private

Definition at line 61 of file config_flow.py.

◆ ENTRY_FAILURE_STATES

tuple homeassistant.components.unifiprotect.config_flow.ENTRY_FAILURE_STATES
Initial value:
1 = (
2  ConfigEntryState.SETUP_ERROR,
3  ConfigEntryState.SETUP_RETRY,
4 )

Definition at line 63 of file config_flow.py.