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

Classes

class  EmonCmsSensor
 

Functions

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

Variables

string ATTR_FEEDID = "FeedId"
 
string ATTR_FEEDNAME = "FeedName"
 
string ATTR_LASTUPDATETIME = "LastUpdated"
 
string ATTR_LASTUPDATETIMESTR = "LastUpdatedStr"
 
string ATTR_SIZE = "Size"
 
string ATTR_TAG = "Tag"
 
string ATTR_USERID = "UserId"
 
string CONF_SENSOR_NAMES = "sensor_names"
 
int DECIMALS = 2
 
 DEFAULT_UNIT = UnitOfPower.WATT
 
 device_class
 
 key
 
 native_unit_of_measurement
 
string ONLY_INCL_EXCL_NONE = "only_include_exclude_or_none"
 
 PLATFORM_SCHEMA
 
 state_class
 
 translation_key
 

Detailed Description

Support for monitoring emoncms feeds.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.emoncms.sensor.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
)
Set up the emoncms sensors.

Definition at line 290 of file sensor.py.

◆ async_setup_platform()

None homeassistant.components.emoncms.sensor.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Import config from yaml.

Definition at line 232 of file sensor.py.

Variable Documentation

◆ ATTR_FEEDID

string homeassistant.components.emoncms.sensor.ATTR_FEEDID = "FeedId"

Definition at line 199 of file sensor.py.

◆ ATTR_FEEDNAME

string homeassistant.components.emoncms.sensor.ATTR_FEEDNAME = "FeedName"

Definition at line 200 of file sensor.py.

◆ ATTR_LASTUPDATETIME

string homeassistant.components.emoncms.sensor.ATTR_LASTUPDATETIME = "LastUpdated"

Definition at line 201 of file sensor.py.

◆ ATTR_LASTUPDATETIMESTR

string homeassistant.components.emoncms.sensor.ATTR_LASTUPDATETIMESTR = "LastUpdatedStr"

Definition at line 202 of file sensor.py.

◆ ATTR_SIZE

string homeassistant.components.emoncms.sensor.ATTR_SIZE = "Size"

Definition at line 203 of file sensor.py.

◆ ATTR_TAG

string homeassistant.components.emoncms.sensor.ATTR_TAG = "Tag"

Definition at line 204 of file sensor.py.

◆ ATTR_USERID

string homeassistant.components.emoncms.sensor.ATTR_USERID = "UserId"

Definition at line 205 of file sensor.py.

◆ CONF_SENSOR_NAMES

string homeassistant.components.emoncms.sensor.CONF_SENSOR_NAMES = "sensor_names"

Definition at line 206 of file sensor.py.

◆ DECIMALS

int homeassistant.components.emoncms.sensor.DECIMALS = 2

Definition at line 207 of file sensor.py.

◆ DEFAULT_UNIT

homeassistant.components.emoncms.sensor.DEFAULT_UNIT = UnitOfPower.WATT

Definition at line 208 of file sensor.py.

◆ device_class

homeassistant.components.emoncms.sensor.device_class

Definition at line 63 of file sensor.py.

◆ key

homeassistant.components.emoncms.sensor.key

Definition at line 61 of file sensor.py.

◆ native_unit_of_measurement

homeassistant.components.emoncms.sensor.native_unit_of_measurement

Definition at line 64 of file sensor.py.

◆ ONLY_INCL_EXCL_NONE

string homeassistant.components.emoncms.sensor.ONLY_INCL_EXCL_NONE = "only_include_exclude_or_none"

Definition at line 210 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.emoncms.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_API_KEY): cv.string,
4  vol.Required(CONF_URL): cv.string,
5  vol.Required(CONF_ID): cv.positive_int,
6  vol.Exclusive(CONF_ONLY_INCLUDE_FEEDID, ONLY_INCL_EXCL_NONE): vol.All(
7  cv.ensure_list, [cv.positive_int]
8  ),
9  vol.Exclusive(CONF_EXCLUDE_FEEDID, ONLY_INCL_EXCL_NONE): vol.All(
10  cv.ensure_list, [cv.positive_int]
11  ),
12  vol.Optional(CONF_SENSOR_NAMES): vol.All(
13  {cv.positive_int: vol.All(cv.string, vol.Length(min=1))}
14  ),
15  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
16  vol.Optional(CONF_UNIT_OF_MEASUREMENT, default=DEFAULT_UNIT): cv.string,
17  }
18 )

Definition at line 212 of file sensor.py.

◆ state_class

homeassistant.components.emoncms.sensor.state_class

Definition at line 65 of file sensor.py.

◆ translation_key

homeassistant.components.emoncms.sensor.translation_key

Definition at line 62 of file sensor.py.