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

Public Member Functions

None __init__ (self, AwairBaseDevice device, AwairDataUpdateCoordinator coordinator, AwairSensorEntityDescription description)
 
bool available (self)
 
DeviceInfo device_info (self)
 
dict[str, Any] extra_state_attributes (self)
 
float|None native_value (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.awair.coordinator.AwairDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, ConfigEntry config_entry, timedelta|None update_interval)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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)
 
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_added_to_hass (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 enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (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)
 
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

 entity_description
 
- Public Attributes inherited from homeassistant.components.awair.coordinator.AwairDataUpdateCoordinator
 title
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- 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

AirData|None _air_data (self)
 

Private Attributes

 _device
 

Static Private Attributes

 _attr_attribution = ATTRIBUTION
 
bool _attr_has_entity_name = True
 

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

Defines an Awair sensor entity.

Definition at line 171 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.awair.sensor.AwairSensor.__init__ (   self,
AwairBaseDevice  device,
AwairDataUpdateCoordinator  coordinator,
AwairSensorEntityDescription  description 
)
Set up an individual AwairSensor.

Definition at line 178 of file sensor.py.

Member Function Documentation

◆ _air_data()

AirData | None homeassistant.components.awair.sensor.AwairSensor._air_data (   self)
private
Return the latest data for our device, or None.

Definition at line 314 of file sensor.py.

◆ available()

bool homeassistant.components.awair.sensor.AwairSensor.available (   self)
Determine if the sensor is available based on API results.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 208 of file sensor.py.

◆ device_info()

DeviceInfo homeassistant.components.awair.sensor.AwairSensor.device_info (   self)
Device information.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 289 of file sensor.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.awair.sensor.AwairSensor.extra_state_attributes (   self)
Return the Awair Index alongside state attributes.

The Awair Index is a subjective score ranging from 0-4 (inclusive) that
is is used by the Awair app when displaying the relative "safety" of a
given measurement. Each value is mapped to a color indicating the safety:

    0: green
    1: yellow
    2: light-orange
    3: orange
    4: red

The API indicates that both positive and negative values may be returned,
but the negative values are mapped to identical colors as the positive values.
Knowing that, we just return the absolute value of a given index so that
users don't have to handle positive/negative values that ultimately "mean"
the same thing.

https://docs.developer.getawair.com/?version=latest#awair-score-and-index

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 256 of file sensor.py.

◆ native_value()

float | None homeassistant.components.awair.sensor.AwairSensor.native_value (   self)
Return the state, rounding off to reasonable values.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 231 of file sensor.py.

◆ unique_id()

str homeassistant.components.awair.sensor.AwairSensor.unique_id (   self)
Return the uuid as the unique_id.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 190 of file sensor.py.

Member Data Documentation

◆ _attr_attribution

homeassistant.components.awair.sensor.AwairSensor._attr_attribution = ATTRIBUTION
staticprivate

Definition at line 176 of file sensor.py.

◆ _attr_has_entity_name

bool homeassistant.components.awair.sensor.AwairSensor._attr_has_entity_name = True
staticprivate

Definition at line 175 of file sensor.py.

◆ _device

homeassistant.components.awair.sensor.AwairSensor._device
private

Definition at line 187 of file sensor.py.

◆ entity_description

homeassistant.components.awair.sensor.AwairSensor.entity_description

Definition at line 186 of file sensor.py.


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