mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-25 17:17:54 +01:00
51 lines
1.8 KiB
ReStructuredText
51 lines
1.8 KiB
ReStructuredText
.. _modbus:
|
|
|
|
Modbus Component
|
|
================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up Modbus in ESPHome.
|
|
:keywords: Modbus
|
|
|
|
The ModBUS protocol is used by many consumer and industrial devices for communication.
|
|
This component allows components in ESPHome to communicate to those devices.
|
|
ModBUS requires a :ref:`UART Bus <uart>` to communicate.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
uart:
|
|
...
|
|
|
|
modbus:
|
|
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **flow_control_pin** (*Optional*, :ref:`config-pin`): The pin used to switch flow control.
|
|
This is useful for RS485 transceivers that do not have automatic flow control switching,
|
|
like the common MAX485.
|
|
|
|
- **send_wait_time** (*Optional*, :ref:`config-time`): Time in milliseconds before the next ModBUS command is sent if an answer from a previous command is pending. Defaults to 250 ms.
|
|
If multiple ModBUS devices are attached to the same bus increasing this value can help avoiding to to overlapping reads.
|
|
When two devices are sending a command at the same time the response read from UART can't be assigned to the proper design.
|
|
This value defines the maximum queuing time for a command before it is send anyways.
|
|
|
|
- **disable_crc** (*Optional*, boolean): Ignores a bad CRC if set to ``true``. Defaults to ``false``
|
|
|
|
|
|
See Also
|
|
--------
|
|
- :doc:`/components/modbus_controller`
|
|
- :doc:`/components/sensor/modbus_controller`
|
|
- :doc:`/components/binary_sensor/modbus_controller`
|
|
- :doc:`/components/text_sensor/modbus_controller`
|
|
- :doc:`/components/switch/modbus_controller`
|
|
- :doc:`/components/number/modbus_controller`
|
|
- :doc:`/components/output/modbus_controller`
|
|
- `Modbus RTU Protocol Description <https://www.modbustools.com/modbus.html>`__
|
|
- :ref:`uart`
|
|
- :apiref:`modbus/modbus.h`
|
|
- :ghedit:`Edit`
|