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

Public Member Functions

None __init__ (self, NiluData api_data, str name, bool show_on_map)
 
str|None air_quality_index (self)
 
str|None carbon_dioxide (self)
 
str|None carbon_monoxide (self)
 
dict extra_state_attributes (self)
 
str|None get_component_state (self, str component_name)
 
str name (self)
 
str|None nitrogen_dioxide (self)
 
str|None nitrogen_monoxide (self)
 
str|None nitrogen_oxide (self)
 
str|None ozone (self)
 
str|None particulate_matter_0_1 (self)
 
str|None particulate_matter_10 (self)
 
str|None particulate_matter_2_5 (self)
 
str|None sulphur_dioxide (self)
 
None update (self)
 
- Public Member Functions inherited from homeassistant.components.air_quality.AirQualityEntity
StateType state (self)
 
dict[str, str|int|float] state_attributes (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)
 
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)
 
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)
 

Private Attributes

 _api
 
 _attrs
 
 _max_aqi
 
 _name
 

Static Private Attributes

string _attr_attribution = "Data provided by luftkvalitet.info and nilu.no"
 

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

Single nilu station air sensor.

Definition at line 176 of file air_quality.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.nilu.air_quality.NiluSensor.__init__ (   self,
NiluData  api_data,
str  name,
bool  show_on_map 
)
Initialize the sensor.

Definition at line 181 of file air_quality.py.

Member Function Documentation

◆ air_quality_index()

str | None homeassistant.components.nilu.air_quality.NiluSensor.air_quality_index (   self)
Return the Air Quality Index (AQI).

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 203 of file air_quality.py.

◆ carbon_dioxide()

str | None homeassistant.components.nilu.air_quality.NiluSensor.carbon_dioxide (   self)
Return the CO2 (carbon dioxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 213 of file air_quality.py.

◆ carbon_monoxide()

str | None homeassistant.components.nilu.air_quality.NiluSensor.carbon_monoxide (   self)
Return the CO (carbon monoxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 208 of file air_quality.py.

◆ extra_state_attributes()

dict homeassistant.components.nilu.air_quality.NiluSensor.extra_state_attributes (   self)
Return other details about the sensor state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 193 of file air_quality.py.

◆ get_component_state()

str | None homeassistant.components.nilu.air_quality.NiluSensor.get_component_state (   self,
str  component_name 
)
Return formatted value of specified component.

Definition at line 257 of file air_quality.py.

◆ name()

str homeassistant.components.nilu.air_quality.NiluSensor.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 198 of file air_quality.py.

◆ nitrogen_dioxide()

str | None homeassistant.components.nilu.air_quality.NiluSensor.nitrogen_dioxide (   self)
Return the NO2 (nitrogen dioxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 228 of file air_quality.py.

◆ nitrogen_monoxide()

str | None homeassistant.components.nilu.air_quality.NiluSensor.nitrogen_monoxide (   self)
Return the NO (nitrogen monoxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 223 of file air_quality.py.

◆ nitrogen_oxide()

str | None homeassistant.components.nilu.air_quality.NiluSensor.nitrogen_oxide (   self)
Return the N2O (nitrogen oxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 218 of file air_quality.py.

◆ ozone()

str | None homeassistant.components.nilu.air_quality.NiluSensor.ozone (   self)
Return the O3 (ozone) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 233 of file air_quality.py.

◆ particulate_matter_0_1()

str | None homeassistant.components.nilu.air_quality.NiluSensor.particulate_matter_0_1 (   self)
Return the particulate matter 0.1 level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 248 of file air_quality.py.

◆ particulate_matter_10()

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

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 243 of file air_quality.py.

◆ particulate_matter_2_5()

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

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 238 of file air_quality.py.

◆ sulphur_dioxide()

str | None homeassistant.components.nilu.air_quality.NiluSensor.sulphur_dioxide (   self)
Return the SO2 (sulphur dioxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 253 of file air_quality.py.

◆ update()

None homeassistant.components.nilu.air_quality.NiluSensor.update (   self)
Update the sensor.

Definition at line 264 of file air_quality.py.

Member Data Documentation

◆ _api

homeassistant.components.nilu.air_quality.NiluSensor._api
private

Definition at line 183 of file air_quality.py.

◆ _attr_attribution

string homeassistant.components.nilu.air_quality.NiluSensor._attr_attribution = "Data provided by luftkvalitet.info and nilu.no"
staticprivate

Definition at line 179 of file air_quality.py.

◆ _attrs

homeassistant.components.nilu.air_quality.NiluSensor._attrs
private

Definition at line 186 of file air_quality.py.

◆ _max_aqi

homeassistant.components.nilu.air_quality.NiluSensor._max_aqi
private

Definition at line 185 of file air_quality.py.

◆ _name

homeassistant.components.nilu.air_quality.NiluSensor._name
private

Definition at line 184 of file air_quality.py.


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