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

Public Member Functions

def __init__ (self, api, name, device_id)
 
def air_quality_index (self)
 
def air_quality_index_level (self)
 
def air_quality_index_pollutant (self)
 
def async_added_to_hass (self)
 
def available (self)
 
def carbon_dioxide (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def particulate_matter_10 (self)
 
def particulate_matter_2_5 (self)
 
def unique_id (self)
 
def volatile_organic_compounds (self)
 
- Public Member Functions inherited from homeassistant.components.air_quality.AirQualityEntity
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_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)
 
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)
 
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 Member Functions

def _data (self, key)
 
def _device (self)
 

Private Attributes

 _api
 
 _device_id
 
 _name
 

Static Private Attributes

bool _attr_should_poll = False
 

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 a Kaittera air quality sensor.

Definition at line 38 of file air_quality.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.__init__ (   self,
  api,
  name,
  device_id 
)
Initialize the sensor.

Definition at line 43 of file air_quality.py.

Member Function Documentation

◆ _data()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality._data (   self,
  key 
)
private

Definition at line 49 of file air_quality.py.

◆ _device()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality._device (   self)
private

Definition at line 53 of file air_quality.py.

◆ air_quality_index()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.air_quality_index (   self)
Return the Air Quality Index (AQI).

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 67 of file air_quality.py.

◆ air_quality_index_level()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.air_quality_index_level (   self)
Return the Air Quality Index level.

Definition at line 72 of file air_quality.py.

◆ air_quality_index_pollutant()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.air_quality_index_pollutant (   self)
Return the Air Quality Index level.

Definition at line 77 of file air_quality.py.

◆ async_added_to_hass()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.async_added_to_hass (   self)
Register callback.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 119 of file air_quality.py.

◆ available()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.available (   self)
Return the availability of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 57 of file air_quality.py.

◆ carbon_dioxide()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.carbon_dioxide (   self)
Return the CO2 (carbon dioxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 92 of file air_quality.py.

◆ extra_state_attributes()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.extra_state_attributes (   self)
Return the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 107 of file air_quality.py.

◆ name()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 62 of file air_quality.py.

◆ particulate_matter_10()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.particulate_matter_10 (   self)
Return the particulate matter 10 level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 87 of file air_quality.py.

◆ particulate_matter_2_5()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.particulate_matter_2_5 (   self)
Return the particulate matter 2.5 level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 82 of file air_quality.py.

◆ unique_id()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.unique_id (   self)
Return the sensor's unique id.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 102 of file air_quality.py.

◆ volatile_organic_compounds()

def homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.volatile_organic_compounds (   self)
Return the VOC (Volatile Organic Compounds) level.

Definition at line 97 of file air_quality.py.

Member Data Documentation

◆ _api

homeassistant.components.kaiterra.air_quality.KaiterraAirQuality._api
private

Definition at line 45 of file air_quality.py.

◆ _attr_should_poll

bool homeassistant.components.kaiterra.air_quality.KaiterraAirQuality._attr_should_poll = False
staticprivate

Definition at line 41 of file air_quality.py.

◆ _device_id

homeassistant.components.kaiterra.air_quality.KaiterraAirQuality._device_id
private

Definition at line 47 of file air_quality.py.

◆ _name

homeassistant.components.kaiterra.air_quality.KaiterraAirQuality._name
private

Definition at line 46 of file air_quality.py.


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