Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity Class Reference
Inheritance diagram for homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity:
[legend]
Collaboration diagram for homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity:
[legend]

Public Member Functions

None __init__ (self, SonosSpeaker speaker, str audio_format)
 
None poll_state (self)
 
- Public Member Functions inherited from homeassistant.components.sonos.entity.SonosPollingEntity
None update (self)
 
- Public Member Functions inherited from homeassistant.components.sonos.entity.SonosEntity
None __init__ (self, SonosSpeaker speaker)
 
None async_added_to_hass (self)
 
None async_fallback_poll (self, datetime.datetime now)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
SoCo soco (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
dict[str, Any]|None capability_attributes (self)
 
SensorDeviceClass|None device_class (self)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
datetime|None last_reset (self)
 
str|None native_unit_of_measurement (self)
 
StateType|date|datetime|Decimal native_value (self)
 
list[str]|None options (self)
 
Any state (self)
 
dict[str, Any]|None state_attributes (self)
 
SensorStateClass|str|None state_class (self)
 
int|None suggested_display_precision (self)
 
str|None suggested_unit_of_measurement (self)
 
str|None unit_of_measurement (self)
 

Public Attributes

 state
 
- Public Attributes inherited from homeassistant.components.sonos.entity.SonosEntity
 speaker
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 

Private Member Functions

None _async_fallback_poll (self)
 
None _poll_state (self)
 

Private Attributes

 _attr_native_value
 
 _attr_unique_id
 

Static Private Attributes

 _attr_entity_category = EntityCategory.DIAGNOSTIC
 
bool _attr_should_poll = True
 
string _attr_translation_key = "audio_input_format"
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 

Detailed Description

Representation of a Sonos audio import format sensor entity.

Definition at line 105 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity.__init__ (   self,
SonosSpeaker  speaker,
str  audio_format 
)
Initialize the audio input format sensor.

Definition at line 112 of file sensor.py.

Member Function Documentation

◆ _async_fallback_poll()

None homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._async_fallback_poll (   self)
private
Provide a stub for required ABC method.

Reimplemented from homeassistant.components.sonos.entity.SonosEntity.

Definition at line 129 of file sensor.py.

◆ _poll_state()

None homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._poll_state (   self)
private
Poll the device for the current state.

Definition at line 125 of file sensor.py.

◆ poll_state()

None homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity.poll_state (   self)
Poll the state if TV source is active and state has settled.

Reimplemented from homeassistant.components.sonos.entity.SonosPollingEntity.

Definition at line 118 of file sensor.py.

Member Data Documentation

◆ _attr_entity_category

homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._attr_entity_category = EntityCategory.DIAGNOSTIC
staticprivate

Definition at line 108 of file sensor.py.

◆ _attr_native_value

homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._attr_native_value
private
Poll the device for the current state.

Definition at line 116 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._attr_should_poll = True
staticprivate

Definition at line 110 of file sensor.py.

◆ _attr_translation_key

string homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._attr_translation_key = "audio_input_format"
staticprivate

Definition at line 109 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity._attr_unique_id
private
Initialize the audio input format sensor.

Definition at line 115 of file sensor.py.

◆ state

homeassistant.components.sonos.sensor.SonosAudioInputFormatSensorEntity.state
Poll the state if TV source is active and state has settled.

Definition at line 120 of file sensor.py.


The documentation for this class was generated from the following file: