homeassistant.components.integration.sensor Namespace Reference

Classes
class	_IntegrationMethod
class	_IntegrationTrigger
class	_Left
class	_Right
class	_Trapezoidal
class	IntegrationSensor
class	IntegrationSensorExtraStoredData

Functions
Decimal|None	_decimal_state (str state)
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)

Variables
	_LOGGER = logging.getLogger(__name__)
int	DEFAULT_ROUND = 3
dictionary	DEVICE_CLASS_MAP
	Final
	PLATFORM_SCHEMA
dictionary	UNIT_PREFIXES = {None: 1, "k": 10**3, "M": 10**6, "G": 10**9, "T": 10**12}
dictionary	UNIT_TIME

Detailed Description

Numeric integration of data coming from a source sensor over time.

Function Documentation

_decimal_state()

Decimal | None homeassistant.components.integration.sensor._decimal_state ( str  state )

private

Definition at line 168 of file sensor.py.

async_setup_entry()

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

Initialize Integration - Riemann sum integral config entry.

Definition at line 234 of file sensor.py.

async_setup_platform()

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

Set up the integration sensor.

Definition at line 279 of file sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 66 of file sensor.py.

DEFAULT_ROUND

int homeassistant.components.integration.sensor.DEFAULT_ROUND = 3

Definition at line 85 of file sensor.py.

DEVICE_CLASS_MAP

dictionary homeassistant.components.integration.sensor.DEVICE_CLASS_MAP

Initial value:

=  {
    SensorDeviceClass.POWER: SensorDeviceClass.ENERGY,
}

Definition at line 81 of file sensor.py.

Final

homeassistant.components.integration.sensor.Final

Definition at line 68 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.integration.sensor.PLATFORM_SCHEMA

Initial value:

=  vol.All(
    cv.removed(CONF_UNIT_OF_MEASUREMENT),
    SENSOR_PLATFORM_SCHEMA.extend(
        {
            vol.Optional(CONF_NAME): cv.string,
            vol.Optional(CONF_UNIQUE_ID): cv.string,
            vol.Required(CONF_SOURCE_SENSOR): cv.entity_id,
            vol.Optional(CONF_ROUND_DIGITS, default=DEFAULT_ROUND): vol.Any(
                None, vol.Coerce(int)
            ),
            vol.Optional(CONF_UNIT_PREFIX): vol.In(UNIT_PREFIXES),
            vol.Optional(CONF_UNIT_TIME, default=UnitOfTime.HOURS): vol.In(UNIT_TIME),
            vol.Remove(CONF_UNIT_OF_MEASUREMENT): cv.string,
            vol.Optional(CONF_MAX_SUB_INTERVAL): cv.positive_time_period,
            vol.Optional(CONF_METHOD, default=METHOD_TRAPEZOIDAL): vol.In(
                INTEGRATION_METHODS
            ),
        }
    ),
)

Definition at line 87 of file sensor.py.

UNIT_PREFIXES

dictionary homeassistant.components.integration.sensor.UNIT_PREFIXES = {None: 1, "k": 10**3, "M": 10**6, "G": 10**9, "T": 10**12}

Definition at line 71 of file sensor.py.

UNIT_TIME

dictionary homeassistant.components.integration.sensor.UNIT_TIME

Initial value:

=  {
    UnitOfTime.SECONDS: 1,
    UnitOfTime.MINUTES: 60,
    UnitOfTime.HOURS: 60 * 60,
    UnitOfTime.DAYS: 24 * 60 * 60,
}

Definition at line 74 of file sensor.py.