ESPHome 2026.5.0-dev
Loading...
Searching...
No Matches
esphome::modbus_controller Namespace Reference

Data Structures

class  ModbusBinaryOutput
 
class  ModbusBinarySensor
 
class  ModbusCommandItem
 
class  ModbusController
 Modbus controller class. More...
 
class  ModbusFloatOutput
 
class  ModbusNumber
 
class  ModbusSelect
 
class  ModbusSensor
 
class  ModbusSwitch
 
class  ModbusTextSensor
 
struct  RegisterRange
 
class  SensorItem
 
class  SensorItemsComparator
 
struct  ServerCourtesyResponse
 
class  ServerRegister
 

Typedefs

using SensorSet = std::set<SensorItem *, SensorItemsComparator>
 
using value_to_data_t = std::function<float>(float)
 

Enumerations

enum class  RawEncoding { NONE = 0 , HEXBYTES = 1 , COMMA = 2 , ANSI = 3 }
 

Functions

 ESPDEPRECATED ("Use modbus::helpers::value_type_is_float() instead. Removed in 2026.10.0", "2026.4.0") inline bool value_type_is_float(SensorValueType v)
 
 ESPDEPRECATED ("Use modbus::helpers::modbus_register_read_function() instead. Removed in 2026.10.0", "2026.4.0") inline ModbusFunctionCode modbus_register_read_function(ModbusRegisterType reg_type)
 
 ESPDEPRECATED ("Use modbus::helpers::modbus_register_write_function() instead. Removed in 2026.10.0", "2026.4.0") inline ModbusFunctionCode modbus_register_write_function(ModbusRegisterType reg_type)
 
 ESPDEPRECATED ("Use modbus::helpers::c_to_hex() instead. Removed in 2026.10.0", "2026.4.0") inline uint8_t c_to_hex(char c)
 
 ESPDEPRECATED ("Use modbus::helpers::byte_from_hex_str() instead. Removed in 2026.10.0", "2026.4.0") inline uint8_t byte_from_hex_str(const std
 
 ESPDEPRECATED ("Use modbus::helpers::word_from_hex_str() instead. Removed in 2026.10.0", "2026.4.0") inline uint16_t word_from_hex_str(const std
 
 ESPDEPRECATED ("Use modbus::helpers::dword_from_hex_str() instead. Removed in 2026.10.0", "2026.4.0") inline uint32_t dword_from_hex_str(const std
 
 ESPDEPRECATED ("Use modbus::helpers::qword_from_hex_str() instead. Removed in 2026.10.0", "2026.4.0") inline uint64_t qword_from_hex_str(const std
 
template<typename T >
 ESPDEPRECATED ("Use modbus::helpers::get_data() instead. Removed in 2026.10.0", "2026.4.0") T get_data(const std
 
 ESPDEPRECATED ("Use modbus::helpers::coil_from_vector() instead. Removed in 2026.10.0", "2026.4.0") inline bool coil_from_vector(int coil
 
template<typename N >
 ESPDEPRECATED ("Use modbus::helpers::mask_and_shift_by_rightbit() instead. Removed in 2026.10.0", "2026.4.0") N mask_and_shift_by_rightbit(N data
 
 ESPDEPRECATED ("Use modbus::helpers::number_to_payload() instead. Removed in 2026.10.0", "2026.4.0") inline void number_to_payload(std
 
 ESPDEPRECATED ("Use modbus::helpers::payload_to_number() instead. Removed in 2026.10.0", "2026.4.0") inline int64_t payload_to_number(const std
 
 ESPDEPRECATED ("Use modbus::helpers::float_to_payload() instead. Removed in 2026.10.0", "2026.4.0") inline std
 
float payload_to_float (const std::vector< uint8_t > &data, const SensorItem &item)
 Convert vector<uint8_t> response payload to float.
 

Variables

const std::vector< uint8_t > & data
 
uint32_t mask
 

Typedef Documentation

◆ SensorSet

◆ value_to_data_t

using esphome::modbus_controller::value_to_data_t = std::function<float>(float)

Definition at line 12 of file modbus_number.h.

Enumeration Type Documentation

◆ RawEncoding

Enumerator
NONE 
HEXBYTES 
COMMA 
ANSI 

Definition at line 12 of file modbus_textsensor.h.

Function Documentation

◆ ESPDEPRECATED() [1/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::byte_from_hex_str() instead. Removed in 2026.10.0" ,
"2026.4.0"  ) const

Definition at line 42 of file modbus_controller.h.

◆ ESPDEPRECATED() [2/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::c_to_hex() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

Definition at line 39 of file modbus_controller.h.

◆ ESPDEPRECATED() [3/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::coil_from_vector() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

◆ ESPDEPRECATED() [4/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::dword_from_hex_str() instead. Removed in 2026.10.0" ,
"2026.4.0"  ) const

Definition at line 52 of file modbus_controller.h.

◆ ESPDEPRECATED() [5/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::float_to_payload() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

Definition at line 90 of file modbus_controller.h.

◆ ESPDEPRECATED() [6/14]

template<typename T >
esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::get_data() instead. Removed in 2026.10.0" ,
"2026.4.0"  ) const

Definition at line 63 of file modbus_controller.h.

◆ ESPDEPRECATED() [7/14]

template<typename N >
esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::mask_and_shift_by_rightbit() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

◆ ESPDEPRECATED() [8/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::modbus_register_read_function() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

Definition at line 29 of file modbus_controller.h.

◆ ESPDEPRECATED() [9/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::modbus_register_write_function() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

Definition at line 34 of file modbus_controller.h.

◆ ESPDEPRECATED() [10/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::number_to_payload() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

Definition at line 79 of file modbus_controller.h.

◆ ESPDEPRECATED() [11/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::payload_to_number() instead. Removed in 2026.10.0" ,
"2026.4.0"  ) const

Definition at line 84 of file modbus_controller.h.

◆ ESPDEPRECATED() [12/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::qword_from_hex_str() instead. Removed in 2026.10.0" ,
"2026.4.0"  ) const

Definition at line 57 of file modbus_controller.h.

◆ ESPDEPRECATED() [13/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::value_type_is_float() instead. Removed in 2026.10.0" ,
"2026.4.0"  )

Definition at line 26 of file modbus_controller.h.

◆ ESPDEPRECATED() [14/14]

esphome::modbus_controller::ESPDEPRECATED ( "Use modbus::helpers::word_from_hex_str() instead. Removed in 2026.10.0" ,
"2026.4.0"  ) const

Definition at line 47 of file modbus_controller.h.

◆ payload_to_float()

float esphome::modbus_controller::payload_to_float ( const std::vector< uint8_t > & data,
const SensorItem & item )
inline

Convert vector<uint8_t> response payload to float.

Parameters
datapayload with data
itemSensorItem object
Returns
float value of data

Definition at line 474 of file modbus_controller.h.

Variable Documentation

◆ data

const std::vector<uint8_t>& esphome::modbus_controller::data
Initial value:
{
return modbus::helpers::coil_from_vector(coil, data)

Definition at line 69 of file modbus_controller.h.

◆ mask

uint32_t esphome::modbus_controller::mask
Initial value:
{
return modbus::helpers::mask_and_shift_by_rightbit(data, mask)

Definition at line 75 of file modbus_controller.h.