Installation

Dependencies

Hardware

Works with all ESP32 series chip (classic, S2, S3, C3...), single or dual-core.

Communication devices:

• For Modbus RTU, you need an UART to RS485 transceiver such as MAX485, TD321D485, SN75176... (usually, RXD/TXD pins + optional DE pin for flow control connected to a GPIO)

• For Modbus TCP, as the library is based on the ESP32's TCP stack, it will work with any available network interface. Use either WiFi or any Ethernet chip/module such as W5500 (must be properly initialized prior to create the TCP instance)

Environment

• ESP-IDF (tested on v5.4+)

• or ESP32 Arduino Core (tested on v3.0+) & PlatformIO - see pioarduino

• Requires C++17 or up (normally already enabled in ESP-IDF & PlatformIO)

Installation

ESP-IDF Installation (Component Manager)

1. Add the dependency to your project's idf_component.yml:

   dependencies:
     pierrejay/EZModbus: "^1.1.0"

2. Build your project - the component will be downloaded automatically:

   idf.py build

3. Include in your code:

   #include "EZModbus.h"

ESP-IDF Manual Installation (Alternative)

1. Add the repo into the components folder in your project

2. Include the component in your project's root CMakeLists.txt:

   idf_component_register(SRCS "main.cpp" PRIV_REQUIRES EZModbus ... # <- add here INCLUDE_DIRS "")

3. Include in your code:

   #include "EZModbus.h"

PlatformIO Installation

1. Add the repo into your lib folder

2. Include in your code:

   #include <EZModbus.h>