Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ampio.air_quality.AmpioSmogQuality Class Reference
Inheritance diagram for homeassistant.components.ampio.air_quality.AmpioSmogQuality:
[legend]
Collaboration diagram for homeassistant.components.ampio.air_quality.AmpioSmogQuality:
[legend]

Public Member Functions

None __init__ (self, AmpioSmogMapData api, str station_id, str|None name)
 
None async_update (self)
 
str name (self)
 
str|None particulate_matter_10 (self)
 
str|None particulate_matter_2_5 (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.air_quality.AirQualityEntity
StateType air_quality_index (self)
 
StateType carbon_dioxide (self)
 
StateType carbon_monoxide (self)
 
StateType nitrogen_dioxide (self)
 
StateType nitrogen_monoxide (self)
 
StateType nitrogen_oxide (self)
 
StateType ozone (self)
 
StateType particulate_matter_0_1 (self)
 
StateType state (self)
 
dict[str, str|int|float] state_attributes (self)
 
StateType sulphur_dioxide (self)
 
str 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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
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)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (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)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (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)
 

Private Attributes

 _ampio
 
 _name
 
 _station_id
 

Static Private Attributes

string _attr_attribution = "Data provided by Ampio"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Implementation of an Ampio Smog air quality entity.

Definition at line 55 of file air_quality.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ampio.air_quality.AmpioSmogQuality.__init__ (   self,
AmpioSmogMapData  api,
str  station_id,
str | None   name 
)
Initialize the air quality entity.

Definition at line 60 of file air_quality.py.

Member Function Documentation

◆ async_update()

None homeassistant.components.ampio.air_quality.AmpioSmogQuality.async_update (   self)
Get the latest data from the AmpioMap API.

Definition at line 88 of file air_quality.py.

◆ name()

str homeassistant.components.ampio.air_quality.AmpioSmogQuality.name (   self)
Return the name of the air quality entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 69 of file air_quality.py.

◆ particulate_matter_10()

str | None homeassistant.components.ampio.air_quality.AmpioSmogQuality.particulate_matter_10 (   self)
Return the particulate matter 10 level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 84 of file air_quality.py.

◆ particulate_matter_2_5()

str | None homeassistant.components.ampio.air_quality.AmpioSmogQuality.particulate_matter_2_5 (   self)
Return the particulate matter 2.5 level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 79 of file air_quality.py.

◆ unique_id()

str homeassistant.components.ampio.air_quality.AmpioSmogQuality.unique_id (   self)
Return unique_name.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 74 of file air_quality.py.

Member Data Documentation

◆ _ampio

homeassistant.components.ampio.air_quality.AmpioSmogQuality._ampio
private

Definition at line 64 of file air_quality.py.

◆ _attr_attribution

string homeassistant.components.ampio.air_quality.AmpioSmogQuality._attr_attribution = "Data provided by Ampio"
staticprivate

Definition at line 58 of file air_quality.py.

◆ _name

homeassistant.components.ampio.air_quality.AmpioSmogQuality._name
private

Definition at line 66 of file air_quality.py.

◆ _station_id

homeassistant.components.ampio.air_quality.AmpioSmogQuality._station_id
private

Definition at line 65 of file air_quality.py.


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