|
| | ModbusClientHub ()=default |
| |
| void | dump_config () override |
| |
| void | loop () override |
| |
| void | set_send_wait_time (uint16_t time_in_ms) |
| |
| void | set_turnaround_time (uint16_t time_in_ms) |
| |
| bool | tx_buffer_empty () |
| |
| bool | tx_blocked () override |
| |
| | ESPDEPRECATED ("Use queue_pdu() with create_client_pdu() instead. Removed in 2026.10.0", "2026.4.0") void send(uint8_t address |
| |
| bool | queue_pdu (uint8_t address, std::span< const uint8_t > pdu, ModbusClientDevice *device=nullptr, CommandOptions options={}) |
| | Queue a request.
|
| |
| | ESPDEPRECATED ("Use queue_pdu() instead - the call queues a request, it does not send one, and it " "reports whether the request was accepted. Removed in 2027.2.0", "2026.8.0") void send_pdu(uint8_t address |
| |
| void | clear_tx_queue_for_address (uint8_t address) |
| |
| void | clear_tx_queue_for_device (ModbusClientDevice *device) |
| |
| | Modbus ()=default |
| |
| void | setup () override |
| |
| float | get_setup_priority () const override |
| |
| void | set_flow_control_pin (GPIOPin *flow_control_pin) |
| |
| | UARTDevice ()=default |
| |
| | UARTDevice (UARTComponent *parent) |
| |
| void | set_uart_parent (UARTComponent *parent) |
| |
| void | write_byte (uint8_t data) |
| |
| void | set_rx_full_threshold (size_t rx_full_threshold) |
| |
| void | set_rx_full_threshold_ms (size_t time) |
| |
| size_t | get_rx_full_threshold () |
| |
| void | set_rx_timeout (size_t rx_timeout) |
| |
| size_t | get_rx_timeout () |
| |
| 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 () |
| |
| size_t | available () |
| |
| UARTFlushResult | 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.
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| bool | is_idle () const |
| | Check if this component is idle.
|
| |
| void | mark_failed () |
| | Mark this component as failed.
|
| |
| void | mark_failed (const LogString *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| bool | is_failed () const |
| |
| bool | is_ready () const |
| |
| virtual bool | can_proceed () |
| |
| bool | status_has_warning () const |
| |
| bool | status_has_error () const |
| |
| void | status_set_warning () |
| |
| void | status_set_warning (const char *message) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error () |
| |
| void | status_set_error (const LogString *message) |
| |
| void | status_clear_warning () |
| |
| void | status_clear_error () |
| |
| void | status_momentary_warning (const char *name, uint32_t length=5000) |
| | Set warning status flag and automatically clear it after a timeout.
|
| |
| void | status_momentary_error (const char *name, uint32_t length=5000) |
| | Set error status flag and automatically clear it after a timeout.
|
| |
| bool | has_overridden_loop () const |
| |
| const LogString * | get_component_log_str () const ESPHOME_ALWAYS_INLINE |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out) |
| |
|
| int32_t | tx_delay_remaining () override |
| |
| void | parse_modbus_frames () override |
| |
| void | process_modbus_server_frame (uint8_t address, std::span< const uint8_t > pdu) override |
| |
| void | send_next_frame_ () |
| |
| void | sweep_ () |
| |
| ModbusDeviceCommand * | select_next_ready_ () |
| |
| ModbusDeviceCommand * | find_waiting_ () |
| |
| void | expire_waiting_ () |
| |
| void | receive_bytes_ () |
| |
| bool | timeout_ () |
| |
| bool | parse_modbus_server_frame_ () |
| |
| void | clear_rx_buffer_ (const LogString *reason, bool warn=false, size_t bytes_to_clear=0) |
| |
| bool | send_frame_ (const ModbusFrame &frame) |
| |
| uint16_t | find_frame_end_by_crc_ (uint16_t min_length) const |
| |
| friend | void::setup () |
| |
| friend | void::original_setup () |
| |
| void | set_component_source_ (uint8_t index) |
| | Set where this component was loaded from for some debug messages.
|
| |
| virtual void | call_setup () |
| |
| void | call_dump_config_ () |
| |
| void | enable_loop_slow_path_ () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| bool | set_status_flag_ (uint8_t flag) |
| | Helper to set a status LED flag on both this component and the app.
|
| |
| void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a const char* name.
|
| |
| void | set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a numeric ID (zero heap allocation).
|
| |
| void | set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f) |
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (const char *name) |
| | Cancel an interval function.
|
| |
| bool | cancel_interval (uint32_t id) |
| |
| bool | cancel_interval (InternalSchedulerID id) |
| |
| void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a const char* name.
|
| |
| void | set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a numeric ID (zero heap allocation).
|
| |
| void | set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f) |
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (const char *name) |
| | Cancel a timeout function.
|
| |
| bool | cancel_timeout (uint32_t id) |
| |
| bool | cancel_timeout (InternalSchedulerID id) |
| |
| void | defer (const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call with a const char* name.
|
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (uint32_t id, std::function< void()> &&f) |
| | Defer a callback with a numeric ID (zero heap allocation)
|
| |
| bool | cancel_defer (const char *name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| bool | cancel_defer (uint32_t id) |
| |
| void | status_clear_warning_slow_path_ () |
| |
| void | status_clear_error_slow_path_ () |
| |
Definition at line 263 of file modbus.h.
| bool esphome::modbus::ModbusClientHub::queue_pdu |
( |
uint8_t | address, |
|
|
std::span< const uint8_t > | pdu, |
|
|
ModbusClientDevice * | device = nullptr, |
|
|
CommandOptions | options = {} ) |
Queue a request.
The name says queue, not send: the frame is appended to the transmit queue and goes out later from loop(), so a true return means accepted into the machine (it will resolve in exactly one terminal callback - except a broadcast (address 0), which is never answered and so gets only on_sent()), NOT that anything reached the wire - that is on_sent(). False means it never entered the machine at all (empty or oversize PDU, full queue, anonymous or over-cap duplicate) and no callback of any kind will follow; the false return is the whole story.
Definition at line 1045 of file modbus.cpp.
Public Member Functions inherited from esphome::modbus::Modbus
1.12.0