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

Public Member Functions

def __init__ (self, hass, plex_server, plex_library_section)
 
None async_added_to_hass (self)
 
None async_refresh_sensor (self)
 
DeviceInfo|None device_info (self)
 
- 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 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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (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 Attributes

 library_section
 
 library_type
 
 server_id
 
 server_name
 
- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _update_state_and_attrs (self)
 

Private Attributes

 _attr_available
 
 _attr_extra_state_attributes
 
 _attr_icon
 
 _attr_name
 
 _attr_native_value
 
 _attr_unique_id
 
 _server
 

Static Private Attributes

bool _attr_available = True
 
bool _attr_entity_registry_enabled_default = False
 
string _attr_native_unit_of_measurement = "Items"
 
bool _attr_should_poll = False
 

Additional Inherited Members

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

Detailed Description

Representation of a Plex library section sensor.

Definition at line 130 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.plex.sensor.PlexLibrarySectionSensor.__init__ (   self,
  hass,
  plex_server,
  plex_library_section 
)
Initialize the sensor.

Definition at line 138 of file sensor.py.

Member Function Documentation

◆ _update_state_and_attrs()

def homeassistant.components.plex.sensor.PlexLibrarySectionSensor._update_state_and_attrs (   self)
private
Update library sensor state with sync calls.

Definition at line 179 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.plex.sensor.PlexLibrarySectionSensor.async_added_to_hass (   self)
Run when about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 151 of file sensor.py.

◆ async_refresh_sensor()

None homeassistant.components.plex.sensor.PlexLibrarySectionSensor.async_refresh_sensor (   self)
Update state and attributes for the library sensor.

Definition at line 162 of file sensor.py.

◆ device_info()

DeviceInfo | None homeassistant.components.plex.sensor.PlexLibrarySectionSensor.device_info (   self)
Return a device description for device registry.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 207 of file sensor.py.

Member Data Documentation

◆ _attr_available [1/2]

bool homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_available = True
staticprivate

Definition at line 133 of file sensor.py.

◆ _attr_available [2/2]

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_available
private

Definition at line 167 of file sensor.py.

◆ _attr_entity_registry_enabled_default

bool homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_entity_registry_enabled_default = False
staticprivate

Definition at line 134 of file sensor.py.

◆ _attr_extra_state_attributes

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_extra_state_attributes
private

Definition at line 146 of file sensor.py.

◆ _attr_icon

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_icon
private

Definition at line 147 of file sensor.py.

◆ _attr_name

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_name
private

Definition at line 148 of file sensor.py.

◆ _attr_native_unit_of_measurement

string homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_native_unit_of_measurement = "Items"
staticprivate

Definition at line 136 of file sensor.py.

◆ _attr_native_value

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_native_value
private

Definition at line 185 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_should_poll = False
staticprivate

Definition at line 135 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._attr_unique_id
private

Definition at line 149 of file sensor.py.

◆ _server

homeassistant.components.plex.sensor.PlexLibrarySectionSensor._server
private

Definition at line 140 of file sensor.py.

◆ library_section

homeassistant.components.plex.sensor.PlexLibrarySectionSensor.library_section

Definition at line 143 of file sensor.py.

◆ library_type

homeassistant.components.plex.sensor.PlexLibrarySectionSensor.library_type

Definition at line 144 of file sensor.py.

◆ server_id

homeassistant.components.plex.sensor.PlexLibrarySectionSensor.server_id

Definition at line 142 of file sensor.py.

◆ server_name

homeassistant.components.plex.sensor.PlexLibrarySectionSensor.server_name

Definition at line 141 of file sensor.py.


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