Template Sensor

The template sensor platform allows you to create a sensor with templated values using lambdas.

# Example configuration entry
sensor:
  - platform: template
    name: "Template Sensor"
    lambda: |-
      if (id(some_binary_sensor).state) {
        return 42.0;
      } else {
        return 0.0;
      }
    update_interval: 60s

Possible return values for the lambda:

  • return <FLOATING_POINT_NUMBER>; the new value for the sensor.

  • return NAN; if the state should be considered invalid to indicate an error (advanced).

  • return {}; if you don’t want to publish a new state (advanced).

Configuration variables:

  • name (Required, string): The name of the sensor.

  • lambda (Optional, lambda): Lambda to be evaluated every update interval to get the new value of the sensor

  • update_interval (Optional, Time): The interval to publish the value of the sensor, either the result of the lambda function or if no lambda function the last value published using the publish action. Defaults to 60s.

  • id (Optional, ID): Manually specify the ID used for code generation.

  • All other options from Sensor.

sensor.template.publish Action

You can also publish a state to a template sensor from elsewhere in your YAML file with the sensor.template.publish action.

# Example configuration entry
sensor:
  - platform: template
    name: "Template Sensor"
    id: template_sens

# in some trigger
on_...:
  - sensor.template.publish:
      id: template_sens
      state: 42.0

  # Templated
  - sensor.template.publish:
      id: template_sens
      state: !lambda 'return 42.0;'

Configuration options:

  • id (Required, ID): The ID of the template sensor.

  • state (Required, float, templatable): The state to publish.

Note

This action can also be written in lambdas:

id(template_sens).publish_state(42.0);

See Also