Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hassio.sensor Namespace Reference

Classes

class  CoreSensor
 
class  HassioAddonSensor
 
class  HassioOSSensor
 
class  HostSensor
 
class  SupervisorSensor
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

tuple ADDON_ENTITY_DESCRIPTIONS = COMMON_ENTITY_DESCRIPTIONS + STATS_ENTITY_DESCRIPTIONS
 
tuple COMMON_ENTITY_DESCRIPTIONS
 
tuple CORE_ENTITY_DESCRIPTIONS = STATS_ENTITY_DESCRIPTIONS
 
tuple HOST_ENTITY_DESCRIPTIONS
 
tuple OS_ENTITY_DESCRIPTIONS = COMMON_ENTITY_DESCRIPTIONS
 
tuple STATS_ENTITY_DESCRIPTIONS
 
tuple SUPERVISOR_ENTITY_DESCRIPTIONS = STATS_ENTITY_DESCRIPTIONS
 

Detailed Description

Sensor platform for Hass.io addons.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.hassio.sensor.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Sensor set up for Hass.io config entry.

Definition at line 111 of file sensor.py.

Variable Documentation

◆ ADDON_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.ADDON_ENTITY_DESCRIPTIONS = COMMON_ENTITY_DESCRIPTIONS + STATS_ENTITY_DESCRIPTIONS

Definition at line 66 of file sensor.py.

◆ COMMON_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.COMMON_ENTITY_DESCRIPTIONS
Initial value:
1 = (
2  SensorEntityDescription(
3  entity_registry_enabled_default=False,
4  key=ATTR_VERSION,
5  translation_key="version",
6  ),
7  SensorEntityDescription(
8  entity_registry_enabled_default=False,
9  key=ATTR_VERSION_LATEST,
10  translation_key="version_latest",
11  ),
12 )

Definition at line 36 of file sensor.py.

◆ CORE_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.CORE_ENTITY_DESCRIPTIONS = STATS_ENTITY_DESCRIPTIONS

Definition at line 67 of file sensor.py.

◆ HOST_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.HOST_ENTITY_DESCRIPTIONS

Definition at line 71 of file sensor.py.

◆ OS_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.OS_ENTITY_DESCRIPTIONS = COMMON_ENTITY_DESCRIPTIONS

Definition at line 68 of file sensor.py.

◆ STATS_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.STATS_ENTITY_DESCRIPTIONS
Initial value:
1 = (
2  SensorEntityDescription(
3  entity_registry_enabled_default=False,
4  key=ATTR_CPU_PERCENT,
5  translation_key="cpu_percent",
6  native_unit_of_measurement=PERCENTAGE,
7  state_class=SensorStateClass.MEASUREMENT,
8  ),
9  SensorEntityDescription(
10  entity_registry_enabled_default=False,
11  key=ATTR_MEMORY_PERCENT,
12  translation_key="memory_percent",
13  native_unit_of_measurement=PERCENTAGE,
14  state_class=SensorStateClass.MEASUREMENT,
15  ),
16 )

Definition at line 49 of file sensor.py.

◆ SUPERVISOR_ENTITY_DESCRIPTIONS

tuple homeassistant.components.hassio.sensor.SUPERVISOR_ENTITY_DESCRIPTIONS = STATS_ENTITY_DESCRIPTIONS

Definition at line 69 of file sensor.py.