Ultrasonic Distance Sensor

The ultrasonic distance sensor allows you to use simple ultrasonic sensors like the HC-SR04 (datasheet, sparkfun) with ESPHome to measure distances. These sensors usually can’t measure anything more than about two meters and may sometimes make some annoying clicking sounds.

This sensor platform expects a sensor that can be sent a trigger pulse on a specific pin and will send out a echo pulse once a measurement has been taken. Because sometimes (for example if no object is detected) the echo pulse is never returned, this sensor also has a timeout option which specifies how long to wait for values.

../../_images/ultrasonic-full.jpg

HC-SR04 Ultrasonic Distance Sensor.

../../_images/ultrasonic-ui.png
# Example configuration entry
sensor:
  - platform: ultrasonic
    trigger_pin: D1
    echo_pin: D2
    name: "Ultrasonic Sensor"

Configuration variables:

  • trigger_pin (Required, Pin Schema): The output pin to periodically send the trigger pulse to.
  • echo_pin (Required, Pin Schema): The input pin on which to wait for the echo.
  • name (Required, string): The name of the sensor.
  • update_interval (Optional, Time): The interval to check the sensor. Defaults to 60s.
  • All other options from Sensor.

Advanced options:

  • timeout (Optional, float): The number of meters for the timeout. Most sensors can only sense up to 2 meters. Defaults to 2 meters.
  • pulse_time (Optional, Time): The duration for which the trigger pin will be active. Defaults to 10us.
  • id (Optional, ID): Manually specify the ID used for code generation.