Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.netdata.sensor.NetdataSensor Class Reference
Inheritance diagram for homeassistant.components.netdata.sensor.NetdataSensor:
[legend]
Collaboration diagram for homeassistant.components.netdata.sensor.NetdataSensor:
[legend]

Public Member Functions

def __init__ (self, netdata, name, sensor, sensor_name, element, icon, unit, invert)
 
None async_update (self)
 
bool available (self)
 
def icon (self)
 
def name (self)
 
def native_unit_of_measurement (self)
 
def native_value (self)
 
- Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
dict[str, Any]|None capability_attributes (self)
 
SensorDeviceClass|None device_class (self)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
datetime|None last_reset (self)
 
list[str]|None options (self)
 
Any state (self)
 
dict[str, Any]|None state_attributes (self)
 
SensorStateClass|str|None state_class (self)
 
int|None suggested_display_precision (self)
 
str|None suggested_unit_of_measurement (self)
 
str|None 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)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
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)
 
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)
 
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)
 
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)
 

Public Attributes

 netdata
 
- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _element
 
 _icon
 
 _invert
 
 _name
 
 _sensor
 
 _sensor_name
 
 _state
 
 _unit_of_measurement
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Implementation of a Netdata sensor.

Definition at line 110 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.netdata.sensor.NetdataSensor.__init__ (   self,
  netdata,
  name,
  sensor,
  sensor_name,
  element,
  icon,
  unit,
  invert 
)
Initialize the Netdata sensor.

Definition at line 113 of file sensor.py.

Member Function Documentation

◆ async_update()

None homeassistant.components.netdata.sensor.NetdataSensor.async_update (   self)
Get the latest data from Netdata REST API.

Definition at line 150 of file sensor.py.

◆ available()

bool homeassistant.components.netdata.sensor.NetdataSensor.available (   self)
Could the resource be accessed during the last update call.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 146 of file sensor.py.

◆ icon()

def homeassistant.components.netdata.sensor.NetdataSensor.icon (   self)
Return the icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 136 of file sensor.py.

◆ name()

def homeassistant.components.netdata.sensor.NetdataSensor.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 126 of file sensor.py.

◆ native_unit_of_measurement()

def homeassistant.components.netdata.sensor.NetdataSensor.native_unit_of_measurement (   self)
Return the unit the value is expressed in.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 131 of file sensor.py.

◆ native_value()

def homeassistant.components.netdata.sensor.NetdataSensor.native_value (   self)
Return the state of the resources.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 141 of file sensor.py.

Member Data Documentation

◆ _element

homeassistant.components.netdata.sensor.NetdataSensor._element
private

Definition at line 118 of file sensor.py.

◆ _icon

homeassistant.components.netdata.sensor.NetdataSensor._icon
private

Definition at line 121 of file sensor.py.

◆ _invert

homeassistant.components.netdata.sensor.NetdataSensor._invert
private

Definition at line 123 of file sensor.py.

◆ _name

homeassistant.components.netdata.sensor.NetdataSensor._name
private

Definition at line 120 of file sensor.py.

◆ _sensor

homeassistant.components.netdata.sensor.NetdataSensor._sensor
private

Definition at line 117 of file sensor.py.

◆ _sensor_name

homeassistant.components.netdata.sensor.NetdataSensor._sensor_name
private

Definition at line 119 of file sensor.py.

◆ _state

homeassistant.components.netdata.sensor.NetdataSensor._state
private

Definition at line 116 of file sensor.py.

◆ _unit_of_measurement

homeassistant.components.netdata.sensor.NetdataSensor._unit_of_measurement
private

Definition at line 122 of file sensor.py.

◆ netdata

homeassistant.components.netdata.sensor.NetdataSensor.netdata

Definition at line 115 of file sensor.py.


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