Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sonos.helpers Namespace Reference

Functions

str|None _find_target_identifier (Any instance, SoCo|None fallback_soco)
 
def _T
 
str hostname_to_uid (str hostname)
 
set[SoCo] sync_get_visible_zones (SoCo soco)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 _SonosEntitiesType
 
string UID_POSTFIX = "01400"
 
string UID_PREFIX = "RINCON_"
 

Detailed Description

Helper methods for common tasks.

Function Documentation

◆ _find_target_identifier()

str | None homeassistant.components.sonos.helpers._find_target_identifier ( Any  instance,
SoCo | None  fallback_soco 
)
private
Extract the best available target identifier from the provided instance object.

Definition at line 89 of file helpers.py.

◆ _T()

def homeassistant.components.sonos.helpers._T
private

Definition at line 37 of file helpers.py.

◆ hostname_to_uid()

str homeassistant.components.sonos.helpers.hostname_to_uid ( str  hostname)
Convert a Sonos hostname to a uid.

Definition at line 107 of file helpers.py.

◆ sync_get_visible_zones()

set[SoCo] homeassistant.components.sonos.helpers.sync_get_visible_zones ( SoCo  soco)
Ensure I/O attributes are cached and return visible zones.

Definition at line 118 of file helpers.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 27 of file helpers.py.

◆ _SonosEntitiesType

homeassistant.components.sonos.helpers._SonosEntitiesType
private

Definition at line 29 of file helpers.py.

◆ UID_POSTFIX

string homeassistant.components.sonos.helpers.UID_POSTFIX = "01400"

Definition at line 25 of file helpers.py.

◆ UID_PREFIX

string homeassistant.components.sonos.helpers.UID_PREFIX = "RINCON_"

Definition at line 24 of file helpers.py.