2023-09-06 00:02:45 +02:00
|
|
|
HRXL/XL MaxSonar WR Series
|
|
|
|
|
==========================
|
2021-07-29 11:33:44 +02:00
|
|
|
|
|
|
|
|
.. seo::
|
2023-09-06 00:02:45 +02:00
|
|
|
:description: Instructions for setting up MaxBotix HRXL or XL MaxSonar WR ultrasonic distance measurement sensors in ESPHome.
|
2021-07-29 11:33:44 +02:00
|
|
|
:image: hrxl_maxsonar_wr.jpg
|
|
|
|
|
:keywords: ultrasonic, maxbotix, maxsonar
|
|
|
|
|
|
|
|
|
|
This sensor allows you to use HRXL MaxSonar WR series ultrasonic sensors by MaxBotix
|
|
|
|
|
(`datasheet <https://www.maxbotix.com/documents/HRXL-MaxSonar-WR_Datasheet.pdf>`__)
|
2023-09-06 00:02:45 +02:00
|
|
|
or the XL MaxSonar WR series
|
|
|
|
|
(`datasheet <https://www.maxbotix.com/documents/XL-MaxSonar-WR_Datasheet.pdf>`__)
|
2021-07-29 11:33:44 +02:00
|
|
|
with ESPHome to measure distances. Depending on the model, these sensors can measure
|
|
|
|
|
in a range between 30 centimeters and 10 meters.
|
|
|
|
|
|
|
|
|
|
This sensor platform works with the **TTL versions** of those sensors and expects the
|
|
|
|
|
sensor's TTL pin to be wired to one of the ESP's input pins. Since these sensors read
|
|
|
|
|
multiple times per second, filtering is highly recommended.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. figure:: images/hrxl_maxsonar_wr-full.jpg
|
|
|
|
|
:align: center
|
|
|
|
|
:width: 50.0%
|
|
|
|
|
|
|
|
|
|
MB7388 HRXL-MaxSonar-WRMLT Ultrasonic Distance Sensor.
|
|
|
|
|
|
|
|
|
|
.. code-block:: yaml
|
|
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
uart:
|
|
|
|
|
rx_pin: 36
|
|
|
|
|
baud_rate: 9600
|
|
|
|
|
|
|
|
|
|
sensor:
|
|
|
|
|
- platform: "hrxl_maxsonar_wr"
|
|
|
|
|
name: "Rainwater Tank"
|
|
|
|
|
# Tweak the filters for your application
|
|
|
|
|
filters:
|
|
|
|
|
- sliding_window_moving_average:
|
|
|
|
|
window_size: 12
|
|
|
|
|
send_every: 12
|
|
|
|
|
- or:
|
|
|
|
|
- throttle: "20min"
|
|
|
|
|
- delta: 0.02
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Configuration variables:
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
- **name** (**Required**, string): The name of the sensor.
|
|
|
|
|
- All other options from :ref:`Sensor <config-sensor>`.
|
|
|
|
|
|
|
|
|
|
Advanced options:
|
|
|
|
|
|
|
|
|
|
- **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus <uart>` you wish to use for this sensor.
|
|
|
|
|
Use this if you want to use multiple UART buses at once.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See Also
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
- :ref:`sensor-filters`
|
|
|
|
|
- :ref:`uart`
|
|
|
|
|
- :doc:`template`
|
|
|
|
|
- :apiref:`hrxl_maxsonar_wr/hrxl_maxsonar_wr.h`
|
|
|
|
|
- :ghedit:`Edit`
|
