ESPHome  2022.1.2
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::modbus::Modbus Class Reference

#include <modbus.h>

Inheritance diagram for esphome::modbus::Modbus:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

 Modbus ()=default
 
void setup () override
 
void loop () override
 
void dump_config () override
 
void register_device (ModbusDevice *device)
 
float get_setup_priority () const override
 
void send (uint8_t address, uint8_t function_code, 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 set_flow_control_pin (GPIOPin *flow_control_pin)
 
void set_send_wait_time (uint16_t time_in_ms)
 
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Data Fields

uint8_t waiting_for_response {0}
 

Protected Member Functions

bool parse_modbus_byte_ (uint8_t byte)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

GPIOPinflow_control_pin_ {nullptr}
 
uint16_t send_wait_time_ {250}
 
std::vector< uint8_t > rx_buffer_
 
uint32_t last_modbus_byte_ {0}
 
uint32_t last_send_ {0}
 
std::vector< ModbusDevice * > devices_
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ = nullptr
 

Detailed Description

Definition at line 11 of file modbus.h.

Constructor & Destructor Documentation

◆ Modbus()

esphome::modbus::Modbus::Modbus ( )
default

Member Function Documentation

◆ dump_config()

void esphome::modbus::Modbus::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 128 of file modbus.cpp.

◆ get_setup_priority()

float esphome::modbus::Modbus::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 133 of file modbus.cpp.

◆ loop()

void esphome::modbus::Modbus::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file modbus.cpp.

◆ parse_modbus_byte_()

bool esphome::modbus::Modbus::parse_modbus_byte_ ( uint8_t  byte)
protected

Definition at line 54 of file modbus.cpp.

◆ register_device()

void esphome::modbus::Modbus::register_device ( ModbusDevice device)
inline

Definition at line 21 of file modbus.h.

◆ send()

void esphome::modbus::Modbus::send ( uint8_t  address,
uint8_t  function_code,
uint16_t  start_address,
uint16_t  number_of_entities,
uint8_t  payload_len = 0,
const uint8_t *  payload = nullptr 
)

Definition at line 138 of file modbus.cpp.

◆ send_raw()

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

Definition at line 189 of file modbus.cpp.

◆ set_flow_control_pin()

void esphome::modbus::Modbus::set_flow_control_pin ( GPIOPin flow_control_pin)
inline

Definition at line 28 of file modbus.h.

◆ set_send_wait_time()

void esphome::modbus::Modbus::set_send_wait_time ( uint16_t  time_in_ms)
inline

Definition at line 30 of file modbus.h.

◆ setup()

void esphome::modbus::Modbus::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file modbus.cpp.

Field Documentation

◆ devices_

std::vector<ModbusDevice *> esphome::modbus::Modbus::devices_
protected

Definition at line 40 of file modbus.h.

◆ flow_control_pin_

GPIOPin* esphome::modbus::Modbus::flow_control_pin_ {nullptr}
protected

Definition at line 33 of file modbus.h.

◆ last_modbus_byte_

uint32_t esphome::modbus::Modbus::last_modbus_byte_ {0}
protected

Definition at line 38 of file modbus.h.

◆ last_send_

uint32_t esphome::modbus::Modbus::last_send_ {0}
protected

Definition at line 39 of file modbus.h.

◆ rx_buffer_

std::vector<uint8_t> esphome::modbus::Modbus::rx_buffer_
protected

Definition at line 37 of file modbus.h.

◆ send_wait_time_

uint16_t esphome::modbus::Modbus::send_wait_time_ {250}
protected

Definition at line 36 of file modbus.h.

◆ waiting_for_response

uint8_t esphome::modbus::Modbus::waiting_for_response {0}

Definition at line 29 of file modbus.h.


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