homeassistant.components.derivative.sensor Namespace Reference

Classes
class	DerivativeSensor

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)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_SOURCE_ID = "source"
int	DEFAULT_ROUND = 3
int	DEFAULT_TIME_WINDOW = 0
	PLATFORM_SCHEMA
dictionary	UNIT_PREFIXES
dictionary	UNIT_TIME

Detailed Description

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

Function Documentation

async_setup_entry()

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

Initialize Derivative config entry.

Definition at line 83 of file sensor.py.

async_setup_platform()

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

Set up the derivative sensor.

Definition at line 119 of file sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 43 of file sensor.py.

ATTR_SOURCE_ID

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

Definition at line 45 of file sensor.py.

DEFAULT_ROUND

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

Definition at line 67 of file sensor.py.

DEFAULT_TIME_WINDOW

int homeassistant.components.derivative.sensor.DEFAULT_TIME_WINDOW = 0

Definition at line 68 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.derivative.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_NAME): cv.string,
        vol.Required(CONF_SOURCE): cv.entity_id,
        vol.Optional(CONF_ROUND_DIGITS, default=DEFAULT_ROUND): vol.Coerce(int),
        vol.Optional(CONF_UNIT_PREFIX, default=None): vol.In(UNIT_PREFIXES),
        vol.Optional(CONF_UNIT_TIME, default=UnitOfTime.HOURS): vol.In(UNIT_TIME),
        vol.Optional(CONF_UNIT): cv.string,
        vol.Optional(CONF_TIME_WINDOW, default=DEFAULT_TIME_WINDOW): cv.time_period,
    }
)

Definition at line 70 of file sensor.py.

UNIT_PREFIXES

dictionary homeassistant.components.derivative.sensor.UNIT_PREFIXES

Initial value:

=  {
    None: 1,
    "n": 1e-9,
    "µ": 1e-6,
    "m": 1e-3,
    "k": 1e3,
    "M": 1e6,
    "G": 1e9,
    "T": 1e12,
}

Definition at line 48 of file sensor.py.

UNIT_TIME

dictionary homeassistant.components.derivative.sensor.UNIT_TIME

Initial value:

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

Definition at line 60 of file sensor.py.