homeassistant.components.sonos.diagnostics Namespace Reference

Functions
dict[str, Any]	async_generate_media_info (HomeAssistant hass, SonosSpeaker speaker)
dict[str, Any]	async_generate_speaker_info (HomeAssistant hass, SonosSpeaker speaker)
dict[str, Any]	async_get_config_entry_diagnostics (HomeAssistant hass, ConfigEntry config_entry)
dict[str, Any]	async_get_device_diagnostics (HomeAssistant hass, ConfigEntry config_entry, DeviceEntry device)

Variables
tuple	MEDIA_DIAGNOSTIC_ATTRIBUTES
tuple	SPEAKER_DIAGNOSTIC_ATTRIBUTES

Detailed Description

Provides diagnostics for Sonos.

Function Documentation

async_generate_media_info()

dict[str, Any] homeassistant.components.sonos.diagnostics.async_generate_media_info	(	HomeAssistant	hass,
		SonosSpeaker	speaker
	)

Generate a diagnostic payload for current media metadata.

Definition at line 84 of file diagnostics.py.

async_generate_speaker_info()

dict[str, Any] homeassistant.components.sonos.diagnostics.async_generate_speaker_info	(	HomeAssistant	hass,
		SonosSpeaker	speaker
	)

Generate the diagnostic payload for a specific speaker.

Definition at line 109 of file diagnostics.py.

async_get_config_entry_diagnostics()

dict[str, Any] homeassistant.components.sonos.diagnostics.async_get_config_entry_diagnostics	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Return diagnostics for a config entry.

Definition at line 47 of file diagnostics.py.

async_get_device_diagnostics()

dict[str, Any] homeassistant.components.sonos.diagnostics.async_get_device_diagnostics	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		DeviceEntry	device
	)

Return diagnostics for a device.

Definition at line 67 of file diagnostics.py.

Variable Documentation

MEDIA_DIAGNOSTIC_ATTRIBUTES

tuple homeassistant.components.sonos.diagnostics.MEDIA_DIAGNOSTIC_ATTRIBUTES

Initial value:

=  (
    "album_name",
    "artist",
    "channel",
    "duration",
    "image_url",
    "queue_position",
    "playlist_name",
    "source_name",
    "title",
    "uri",
)

Definition at line 15 of file diagnostics.py.

SPEAKER_DIAGNOSTIC_ATTRIBUTES

tuple homeassistant.components.sonos.diagnostics.SPEAKER_DIAGNOSTIC_ATTRIBUTES

Initial value:

=  (
    "available",
    "battery_info",
    "hardware_version",
    "household_id",
    "is_coordinator",
    "model_name",
    "model_number",
    "software_version",
    "sonos_group_entities",
    "subscription_address",
    "subscriptions_failed",
    "version",
    "zone_name",
    "_group_members_missing",
    "_last_activity",
    "_last_event_cache",
)

Definition at line 27 of file diagnostics.py.