> For the complete documentation index, see [llms.txt](https://pierre-jay.gitbook.io/ezmodbus-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pierre-jay.gitbook.io/ezmodbus-docs/getting-started/installation.md).

# 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](https://claude.ai/chat/link-to-your-arduino-doc)
* 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`:

   ```yaml
   dependencies:
     pierrejay/EZModbus: "^1.1.0"
   ```
2. Build your project - the component will be downloaded automatically:

   ```bash
   idf.py build
   ```
3. Include in your code:

   ```cpp
   #include "EZModbus.h"
   ```

### ESP-IDF Manual Installation (Alternative)

1. Add the repo into the `components` folder in your project - **its name should be in lowercase to match the ESP-IDF component naming:**

   ```sh
   cd /path/to/your/project/components
   git clone https://github.com/pierrejay/EZModbus.git ezmodbus
   ```
2. Include the component in your project's root `CMakeLists.txt`:

   ```cmake
   idf_component_register(SRCS "main.cpp" PRIV_REQUIRES ezmodbus ... # <- add here INCLUDE_DIRS "")
   ```
3. Include in your code:

   ```cpp
   #include "EZModbus.h"
   ```

### PlatformIO Installation

1. Add the repo into your `lib` folder
2. Include in your code:

   ```cpp
   #include <EZModbus.h>
   ```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pierre-jay.gitbook.io/ezmodbus-docs/getting-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.