homeassistant.components.utility_meter.sensor Namespace Reference

Classes
class	UtilityMeterSensor
class	UtilitySensorExtraStoredData

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
def	validate_is_number (value)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_LAST_PERIOD = "last_period"
string	ATTR_LAST_VALID_STATE = "last_valid_state"
string	ATTR_PERIOD = "meter_period"
string	ATTR_SOURCE_ID = "source"
string	ATTR_STATUS = "status"
string	ATTR_TARIFF = "tariff"
string	COLLECTING = "collecting"
string	PAUSED = "paused"
dictionary	PERIOD2CRON
int	PRECISION = 3

Detailed Description

Utility meter from sensors providing raw data.

Function Documentation

async_setup_entry()

None homeassistant.components.utility_meter.sensor.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize Utility Meter config entry.

Definition at line 117 of file sensor.py.

async_setup_platform()

None homeassistant.components.utility_meter.sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the utility meter sensor.

Definition at line 205 of file sensor.py.

validate_is_number()

def homeassistant.components.utility_meter.sensor.validate_is_number

(

value

)

Validate value is a number.

Definition at line 110 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.utility_meter.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 96 of file sensor.py.

ATTR_LAST_PERIOD

string homeassistant.components.utility_meter.sensor.ATTR_LAST_PERIOD = "last_period"

Definition at line 101 of file sensor.py.

ATTR_LAST_VALID_STATE

string homeassistant.components.utility_meter.sensor.ATTR_LAST_VALID_STATE = "last_valid_state"

Definition at line 102 of file sensor.py.

ATTR_PERIOD

string homeassistant.components.utility_meter.sensor.ATTR_PERIOD = "meter_period"

Definition at line 100 of file sensor.py.

ATTR_SOURCE_ID

string homeassistant.components.utility_meter.sensor.ATTR_SOURCE_ID = "source"

Definition at line 98 of file sensor.py.

ATTR_STATUS

string homeassistant.components.utility_meter.sensor.ATTR_STATUS = "status"

Definition at line 99 of file sensor.py.

ATTR_TARIFF

string homeassistant.components.utility_meter.sensor.ATTR_TARIFF = "tariff"

Definition at line 103 of file sensor.py.

COLLECTING

string homeassistant.components.utility_meter.sensor.COLLECTING = "collecting"

Definition at line 107 of file sensor.py.

PAUSED

string homeassistant.components.utility_meter.sensor.PAUSED = "paused"

Definition at line 106 of file sensor.py.

PERIOD2CRON

dictionary homeassistant.components.utility_meter.sensor.PERIOD2CRON

Initial value:

=  {
    QUARTER_HOURLY: "{minute}/15 * * * *",
    HOURLY: "{minute} * * * *",
    DAILY: "{minute} {hour} * * *",
    WEEKLY: "{minute} {hour} * * {day}",
    MONTHLY: "{minute} {hour} {day} * *",
    BIMONTHLY: "{minute} {hour} {day} */2 *",
    QUARTERLY: "{minute} {hour} {day} */3 *",
    YEARLY: "{minute} {hour} {day} 1/12 *",
}

Definition at line 85 of file sensor.py.

PRECISION

int homeassistant.components.utility_meter.sensor.PRECISION = 3

Definition at line 105 of file sensor.py.