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

Namespaces

 cover
 
 entity
 
 switch
 

Functions

bool async_setup (HomeAssistant hass, ConfigType base_config)
 
def discover_devices (hass, hass_config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_SERVER = "server"
 
string CONF_SERVERS = "servers"
 
 CONFIG_SCHEMA
 
string DOMAIN = "supla"
 
 SCAN_INTERVAL = timedelta(seconds=10)
 
 SERVER_CONFIG
 
string SUPLA_COORDINATORS = "supla_coordinators"
 
dictionary SUPLA_FUNCTION_HA_CMP_MAP
 
string SUPLA_FUNCTION_NONE = "NONE"
 
string SUPLA_SERVERS = "supla_servers"
 

Detailed Description

Support for Supla devices.

Function Documentation

◆ async_setup()

bool homeassistant.components.supla.async_setup ( HomeAssistant  hass,
ConfigType  base_config 
)
Set up the Supla component.

Definition at line 55 of file __init__.py.

◆ discover_devices()

def homeassistant.components.supla.discover_devices (   hass,
  hass_config 
)
Run periodically to discover new devices.

Currently it is only run at startup.

Definition at line 93 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 20 of file __init__.py.

◆ CONF_SERVER

string homeassistant.components.supla.CONF_SERVER = "server"

Definition at line 23 of file __init__.py.

◆ CONF_SERVERS

string homeassistant.components.supla.CONF_SERVERS = "servers"

Definition at line 24 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.supla.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {vol.Required(CONF_SERVERS): vol.All(cv.ensure_list, [SERVER_CONFIG])}
5  )
6  },
7  extra=vol.ALLOW_EXTRA,
8 )

Definition at line 45 of file __init__.py.

◆ DOMAIN

string homeassistant.components.supla.DOMAIN = "supla"

Definition at line 22 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.supla.SCAN_INTERVAL = timedelta(seconds=10)

Definition at line 26 of file __init__.py.

◆ SERVER_CONFIG

homeassistant.components.supla.SERVER_CONFIG
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_SERVER): cv.string,
4  vol.Required(CONF_ACCESS_TOKEN): cv.string,
5  }
6 )

Definition at line 38 of file __init__.py.

◆ SUPLA_COORDINATORS

string homeassistant.components.supla.SUPLA_COORDINATORS = "supla_coordinators"

Definition at line 36 of file __init__.py.

◆ SUPLA_FUNCTION_HA_CMP_MAP

dictionary homeassistant.components.supla.SUPLA_FUNCTION_HA_CMP_MAP
Initial value:
1 = {
2  "CONTROLLINGTHEROLLERSHUTTER": Platform.COVER,
3  "CONTROLLINGTHEGATE": Platform.COVER,
4  "CONTROLLINGTHEGARAGEDOOR": Platform.COVER,
5  "LIGHTSWITCH": Platform.SWITCH,
6 }

Definition at line 28 of file __init__.py.

◆ SUPLA_FUNCTION_NONE

string homeassistant.components.supla.SUPLA_FUNCTION_NONE = "NONE"

Definition at line 34 of file __init__.py.

◆ SUPLA_SERVERS

string homeassistant.components.supla.SUPLA_SERVERS = "supla_servers"

Definition at line 35 of file __init__.py.