Inheritance diagram for homeassistant.components.air_quality.AirQualityEntity:

Collaboration diagram for homeassistant.components.air_quality.AirQualityEntity:

Public Member Functions
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	particulate_matter_10 (self)

StateType	particulate_matter_2_5 (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)

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, str]	translation_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)

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

ABC for air quality data.

Definition at line 76 of file __init__.py.

Member Function Documentation

◆ air_quality_index()

StateType homeassistant.components.air_quality.AirQualityEntity.air_quality_index ( self )

Return the Air Quality Index (AQI).

Reimplemented in homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1, homeassistant.components.norway_air.air_quality.AirSensor, homeassistant.components.nilu.air_quality.NiluSensor, and homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.

Definition at line 95 of file __init__.py.

◆ carbon_dioxide()

StateType homeassistant.components.air_quality.AirQualityEntity.carbon_dioxide ( self )

Return the CO2 (carbon dioxide) level.

Reimplemented in homeassistant.components.xiaomi_miio.air_quality.AirMonitorCGDN1, homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1, homeassistant.components.nilu.air_quality.NiluSensor, and homeassistant.components.kaiterra.air_quality.KaiterraAirQuality.

Definition at line 110 of file __init__.py.

◆ carbon_monoxide()

StateType homeassistant.components.air_quality.AirQualityEntity.carbon_monoxide ( self )

Return the CO (carbon monoxide) level.

Reimplemented in homeassistant.components.nilu.air_quality.NiluSensor.

Definition at line 105 of file __init__.py.

◆ nitrogen_dioxide()

StateType homeassistant.components.air_quality.AirQualityEntity.nitrogen_dioxide ( self )

Return the NO2 (nitrogen dioxide) level.

Reimplemented in homeassistant.components.norway_air.air_quality.AirSensor, and homeassistant.components.nilu.air_quality.NiluSensor.

Definition at line 130 of file __init__.py.

◆ nitrogen_monoxide()

StateType homeassistant.components.air_quality.AirQualityEntity.nitrogen_monoxide ( self )

Return the NO (nitrogen monoxide) level.

Reimplemented in homeassistant.components.nilu.air_quality.NiluSensor.

Definition at line 125 of file __init__.py.

◆ nitrogen_oxide()

StateType homeassistant.components.air_quality.AirQualityEntity.nitrogen_oxide ( self )

Return the N2O (nitrogen oxide) level.

Reimplemented in homeassistant.components.nilu.air_quality.NiluSensor, and homeassistant.components.demo.air_quality.DemoAirQuality.

Definition at line 120 of file __init__.py.

◆ ozone()

StateType homeassistant.components.air_quality.AirQualityEntity.ozone ( self )

Return the O3 (ozone) level.

Reimplemented in homeassistant.components.norway_air.air_quality.AirSensor, and homeassistant.components.nilu.air_quality.NiluSensor.

Definition at line 100 of file __init__.py.

◆ particulate_matter_0_1()

StateType homeassistant.components.air_quality.AirQualityEntity.particulate_matter_0_1 ( self )

Return the particulate matter 0.1 level.

Reimplemented in homeassistant.components.nilu.air_quality.NiluSensor.

Definition at line 90 of file __init__.py.

◆ particulate_matter_10()

StateType homeassistant.components.air_quality.AirQualityEntity.particulate_matter_10 ( self )

Return the particulate matter 10 level.

Reimplemented in homeassistant.components.xiaomi_miio.air_quality.AirMonitorCGDN1, homeassistant.components.opensensemap.air_quality.OpenSenseMapQuality, homeassistant.components.norway_air.air_quality.AirSensor, homeassistant.components.nilu.air_quality.NiluSensor, homeassistant.components.kaiterra.air_quality.KaiterraAirQuality, homeassistant.components.demo.air_quality.DemoAirQuality, and homeassistant.components.ampio.air_quality.AmpioSmogQuality.

Definition at line 85 of file __init__.py.

◆ particulate_matter_2_5()

StateType homeassistant.components.air_quality.AirQualityEntity.particulate_matter_2_5 ( self )

Return the particulate matter 2.5 level.

Definition at line 80 of file __init__.py.

◆ state()

StateType homeassistant.components.air_quality.AirQualityEntity.state ( self )

Return the current state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 147 of file __init__.py.

◆ state_attributes()

dict[str, str | int | float] homeassistant.components.air_quality.AirQualityEntity.state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 136 of file __init__.py.

◆ sulphur_dioxide()

StateType homeassistant.components.air_quality.AirQualityEntity.sulphur_dioxide ( self )

Return the SO2 (sulphur dioxide) level.

Reimplemented in homeassistant.components.nilu.air_quality.NiluSensor.

Definition at line 115 of file __init__.py.

◆ unit_of_measurement()

str homeassistant.components.air_quality.AirQualityEntity.unit_of_measurement ( self )

Return the unit of measurement of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.xiaomi_miio.air_quality.AirMonitorV1, and homeassistant.components.norway_air.air_quality.AirSensor.

Definition at line 152 of file __init__.py.

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

core/homeassistant/components/air_quality/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ air_quality_index()

◆ carbon_dioxide()

◆ carbon_monoxide()

◆ nitrogen_dioxide()

◆ nitrogen_monoxide()

◆ nitrogen_oxide()

◆ ozone()

◆ particulate_matter_0_1()

◆ particulate_matter_10()

◆ particulate_matter_2_5()

◆ state()

◆ state_attributes()

◆ sulphur_dioxide()

◆ unit_of_measurement()