homeassistant.components.roomba.config_flow Namespace Reference

Classes
class	RoombaConfigFlow
class	RoombaOptionsFlowHandler

Functions
str	_async_blid_from_hostname (str hostname)
list[RoombaInfo]	_async_discover_roombas (HomeAssistant hass, str|None host=None)
RoombaDiscovery	_async_get_roomba_discovery ()
dict[str, Any]	validate_input (HomeAssistant hass, dict[str, Any] data)

Variables
int	ALL_ATTEMPTS = 2
string	AUTH_HELP_URL_KEY = "auth_help_url"
tuple	AUTH_HELP_URL_VALUE
dictionary	DEFAULT_OPTIONS = {CONF_CONTINUOUS: DEFAULT_CONTINUOUS, CONF_DELAY: DEFAULT_DELAY}
int	HOST_ATTEMPTS = 6
int	MAX_NUM_DEVICES_TO_DISCOVER = 25
string	ROOMBA_DISCOVERY_LOCK = "roomba_discovery_lock"
int	ROOMBA_WAKE_TIME = 6

Detailed Description

Config flow to configure roomba component.

Function Documentation

_async_blid_from_hostname()

str homeassistant.components.roomba.config_flow._async_blid_from_hostname ( str  hostname )

private

Extract the blid from the hostname.

Definition at line 340 of file config_flow.py.

_async_discover_roombas()

list[RoombaInfo] homeassistant.components.roomba.config_flow._async_discover_roombas ( HomeAssistant  hass, str | None   host = None  )

private

Definition at line 345 of file config_flow.py.

_async_get_roomba_discovery()

RoombaDiscovery homeassistant.components.roomba.config_flow._async_get_roomba_discovery ( )

private

Create a discovery object.

Definition at line 332 of file config_flow.py.

validate_input()

dict[str, Any] homeassistant.components.roomba.config_flow.validate_input	(	HomeAssistant	hass,
		dict[str, Any]	data
	)

Validate the user input allows us to connect.

Data has the keys from DATA_SCHEMA with values provided by the user.

Definition at line 49 of file config_flow.py.

Variable Documentation

ALL_ATTEMPTS

int homeassistant.components.roomba.config_flow.ALL_ATTEMPTS = 2

Definition at line 35 of file config_flow.py.

AUTH_HELP_URL_KEY

string homeassistant.components.roomba.config_flow.AUTH_HELP_URL_KEY = "auth_help_url"

Definition at line 43 of file config_flow.py.

AUTH_HELP_URL_VALUE

tuple homeassistant.components.roomba.config_flow.AUTH_HELP_URL_VALUE

Initial value:

=  (
    "https://www.home-assistant.io/integrations/roomba/#retrieving-your-credentials"
)

Definition at line 44 of file config_flow.py.

DEFAULT_OPTIONS

dictionary homeassistant.components.roomba.config_flow.DEFAULT_OPTIONS = {CONF_CONTINUOUS: DEFAULT_CONTINUOUS, CONF_DELAY: DEFAULT_DELAY}

Definition at line 39 of file config_flow.py.

HOST_ATTEMPTS

int homeassistant.components.roomba.config_flow.HOST_ATTEMPTS = 6

Definition at line 36 of file config_flow.py.

MAX_NUM_DEVICES_TO_DISCOVER

int homeassistant.components.roomba.config_flow.MAX_NUM_DEVICES_TO_DISCOVER = 25

Definition at line 41 of file config_flow.py.

ROOMBA_DISCOVERY_LOCK

string homeassistant.components.roomba.config_flow.ROOMBA_DISCOVERY_LOCK = "roomba_discovery_lock"

Definition at line 34 of file config_flow.py.

ROOMBA_WAKE_TIME

int homeassistant.components.roomba.config_flow.ROOMBA_WAKE_TIME = 6

Definition at line 37 of file config_flow.py.