ESPHome 2026.9.1
Loading...
Searching...
No Matches
esphome::modbus_client::ReadCommandOptions< Ts > Class Template Reference

The read-side per-command options (modbus::CommandOptions), declared once for every action that sends a read. More...

#include <modbus_client.h>

Public Member Functions

 TEMPLATABLE_VALUE (bool, continuous) TEMPLATABLE_VALUE(bool
 

Protected Member Functions

modbus::CommandOptions command_options_ (const Ts &...x) const
 The options for this send, with every templatable value resolved against the action's arguments.
 

Detailed Description

template<typename... Ts>
class esphome::modbus_client::ReadCommandOptions< Ts >

The read-side per-command options (modbus::CommandOptions), declared once for every action that sends a read.

Each option is templatable, so it cannot be built in Python the way modbus_controller builds its static struct; declaring the values here instead of per action means a new read option costs one TEMPLATABLE_VALUE plus one field below, and every read action picks it up. The read/write split mirrors _COMMAND_OPTIONS in the modbus component's Python (command_options_schema(direction="read") adds exactly these keys); WriteCommandOptions is the twin.

Definition at line 89 of file modbus_client.h.

Member Function Documentation

◆ command_options_()

template<typename... Ts>
modbus::CommandOptions esphome::modbus_client::ReadCommandOptions< Ts >::command_options_ ( const Ts &... x) const
inlineprotected

The options for this send, with every templatable value resolved against the action's arguments.

Definition at line 98 of file modbus_client.h.

◆ TEMPLATABLE_VALUE()

template<typename... Ts>
esphome::modbus_client::ReadCommandOptions< Ts >::TEMPLATABLE_VALUE ( bool ,
continuous  )

The documentation for this class was generated from the following file: