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

Public Member Functions

def __init__ (self, name, device, entry, unique_id)
 
def air_quality_index (self)
 
def async_update (self)
 
def available (self)
 
def carbon_dioxide (self)
 
def carbon_dioxide_equivalent (self)
 
def extra_state_attributes (self)
 
def humidity (self)
 
def icon (self)
 
def particulate_matter_2_5 (self)
 
def temperature (self)
 
def total_volatile_organic_compounds (self)
 
- Public Member Functions inherited from homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity
DeviceInfo device_info (self)
 
def name (self)
 
def unique_id (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)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (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)
 
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 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 particulate_matter_10 (self)
 
StateType state (self)
 
dict[str, str|int|float] state_attributes (self)
 
StateType sulphur_dioxide (self)
 
str unit_of_measurement (self)
 

Private Attributes

 _air_quality_index
 
 _available
 
 _carbon_dioxide
 
 _carbon_dioxide_equivalent
 
 _humidity
 
 _icon
 
 _particulate_matter_2_5
 
 _temperature
 
 _total_volatile_organic_compounds
 

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

Air Quality class for Xiaomi cgllc.airmonitor.b1 device.

Definition at line 40 of file air_quality.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.__init__ (   self,
  name,
  device,
  entry,
  unique_id 
)
Initialize the entity.

Reimplemented from homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity.

Definition at line 43 of file air_quality.py.

Member Function Documentation

◆ air_quality_index()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.air_quality_index (   self)
Return the Air Quality Index (AQI).

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 83 of file air_quality.py.

◆ async_update()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.async_update (   self)

◆ available()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.available (   self)
Return true when state is known.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 78 of file air_quality.py.

◆ carbon_dioxide()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.carbon_dioxide (   self)
Return the CO2 (carbon dioxide) level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 88 of file air_quality.py.

◆ carbon_dioxide_equivalent()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.carbon_dioxide_equivalent (   self)
Return the CO2e (carbon dioxide equivalent) level.

Definition at line 93 of file air_quality.py.

◆ extra_state_attributes()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 118 of file air_quality.py.

◆ humidity()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.humidity (   self)
Return the current humidity.

Definition at line 113 of file air_quality.py.

◆ icon()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.icon (   self)
Return the icon to use for device if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 73 of file air_quality.py.

◆ particulate_matter_2_5()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.particulate_matter_2_5 (   self)
Return the particulate matter 2.5 level.

Reimplemented from homeassistant.components.air_quality.AirQualityEntity.

Definition at line 98 of file air_quality.py.

◆ temperature()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.temperature (   self)
Return the current temperature.

Definition at line 108 of file air_quality.py.

◆ total_volatile_organic_compounds()

def homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1.total_volatile_organic_compounds (   self)
Return the total volatile organic compounds.

Definition at line 103 of file air_quality.py.

Member Data Documentation

◆ _air_quality_index

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._air_quality_index
private

Definition at line 49 of file air_quality.py.

◆ _available

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._available
private

Definition at line 48 of file air_quality.py.

◆ _carbon_dioxide

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._carbon_dioxide
private

Definition at line 50 of file air_quality.py.

◆ _carbon_dioxide_equivalent

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._carbon_dioxide_equivalent
private

Definition at line 51 of file air_quality.py.

◆ _humidity

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._humidity
private

Definition at line 55 of file air_quality.py.

◆ _icon

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._icon
private

Definition at line 47 of file air_quality.py.

◆ _particulate_matter_2_5

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._particulate_matter_2_5
private

Definition at line 52 of file air_quality.py.

◆ _temperature

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._temperature
private

Definition at line 54 of file air_quality.py.

◆ _total_volatile_organic_compounds

homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1._total_volatile_organic_compounds
private

Definition at line 53 of file air_quality.py.


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