Settings (compile flags)

The following settings are editable via compile flags. Default settings are recommended for stability, use with caution.

Usage

PlatformIO

In your platformio.ini, add:

build_flags =
    -DEZMODBUS_SETTING           ; If just a flag
    -DEZMODBUS_SETTING_VALUE=2   ; If flag w/ value

CMake

In EZModbus's CMakeLists.txt:

target_compile_definitions(EZModbus PRIVATE
    EZMODBUS_SETTING           # If just a flag
    EZMODBUS_SETTING_VALUE=2   # If flag w/ value
)

Settings per file

ModbusServer.h

• EZMODBUS_SERVER_MAX_WORD_SIZE

  • Max Word size (# Modbus registers per Word)

  • Default: 8

ModbusClient.h

• EZMODBUS_CLIENT_REQ_TIMEOUT

  • Timeout before aborting a request if no response received from server (ms)

  • Default: 1000

ModbusRTU.h

• EZMODBUS_RTU_TASK_STACK_SIZE

  • Stack size of RTU task (bytes)

  • Default: 2048, or 4096 if debug enabled

ModbusTCP.h

• EZMODBUS_TCP_TXN_SAFETY_TIMEOUT

  • Timeout before closing a transaction after 1st message if no response from server or client (ms)

  • Default: 5000

• EZMODBUS_TCP_TASK_STACK_SIZE

  • Stack size of TCP task (bytes)

  • Default: 4096, or 6144 if debug enabled

ModbusHAL_UART.h

• EZMODBUS_HAL_UART_EVT_Q_SIZE

  • Size of IDF UART event queue (# events)

  • Default: 20

ModbusHAL_TCP.h

• EZMODBUS_HAL_TCP_RX_Q_SIZE

  • Size of TCP driver RX queue size (# frames)

  • Default: 16

• EZMODBUS_HAL_TCP_TASK_STACK_SIZE

  • Stack size of TCP driver task (bytes)

  • Default: 4096

ModbusDebug.hpp

• EZMODBUS_DEBUG

  • Enables Debug logs

  • Default: undefined = no logs (no value, just a flag)

• EZMODBUS_MAX_DEBUG_MSG_SIZE

  • Max length of debug message including null terminator (char)

  • Default: 256

ModbusLogger.hpp

• EZMODBUS_LOG_Q_SIZE

  • Log message queue size (# messages)

  • Default: 16

• EZMODBUS_LOG_MAX_MSG_SIZE

  • Maximum length for a formatted message (char)

  • Default: 256

• EZMODBUS_LOG_TASK_PRIORITY

  • Priority of Log task

  • Default: 1

• EZMODBUS_LOG_TASK_STACK_SIZE

  • Stack size of Log task (bytes)

  • Default: 4096

• EZMODBUS_LOG_OUTPUT

  • Log output pipe (Serial port)

  • Default: Serial on Arduino, UART_NUM_0 on ESP-IDF