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

Classes

class  StartcaData
 
class  StartcaSensor
 

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_TOTAL_BANDWIDTH = "total_bandwidth"
 
string DEFAULT_NAME = "Start.ca"
 
 MIN_TIME_BETWEEN_UPDATES = timedelta(hours=1)
 
 PLATFORM_SCHEMA
 
int REQUEST_TIMEOUT = 5
 

Detailed Description

Support for Start.ca Bandwidth Monitor.

Function Documentation

◆ async_setup_platform()

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

Definition at line 142 of file sensor.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 34 of file sensor.py.

◆ CONF_TOTAL_BANDWIDTH

string homeassistant.components.startca.sensor.CONF_TOTAL_BANDWIDTH = "total_bandwidth"

Definition at line 37 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.startca.sensor.DEFAULT_NAME = "Start.ca"

Definition at line 36 of file sensor.py.

◆ MIN_TIME_BETWEEN_UPDATES

homeassistant.components.startca.sensor.MIN_TIME_BETWEEN_UPDATES = timedelta(hours=1)

Definition at line 39 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.startca.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_KEYS)]
5  ),
6  vol.Required(CONF_API_KEY): cv.string,
7  vol.Required(CONF_TOTAL_BANDWIDTH): cv.positive_int,
8  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
9  }
10 )

Definition at line 130 of file sensor.py.

◆ REQUEST_TIMEOUT

int homeassistant.components.startca.sensor.REQUEST_TIMEOUT = 5

Definition at line 40 of file sensor.py.