homeassistant.components.template.sensor Namespace Reference

Classes
class	SensorTemplate
class	TriggerSensorEntity

Functions
None	_async_create_template_tracking_entities (AddEntitiesCallback async_add_entities, HomeAssistant hass, list[dict] definitions, str|None unique_id_prefix)
SensorTemplate	async_create_preview_sensor (HomeAssistant hass, str name, dict[str, Any] config)
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	extra_validation_checks (val)
list[dict]	rewrite_legacy_to_modern_conf (HomeAssistant hass, dict[str, dict] cfg)
def	validate_last_reset (val)

Variables
	_LOGGER = logging.getLogger(__name__)
dictionary	LEGACY_FIELDS
	LEGACY_SENSOR_SCHEMA
	PLATFORM_SCHEMA
	SENSOR_CONFIG_SCHEMA
	SENSOR_SCHEMA

Detailed Description

Allows the creation of a sensor that breaks out state_attributes.

Function Documentation

_async_create_template_tracking_entities()

None homeassistant.components.template.sensor._async_create_template_tracking_entities ( AddEntitiesCallback  async_add_entities, HomeAssistant  hass, list[dict]  definitions, str | None  unique_id_prefix  )

private

Create the template sensors.

Definition at line 180 of file sensor.py.

async_create_preview_sensor()

SensorTemplate homeassistant.components.template.sensor.async_create_preview_sensor	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	config
	)

Create a preview sensor.

Definition at line 250 of file sensor.py.

async_setup_entry()

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

Initialize config entry.

Definition at line 237 of file sensor.py.

async_setup_platform()

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

Set up the template sensors.

Definition at line 206 of file sensor.py.

extra_validation_checks()

def homeassistant.components.template.sensor.extra_validation_checks

(

val

)

Run extra validation checks.

Definition at line 130 of file sensor.py.

rewrite_legacy_to_modern_conf()

list[dict] homeassistant.components.template.sensor.rewrite_legacy_to_modern_conf	(	HomeAssistant	hass,
		dict[str, dict]	cfg
	)

Rewrite legacy sensor definitions to modern ones.

Definition at line 145 of file sensor.py.

validate_last_reset()

def homeassistant.components.template.sensor.validate_last_reset

(

val

)

Run extra validation checks.

Definition at line 73 of file sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 176 of file sensor.py.

LEGACY_FIELDS

dictionary homeassistant.components.template.sensor.LEGACY_FIELDS

Initial value:

=  {
    CONF_FRIENDLY_NAME_TEMPLATE: CONF_NAME,
    CONF_FRIENDLY_NAME: CONF_NAME,
    CONF_VALUE_TEMPLATE: CONF_STATE,
}

Definition at line 66 of file sensor.py.

LEGACY_SENSOR_SCHEMA

homeassistant.components.template.sensor.LEGACY_SENSOR_SCHEMA

Initial value:

=  vol.All(
    cv.deprecated(ATTR_ENTITY_ID),
    vol.Schema(
        {
            vol.Required(CONF_VALUE_TEMPLATE): cv.template,
            vol.Optional(CONF_ICON_TEMPLATE): cv.template,
            vol.Optional(CONF_ENTITY_PICTURE_TEMPLATE): cv.template,
            vol.Optional(CONF_FRIENDLY_NAME_TEMPLATE): cv.template,
            vol.Optional(CONF_AVAILABILITY_TEMPLATE): cv.template,
            vol.Optional(CONF_ATTRIBUTE_TEMPLATES, default={}): vol.Schema(
                {cv.string: cv.template}
            ),
            vol.Optional(CONF_FRIENDLY_NAME): cv.string,
            vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
            vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
            vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
            vol.Optional(CONF_UNIQUE_ID): cv.string,
        }
    ),
)

Definition at line 108 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.template.sensor.PLATFORM_SCHEMA

Initial value:

=  vol.All(
    SENSOR_PLATFORM_SCHEMA.extend(
        {
            vol.Optional(CONF_TRIGGER): cv.match_all,  # to raise custom warning
            vol.Required(CONF_SENSORS): cv.schema_with_slug_keys(LEGACY_SENSOR_SCHEMA),
        }
    ),
    extra_validation_checks,
)

Definition at line 166 of file sensor.py.

SENSOR_CONFIG_SCHEMA

homeassistant.components.template.sensor.SENSOR_CONFIG_SCHEMA

Initial value:

=  vol.All(
    vol.Schema(
        {
            vol.Required(CONF_STATE): cv.template,
            vol.Optional(CONF_DEVICE_ID): selector.DeviceSelector(),
        }
    ).extend(TEMPLATE_SENSOR_BASE_SCHEMA.schema),
)

Definition at line 99 of file sensor.py.

SENSOR_SCHEMA

homeassistant.components.template.sensor.SENSOR_SCHEMA

Initial value:

=  vol.All(
    vol.Schema(
        {
            vol.Required(CONF_STATE): cv.template,
            vol.Optional(ATTR_LAST_RESET): cv.template,
        }
    )
    .extend(TEMPLATE_SENSOR_BASE_SCHEMA.schema)
    .extend(TEMPLATE_ENTITY_COMMON_SCHEMA.schema),
    validate_last_reset,
)

Definition at line 86 of file sensor.py.