2021-05-31 06:06:23 +02:00
.. _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.
2021-09-26 22:27:26 +02:00
This is useful for RS485 transeivers that do not have automatic flow control switching,
like the common MAX485.
2021-11-28 19:57:01 +01:00
- **send_wait_time** (*Optional* , :ref: `config-time` ): Time in milliseconds before a new modbus command is sent if an answer from a previous command is pending. Defaults to 250 ms.
2021-09-26 22:27:26 +02:00
If multiple modbus devices are attached increasing this value can help avoiding to to overlapping reads.
When 2 devices are sending a command at the same the the response read from uart can't be assigend to the proper design.
This value defines the maximumm queuing time for a command before it is send anyways.
2021-05-31 06:06:23 +02:00
See Also
--------
2021-11-29 10:03:46 +01:00
- :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`
- :doc: `EPEVER MPPT Solar Charge Controller Tracer-AN Series</cookbook/tracer-an>`
- `Modbus RTU Protocol Description <https://www.modbustools.com/modbus.html> `__
2021-05-31 06:06:23 +02:00
- :ref: `uart`
- :apiref: `modbus/modbus.h`
- :ghedit: `Edit`
