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

Classes

class  EBoxData
 
class  EBoxSensor
 

Functions

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

Variables

 _LOGGER = logging.getLogger(__name__)
 
string DEFAULT_NAME = "EBox"
 
 MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=15)
 
 PLATFORM_SCHEMA
 
string PRICE = "CAD"
 
int REQUESTS_TIMEOUT = 15
 
 SCAN_INTERVAL = timedelta(minutes=15)
 

Detailed Description

Support for EBox.

Get data from 'My Usage Page' page: https://client.ebox.ca/myusage

Function Documentation

◆ async_setup_platform()

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

Definition at line 154 of file sensor.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 38 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.ebox.sensor.DEFAULT_NAME = "EBox"

Definition at line 42 of file sensor.py.

◆ MIN_TIME_BETWEEN_UPDATES

homeassistant.components.ebox.sensor.MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=15)

Definition at line 46 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.ebox.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_MONITORED_VARIABLES): vol.All(
4  cv.ensure_list, [vol.In(SENSOR_TYPE_KEYS)]
5  ),
6  vol.Required(CONF_USERNAME): cv.string,
7  vol.Required(CONF_PASSWORD): cv.string,
8  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
9  }
10 )

Definition at line 142 of file sensor.py.

◆ PRICE

string homeassistant.components.ebox.sensor.PRICE = "CAD"

Definition at line 40 of file sensor.py.

◆ REQUESTS_TIMEOUT

int homeassistant.components.ebox.sensor.REQUESTS_TIMEOUT = 15

Definition at line 44 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.ebox.sensor.SCAN_INTERVAL = timedelta(minutes=15)

Definition at line 45 of file sensor.py.