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

Classes

class  NetdataAlarms
 
class  NetdataData
 
class  NetdataSensor
 

Functions

None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_DATA_GROUP = "data_group"
 
string CONF_ELEMENT = "element"
 
string CONF_INVERT = "invert"
 
string DEFAULT_HOST = "localhost"
 
string DEFAULT_ICON = "mdi:desktop-classic"
 
string DEFAULT_NAME = "Netdata"
 
int DEFAULT_PORT = 19999
 
 PLATFORM_SCHEMA
 
 RESOURCE_SCHEMA
 

Detailed Description

Support gathering system information of hosts which are running netdata.

Function Documentation

◆ async_setup_platform()

None homeassistant.components.netdata.sensor.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Netdata sensor.

Definition at line 61 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.netdata.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 30 of file sensor.py.

◆ CONF_DATA_GROUP

string homeassistant.components.netdata.sensor.CONF_DATA_GROUP = "data_group"

Definition at line 32 of file sensor.py.

◆ CONF_ELEMENT

string homeassistant.components.netdata.sensor.CONF_ELEMENT = "element"

Definition at line 33 of file sensor.py.

◆ CONF_INVERT

string homeassistant.components.netdata.sensor.CONF_INVERT = "invert"

Definition at line 34 of file sensor.py.

◆ DEFAULT_HOST

string homeassistant.components.netdata.sensor.DEFAULT_HOST = "localhost"

Definition at line 36 of file sensor.py.

◆ DEFAULT_ICON

string homeassistant.components.netdata.sensor.DEFAULT_ICON = "mdi:desktop-classic"

Definition at line 40 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.netdata.sensor.DEFAULT_NAME = "Netdata"

Definition at line 37 of file sensor.py.

◆ DEFAULT_PORT

int homeassistant.components.netdata.sensor.DEFAULT_PORT = 19999

Definition at line 38 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.netdata.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
4  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
5  vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
6  vol.Required(CONF_RESOURCES): vol.Schema({cv.string: RESOURCE_SCHEMA}),
7  }
8 )

Definition at line 51 of file sensor.py.

◆ RESOURCE_SCHEMA

homeassistant.components.netdata.sensor.RESOURCE_SCHEMA
Initial value:
1 = vol.Any(
2  {
3  vol.Required(CONF_DATA_GROUP): cv.string,
4  vol.Required(CONF_ELEMENT): cv.string,
5  vol.Optional(CONF_ICON, default=DEFAULT_ICON): cv.icon,
6  vol.Optional(CONF_INVERT, default=False): cv.boolean,
7  }
8 )

Definition at line 42 of file sensor.py.