homeassistant.components.sonos Namespace Reference

Namespaces
	alarms
	binary_sensor
	config_flow
	const
	diagnostics
	entity
	exception
	favorites
	helpers
	household_coordinator
	media
	media_browser
	media_player
	number
	sensor
	speaker
	statistics
	switch

Classes
class	SonosData
class	SonosDiscoveryManager
class	UnjoinData

Functions
bool	async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_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__)
string	CONF_ADVERTISE_ADDR = "advertise_addr"
string	CONF_INTERFACE_ADDR = "interface_addr"
	CONFIG_SCHEMA
list	DISCOVERY_IGNORED_MODELS = ["Sonos Boost"]
int	ZGS_SUBSCRIPTION_TIMEOUT = 2

Detailed Description

Support to embed Sonos.

Function Documentation

async_remove_config_entry_device()

bool homeassistant.components.sonos.async_remove_config_entry_device	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		dr.DeviceEntry	device_entry
	)

Remove Sonos config entry from a device.

Definition at line 610 of file __init__.py.

async_setup()

bool homeassistant.components.sonos.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Sonos component.

Definition at line 118 of file __init__.py.

async_setup_entry()

bool homeassistant.components.sonos.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up Sonos from a config entry.

Definition at line 134 of file __init__.py.

async_unload_entry()

bool homeassistant.components.sonos.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a Sonos config entry.

Definition at line 169 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 62 of file __init__.py.

CONF_ADVERTISE_ADDR

string homeassistant.components.sonos.CONF_ADVERTISE_ADDR = "advertise_addr"

Definition at line 64 of file __init__.py.

CONF_INTERFACE_ADDR

string homeassistant.components.sonos.CONF_INTERFACE_ADDR = "interface_addr"

Definition at line 65 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.sonos.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                MP_DOMAIN: vol.All(
                    cv.deprecated(CONF_INTERFACE_ADDR),
                    vol.Schema(
                        {
                            vol.Optional(CONF_ADVERTISE_ADDR): cv.string,
                            vol.Optional(CONF_INTERFACE_ADDR): cv.string,
                            vol.Optional(CONF_HOSTS): vol.All(
                                cv.ensure_list_csv, [cv.string]
                            ),
                        }
                    ),
                )
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 69 of file __init__.py.

DISCOVERY_IGNORED_MODELS

list homeassistant.components.sonos.DISCOVERY_IGNORED_MODELS = ["Sonos Boost"]

Definition at line 66 of file __init__.py.

ZGS_SUBSCRIPTION_TIMEOUT

int homeassistant.components.sonos.ZGS_SUBSCRIPTION_TIMEOUT = 2

Definition at line 67 of file __init__.py.