esphome::modbus::ModbusDevice Class Reference

#include <modbus.h>

Inheritance diagram for esphome::modbus::ModbusDevice:

Public Member Functions
void	set_parent (Modbus *parent)
void	set_address (uint8_t address)
virtual void	on_modbus_data (const std::vector< uint8_t > &data)=0
virtual void	on_modbus_error (uint8_t function_code, uint8_t exception_code)
virtual void	on_modbus_read_registers (uint8_t function_code, uint16_t start_address, uint16_t number_of_registers)
virtual void	on_modbus_write_registers (uint8_t function_code, const std::vector< uint8_t > &data)
void	send (uint8_t function, uint16_t start_address, uint16_t number_of_entities, uint8_t payload_len=0, const uint8_t *payload=nullptr)
void	send_raw (const std::vector< uint8_t > &payload)
void	send_error (uint8_t function_code, ModbusExceptionCode exception_code)
	ESPDEPRECATED ("Use ready_for_immediate_send() instead. Removed in 2026.9.0", "2026.3.0") bool waiting_for_response()
bool	ready_for_immediate_send ()

Protected Attributes
friend	Modbus
Modbus *	parent_
uint8_t	address_

Detailed Description

Definition at line 92 of file modbus.h.

Member Function Documentation

ESPDEPRECATED()

esphome::modbus::ModbusDevice::ESPDEPRECATED ( "Use ready_for_immediate_send() instead. Removed in 2026.9.0" , "2026.3.0"  )

inline

Definition at line 114 of file modbus.h.

on_modbus_data()

virtual void esphome::modbus::ModbusDevice::on_modbus_data ( const std::vector< uint8_t > & data )

pure virtual

Implemented in esphome::growatt_solar::GrowattSolar, esphome::havells_solar::HavellsSolar, esphome::kuntze::Kuntze, esphome::modbus_controller::ModbusController, esphome::pzemac::PZEMAC, esphome::pzemdc::PZEMDC, esphome::sdm_meter::SDMMeter, and esphome::selec_meter::SelecMeter.

on_modbus_error()

virtual void esphome::modbus::ModbusDevice::on_modbus_error ( uint8_t function_code, uint8_t exception_code )

inlinevirtual

Reimplemented in esphome::modbus_controller::ModbusController.

Definition at line 97 of file modbus.h.

on_modbus_read_registers()

virtual void esphome::modbus::ModbusDevice::on_modbus_read_registers ( uint8_t function_code, uint16_t start_address, uint16_t number_of_registers )

inlinevirtual

Reimplemented in esphome::modbus_controller::ModbusController.

Definition at line 98 of file modbus.h.

on_modbus_write_registers()

virtual void esphome::modbus::ModbusDevice::on_modbus_write_registers ( uint8_t function_code, const std::vector< uint8_t > & data )

inlinevirtual

Reimplemented in esphome::modbus_controller::ModbusController.

Definition at line 99 of file modbus.h.

ready_for_immediate_send()

bool esphome::modbus::ModbusDevice::ready_for_immediate_send ( )

inline

Definition at line 116 of file modbus.h.

send()

void esphome::modbus::ModbusDevice::send ( uint8_t function, uint16_t start_address, uint16_t number_of_entities, uint8_t payload_len = 0, const uint8_t * payload = nullptr )

inline

Definition at line 100 of file modbus.h.

send_error()

void esphome::modbus::ModbusDevice::send_error ( uint8_t function_code, ModbusExceptionCode exception_code )

inline

Definition at line 105 of file modbus.h.

send_raw()

void esphome::modbus::ModbusDevice::send_raw ( const std::vector< uint8_t > & payload )

inline

Definition at line 104 of file modbus.h.

set_address()

void esphome::modbus::ModbusDevice::set_address ( uint8_t address )

inline

Definition at line 95 of file modbus.h.

set_parent()

void esphome::modbus::ModbusDevice::set_parent ( Modbus * parent )

inline

Definition at line 94 of file modbus.h.

Field Documentation

address_

uint8_t esphome::modbus::ModbusDevice::address_

protected

Definition at line 122 of file modbus.h.

Modbus

friend esphome::modbus::ModbusDevice::Modbus

protected

Definition at line 119 of file modbus.h.

parent_

Modbus* esphome::modbus::ModbusDevice::parent_

protected

Definition at line 121 of file modbus.h.

---

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

• esphome/components/modbus/modbus.h