Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.switchbot_cloud Namespace Reference

Namespaces

 climate
 
 config_flow
 
 const
 
 coordinator
 
 entity
 
 lock
 
 sensor
 
 switch
 
 vacuum
 

Classes

class  SwitchbotCloudData
 
class  SwitchbotDevices
 

Functions

bool async_setup_entry (HomeAssistant hass, ConfigEntry config)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
SwitchbotDevices make_device_data (HomeAssistant hass, SwitchBotAPI api, list[Device|Remote] devices, dict[str, SwitchBotCoordinator] coordinators_by_id)
 
tuple[Device|Remote, SwitchBotCoordinatorprepare_device (HomeAssistant hass, SwitchBotAPI api, Device|Remote device, dict[str, SwitchBotCoordinator] coordinators_by_id)
 

Variables

 _LOGGER = getLogger(__name__)
 

Detailed Description

SwitchBot via API integration.

Function Documentation

◆ async_setup_entry()

bool homeassistant.components.switchbot_cloud.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config 
)
Set up SwitchBot via API from a config entry.

Definition at line 112 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.switchbot_cloud.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 140 of file __init__.py.

◆ make_device_data()

SwitchbotDevices homeassistant.components.switchbot_cloud.make_device_data ( HomeAssistant  hass,
SwitchBotAPI  api,
list[Device | Remote]  devices,
dict[str, SwitchBotCoordinator coordinators_by_id 
)
Make device data.

Definition at line 61 of file __init__.py.

◆ prepare_device()

tuple[Device | Remote, SwitchBotCoordinator] homeassistant.components.switchbot_cloud.prepare_device ( HomeAssistant  hass,
SwitchBotAPI  api,
Device | Remote  device,
dict[str, SwitchBotCoordinator coordinators_by_id 
)
Instantiate coordinator and adds to list for gathering.

Definition at line 47 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.switchbot_cloud._LOGGER = getLogger(__name__)
private

Definition at line 17 of file __init__.py.