homeassistant.components.roomba Namespace Reference

Namespaces
	binary_sensor
	braava
	config_flow
	const
	entity
	models
	roomba
	sensor
	vacuum

Classes
class	CannotConnect

Functions
dict[str, Any]	async_connect_or_timeout (HomeAssistant hass, Roomba roomba)
None	async_disconnect_or_timeout (HomeAssistant hass, Roomba roomba)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry config_entry)
None	async_update_options (HomeAssistant hass, ConfigEntry config_entry)
dict[str, Any]	roomba_reported_state (Roomba roomba)

Variables
	_LOGGER = logging.getLogger(__name__)

Detailed Description

The roomba component.

Function Documentation

async_connect_or_timeout()

dict[str, Any] homeassistant.components.roomba.async_connect_or_timeout	(	HomeAssistant	hass,
		Roomba	roomba
	)

Connect to vacuum.

Definition at line 76 of file __init__.py.

async_disconnect_or_timeout()

None homeassistant.components.roomba.async_disconnect_or_timeout	(	HomeAssistant	hass,
		Roomba	roomba
	)

Disconnect to vacuum.

Definition at line 103 of file __init__.py.

async_setup_entry()

bool homeassistant.components.roomba.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Set the config entry up.

Definition at line 28 of file __init__.py.

async_unload_entry()

bool homeassistant.components.roomba.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Unload a config entry.

Definition at line 116 of file __init__.py.

async_update_options()

None homeassistant.components.roomba.async_update_options	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Update options.

Definition at line 111 of file __init__.py.

roomba_reported_state()

dict[str, Any] homeassistant.components.roomba.roomba_reported_state

(

Roomba

roomba

)

Roomba report.

Definition at line 129 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.roomba._LOGGER = logging.getLogger(__name__)

private

Definition at line 25 of file __init__.py.