diff --git a/components/sensor/images/zio_ultrasonic.jpg b/components/sensor/images/zio_ultrasonic.jpg new file mode 100644 index 000000000..b1eb1e09d Binary files /dev/null and b/components/sensor/images/zio_ultrasonic.jpg differ diff --git a/components/sensor/zio_ultrasonic.rst b/components/sensor/zio_ultrasonic.rst new file mode 100644 index 000000000..39dfb3844 --- /dev/null +++ b/components/sensor/zio_ultrasonic.rst @@ -0,0 +1,48 @@ +Zio Ultrasonic Distance Sensor +============================== + +.. seo:: + :description: Instructions for setting up the Zio Ultrasonic Distance sensor. + :image: zio_ultrasonic.jpg + :keywords: ultrasonic, i2c + +The Zio Ultrasonic Distance sensor allows you to use your compatible +(`datasheet `__, +`sparkfun `__) +sensors with ESPHome. + +.. figure:: images/zio_ultrasonic.jpg + :align: center + :width: 30.0% + + Zio Ultrasonic Distance Sensor. + (Credit: `Sparkfun `__, image cropped and compressed) + +.. _Sparkfun: https://www.sparkfun.com/products/17777 + +The Zio Ultrasonic Distance Sensor is an ultrasonic distance sensor based on the HC-SR04 sensor. Unlike the :doc:`Ultrasonic Distance Sensor component `, measurements are read over the I²C bus. + +To use the sensor, first set up an :ref:`I²C Bus ` and connect the sensor to the specified pins. + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: zio_ultrasonic + name: "Distance" + update_interval: 60s + +Configuration variables: +------------------------ + +- **address** (*Optional*, int): Manually specifiy the I²C address of the sensor. Defaults to ``0x00``. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. +- All other options from :ref:`Sensor `. + +See Also +-------- + +- :doc:`Ultrasonic Sensor Component ` +- :ref:`sensor-filters` +- :doc:`template` +- :ghedit:`Edit` diff --git a/images/zio_ultrasonic.jpg b/images/zio_ultrasonic.jpg new file mode 100644 index 000000000..5cf4211a8 Binary files /dev/null and b/images/zio_ultrasonic.jpg differ diff --git a/index.rst b/index.rst index 26fed9ebf..4f76bdb47 100644 --- a/index.rst +++ b/index.rst @@ -240,6 +240,7 @@ Distance TOF10120, components/sensor/tof10120, tof10120.jpg, IR optical distance Ultrasonic Sensor, components/sensor/ultrasonic, ultrasonic.jpg, Acoustic distance VL53L0x, components/sensor/vl53l0x, vl53l0x.jpg, IR optical distance + Zio Ultrasonic Sensor, components/sensor/zio_ultrasonic, zio_ultrasonic.jpg, Acoustic distance Electricity