esphome::modbus::ModbusServerDevice Class Reference

#include <modbus.h>

Inheritance diagram for esphome::modbus::ModbusServerDevice:

Public Member Functions
virtual	~ModbusServerDevice ()=default
	ModbusServerDevice ()=default
	ModbusServerDevice (const ModbusServerDevice &)=delete
ModbusServerDevice &	operator= (const ModbusServerDevice &)=delete
	ModbusServerDevice (ModbusServerDevice &&)=delete
ModbusServerDevice &	operator= (ModbusServerDevice &&)=delete
void	set_address (uint8_t address)
uint8_t	get_address () const
virtual ResponseStatus	on_read_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)
virtual ResponseStatus	on_read_input_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)
virtual ResponseStatus	on_read_holding_registers (uint16_t start_address, uint16_t number_of_registers, RegisterValues &registers)
virtual ResponseStatus	on_write_registers (uint16_t start_address, const RegisterValues &registers)
virtual ResponseStatus	on_read_bits (uint16_t start_address, MutablePackedBits bits)
	Coil/discrete-input reads: set the requested bits (bit 0 = the coil at start_address) with bits.set().
virtual ResponseStatus	on_read_coils (uint16_t start_address, MutablePackedBits bits)
virtual ResponseStatus	on_read_discrete_inputs (uint16_t start_address, MutablePackedBits bits)
virtual ResponseStatus	on_write_coils (uint16_t start_address, PackedBits bits)
	Coil writes deliver the values as a PackedBits view over the hub's receive buffer (only valid during the call).

Protected Attributes
uint8_t	address_ {0}

Detailed Description

Definition at line 606 of file modbus.h.

Constructor & Destructor Documentation

~ModbusServerDevice()

virtual esphome::modbus::ModbusServerDevice::~ModbusServerDevice ( )

virtualdefault

ModbusServerDevice() [1/3]

esphome::modbus::ModbusServerDevice::ModbusServerDevice ( )

default

ModbusServerDevice() [2/3]

esphome::modbus::ModbusServerDevice::ModbusServerDevice ( const ModbusServerDevice & )

delete

ModbusServerDevice() [3/3]

esphome::modbus::ModbusServerDevice::ModbusServerDevice ( ModbusServerDevice && )

delete

Member Function Documentation

get_address()

uint8_t esphome::modbus::ModbusServerDevice::get_address ( ) const

inline

Definition at line 616 of file modbus.h.

on_read_bits()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_read_bits ( uint16_t start_address, MutablePackedBits bits )

inlinevirtual

Coil/discrete-input reads: set the requested bits (bit 0 = the coil at start_address) with bits.set().

The view covers bits.size() pre-zeroed bits and writes land directly in the hub's response buffer (no copy); it is only valid during the call.

Reimplemented in esphome::modbus_server::ModbusServer.

Definition at line 635 of file modbus.h.

on_read_coils()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_read_coils ( uint16_t start_address, MutablePackedBits bits )

inlinevirtual

Definition at line 638 of file modbus.h.

on_read_discrete_inputs()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_read_discrete_inputs ( uint16_t start_address, MutablePackedBits bits )

inlinevirtual

Definition at line 641 of file modbus.h.

on_read_holding_registers()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_read_holding_registers ( uint16_t start_address, uint16_t number_of_registers, RegisterValues & registers )

inlinevirtual

Reimplemented in esphome::hoermann_hcp::HoermannHcp.

Definition at line 625 of file modbus.h.

on_read_input_registers()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_read_input_registers ( uint16_t start_address, uint16_t number_of_registers, RegisterValues & registers )

inlinevirtual

Definition at line 621 of file modbus.h.

on_read_registers()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_read_registers ( uint16_t start_address, uint16_t number_of_registers, RegisterValues & registers )

inlinevirtual

Reimplemented in esphome::modbus_server::ModbusServer.

Definition at line 617 of file modbus.h.

on_write_coils()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_write_coils ( uint16_t start_address, PackedBits bits )

inlinevirtual

Coil writes deliver the values as a PackedBits view over the hub's receive buffer (only valid during the call).

A single-coil write (FC 0x05) arrives as bits.size() == 1.

Reimplemented in esphome::modbus_server::ModbusServer.

Definition at line 646 of file modbus.h.

on_write_registers()

virtual ResponseStatus esphome::modbus::ModbusServerDevice::on_write_registers ( uint16_t start_address, const RegisterValues & registers )

inlinevirtual

Reimplemented in esphome::hoermann_hcp::HoermannHcp, and esphome::modbus_server::ModbusServer.

Definition at line 629 of file modbus.h.

operator=() [1/2]

ModbusServerDevice & esphome::modbus::ModbusServerDevice::operator= ( const ModbusServerDevice & )

delete

operator=() [2/2]

ModbusServerDevice & esphome::modbus::ModbusServerDevice::operator= ( ModbusServerDevice && )

delete

set_address()

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

inline

Definition at line 615 of file modbus.h.

Field Documentation

address_

uint8_t esphome::modbus::ModbusServerDevice::address_ {0}

protected

Definition at line 651 of file modbus.h.

---

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

• esphome/components/modbus/modbus.h