homeassistant.components.roborock Namespace Reference

Namespaces
	binary_sensor
	button
	config_flow
	const
	coordinator
	diagnostics
	entity
	image
	models
	number
	select
	sensor
	switch
	time
	vacuum

Classes
class	RoborockCoordinators

Functions
bool	async_setup_entry (HomeAssistant hass, RoborockConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, RoborockConfigEntry entry)
list[ Coroutine[ Any, Any, RoborockDataUpdateCoordinator|RoborockDataUpdateCoordinatorA01|None,]]	build_setup_functions (HomeAssistant hass, dict[str, HomeDataDevice] device_map, UserData user_data, dict[str, HomeDataProduct] product_info, list[HomeDataRoom] home_data_rooms)
RoborockDataUpdateCoordinator|RoborockDataUpdateCoordinatorA01|None	setup_device (HomeAssistant hass, UserData user_data, HomeDataDevice device, HomeDataProduct product_info, list[HomeDataRoom] home_data_rooms)
RoborockDataUpdateCoordinatorA01|None	setup_device_a01 (HomeAssistant hass, UserData user_data, HomeDataDevice device, HomeDataProduct product_info)
RoborockDataUpdateCoordinator|None	setup_device_v1 (HomeAssistant hass, UserData user_data, HomeDataDevice device, HomeDataProduct product_info, list[HomeDataRoom] home_data_rooms)
None	update_listener (HomeAssistant hass, RoborockConfigEntry entry)

Variables
	_LOGGER = logging.getLogger(__name__)
	RoborockConfigEntry
	SCAN_INTERVAL = timedelta(seconds=30)

Detailed Description

The Roborock component.

Function Documentation

async_setup_entry()

bool homeassistant.components.roborock.async_setup_entry	(	HomeAssistant	hass,
		RoborockConfigEntry	entry
	)

Set up roborock from a config entry.

Definition at line 47 of file __init__.py.

async_unload_entry()

bool homeassistant.components.roborock.async_unload_entry	(	HomeAssistant	hass,
		RoborockConfigEntry	entry
	)

Handle removal of an entry.

Definition at line 244 of file __init__.py.

build_setup_functions()

list[ Coroutine[ Any, Any, RoborockDataUpdateCoordinator | RoborockDataUpdateCoordinatorA01 | None, ] ] homeassistant.components.roborock.build_setup_functions	(	HomeAssistant	hass,
		dict[str, HomeDataDevice]	device_map,
		UserData	user_data,
		dict[str, HomeDataProduct]	product_info,
		list[HomeDataRoom]	home_data_rooms
	)

Create a list of setup functions that can later be called asynchronously.

Definition at line 117 of file __init__.py.

setup_device()

RoborockDataUpdateCoordinator | RoborockDataUpdateCoordinatorA01 | None homeassistant.components.roborock.setup_device	(	HomeAssistant	hass,
		UserData	user_data,
		HomeDataDevice	device,
		HomeDataProduct	product_info,
		list[HomeDataRoom]	home_data_rooms
	)

Set up a coordinator for a given device.

Definition at line 139 of file __init__.py.

setup_device_a01()

RoborockDataUpdateCoordinatorA01 | None homeassistant.components.roborock.setup_device_a01	(	HomeAssistant	hass,
		UserData	user_data,
		HomeDataDevice	device,
		HomeDataProduct	product_info
	)

Set up a A01 protocol device.

Definition at line 229 of file __init__.py.

setup_device_v1()

RoborockDataUpdateCoordinator | None homeassistant.components.roborock.setup_device_v1	(	HomeAssistant	hass,
		UserData	user_data,
		HomeDataDevice	device,
		HomeDataProduct	product_info,
		list[HomeDataRoom]	home_data_rooms
	)

Set up a device Coordinator.

Definition at line 162 of file __init__.py.

update_listener()

None homeassistant.components.roborock.update_listener	(	HomeAssistant	hass,
		RoborockConfigEntry	entry
	)

Handle options update.

Definition at line 249 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 28 of file __init__.py.

RoborockConfigEntry

homeassistant.components.roborock.RoborockConfigEntry

Definition at line 30 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.roborock.SCAN_INTERVAL = timedelta(seconds=30)

Definition at line 26 of file __init__.py.