Template Binary Sensor

The template binary sensor platform allows you to define any lambda template and construct a binary sensor out if it.

For example, below configuration would turn the state of an ultrasonic sensor into a binary sensor.

# Example configuration entry
binary_sensor:
  - platform: template
    name: "Garage Door Open"
    lambda: >-
      if (isnan(id(ultrasonic_sensor1).state)) {
        // isnan checks if the ultrasonic sensor echo
        // has timed out, resulting in a NaN (not a number) state
        // in that case, return {} to indicate that we don't know.
        return {};
      } else if (id(ultrasonic_sensor1).state > 30) {
        // Garage Door is open.
        return true;
      } else {
        // Garage Door is closed.
        return false;
      }

Possible return values of the lambda:

  • return true; if the binary sensor should be ON.
  • return false; if the binary sensor should be OFF.
  • return {}; if the last state should be repeated.

Configuration variables:

  • name (Required, string): The name of the binary sensor.
  • lambda (Required, lambda): Lambda to be evaluated repeatedly to get the current state of the binary sensor. Only state changes will be published to MQTT.
  • id (Optional, ID): Manually specify the ID used for code generation.
  • All other options from Binary Sensor and MQTT Component.