Add documentation for new Zio Ultrasonic Distance Sensor component (#3043)

This commit is contained in:
kahrendt 2023-07-11 00:24:23 -04:00 committed by GitHub
parent e3280e01db
commit 860677d09d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 49 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

View File

@ -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 <https://cdn.sparkfun.com/datasheets/Sensors/Proximity/HCSR04.pdf>`__,
`sparkfun <https://www.sparkfun.com/products/17777>`__)
sensors with ESPHome.
.. figure:: images/zio_ultrasonic.jpg
:align: center
:width: 30.0%
Zio Ultrasonic Distance Sensor.
(Credit: `Sparkfun <https://www.sparkfun.com/products/17777>`__, 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 </components/sensor/ultrasonic>`, measurements are read over the I²C bus.
To use the sensor, first set up an :ref:`I²C Bus <i2c>` 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 <config-sensor>`.
See Also
--------
- :doc:`Ultrasonic Sensor Component </components/sensor/ultrasonic>`
- :ref:`sensor-filters`
- :doc:`template`
- :ghedit:`Edit`

BIN
images/zio_ultrasonic.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -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