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

Namespaces

 binary_sensor
 
 climate
 
 config_flow
 
 const
 
 cover
 
 entity
 
 fan
 
 light
 
 lock
 
 scene
 
 sensor
 
 smartapp
 
 switch
 

Classes

class  DeviceBroker
 

Functions

def async_get_entry_scenes (ConfigEntry entry, api)
 
bool async_migrate_entry (HomeAssistant hass, ConfigEntry entry)
 
None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
 

Detailed Description

Support for SmartThings Cloud.

Function Documentation

◆ async_get_entry_scenes()

def homeassistant.components.smartthings.async_get_entry_scenes ( ConfigEntry  entry,
  api 
)
Get the scenes within an integration.

Definition at line 210 of file __init__.py.

◆ async_migrate_entry()

bool homeassistant.components.smartthings.async_migrate_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Handle migration of a previous version config entry.

A config entry created under a previous version must go through the
integration setup again so we can properly retrieve the needed data
elements. Force this by removing the entry and triggering a new flow.

Definition at line 62 of file __init__.py.

◆ async_remove_entry()

None homeassistant.components.smartthings.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Perform clean-up when entry is being removed.

Definition at line 237 of file __init__.py.

◆ async_setup()

bool homeassistant.components.smartthings.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Initialize the SmartThings platform.

Definition at line 56 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.smartthings.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Initialize config entry which represents an installed SmartApp.

Definition at line 83 of file __init__.py.

◆ async_unload_entry()

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

Definition at line 228 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.smartthings._LOGGER = logging.getLogger(__name__)
private

Definition at line 51 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.smartthings.CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

Definition at line 53 of file __init__.py.