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

Namespaces

 config_flow
 
 const
 
 media_player
 

Classes

class  SoundTouchData
 

Functions

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)
 
list PLATFORMS = [Platform.MEDIA_PLAYER]
 
 SERVICE_ADD_ZONE_SCHEMA
 
 SERVICE_CREATE_ZONE_SCHEMA
 
 SERVICE_PLAY_EVERYWHERE_SCHEMA = vol.Schema({vol.Required("master"): cv.entity_id})
 
 SERVICE_REMOVE_ZONE_SCHEMA
 

Detailed Description

The soundtouch component.

Function Documentation

◆ async_setup()

bool homeassistant.components.soundtouch.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up Bose SoundTouch component.

Definition at line 59 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.soundtouch.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Bose SoundTouch from a config entry.

Definition at line 131 of file __init__.py.

◆ async_unload_entry()

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

Definition at line 141 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 23 of file __init__.py.

◆ CONFIG_SCHEMA

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

Definition at line 47 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.soundtouch.PLATFORMS = [Platform.MEDIA_PLAYER]

Definition at line 45 of file __init__.py.

◆ SERVICE_ADD_ZONE_SCHEMA

homeassistant.components.soundtouch.SERVICE_ADD_ZONE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required("master"): cv.entity_id,
4  vol.Required("slaves"): cv.entity_ids,
5  }
6 )

Definition at line 32 of file __init__.py.

◆ SERVICE_CREATE_ZONE_SCHEMA

homeassistant.components.soundtouch.SERVICE_CREATE_ZONE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required("master"): cv.entity_id,
4  vol.Required("slaves"): cv.entity_ids,
5  }
6 )

Definition at line 26 of file __init__.py.

◆ SERVICE_PLAY_EVERYWHERE_SCHEMA

homeassistant.components.soundtouch.SERVICE_PLAY_EVERYWHERE_SCHEMA = vol.Schema({vol.Required("master"): cv.entity_id})

Definition at line 25 of file __init__.py.

◆ SERVICE_REMOVE_ZONE_SCHEMA

homeassistant.components.soundtouch.SERVICE_REMOVE_ZONE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required("master"): cv.entity_id,
4  vol.Required("slaves"): cv.entity_ids,
5  }
6 )

Definition at line 38 of file __init__.py.