ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::pylontech::PylontechComponent Class Referencefinal

#include <pylontech.h>

Inheritance diagram for esphome::pylontech::PylontechComponent:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

 PylontechComponent ()
 
void update () override
 Schedule data readings.
 
void loop () override
 Read data once available.
 
void setup () override
 Setup the sensor and test for a connection.
 
void dump_config () override
 
void set_cell_polling_enabled (bool enabled)
 Turn the "bat N" cell readings after each "pwr" reply off or on; nothing to turn off without cell sensors.
 
void register_listener (PylontechListener *listener)
 
void add_cell_battery (uint8_t bat_num)
 Read the cells of this battery with "bat N" after every "pwr" reply.
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual float get_setup_priority () const
 priority of setup().
 
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)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
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)
 
- 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 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_progmem (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 ()
 
template<size_t N = 64, typename F >
bool read_available_chunks (F &&on_chunk)
 Pass the bytes available now to on_chunk(data, len) in N byte chunks; returning false stops.
 
template<size_t N = 64, typename F >
bool read_available_chunks (F &&on_chunk, size_t count)
 Same, reading exactly count bytes; count must not exceed available().
 
template<size_t N = 64, typename F >
bool read_available (F &&on_byte)
 Same as read_available_chunks(), calling on_byte(uint8_t) once per byte.
 
template<size_t N = 64, typename F >
bool read_available (F &&on_byte, size_t count)
 
void discard_available ()
 Read and drop every byte waiting in the receive buffer.
 
UARTFlushResult flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
 ESPDEPRECATED ("Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0", "2026.9.0") void check_uart_settings(uint32_t baud_rate
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning.
 

Protected Member Functions

void process_line_ (const char *buffer)
 
void parse_header_ (const char *buffer)
 
void dispatch_one_ ()
 
void reject_line_ ()
 
void parse_cell_line_ (const char *buffer)
 
void send_next_bat_ ()
 
- Protected Member Functions inherited from esphome::Component
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.
 
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.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
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_ ()
 

Protected Attributes

StaticVector< PylontechListener *, PYLONTECH_LISTENER_COUNT > listeners_
 
std::array< PylontechListener::LineContents, PYLONTECH_BATTERY_COUNT > slots_
 
std::array< PylontechListener::CellArray, PYLONTECH_CELL_BATTERY_COUNT > cell_slots_
 
uint32_t bat_command_at_ {0}
 
battery_mask_t batteries_ {0}
 
battery_mask_t pending_ {0}
 
std::array< cell_mask_t, PYLONTECH_CELL_BATTERY_COUNT > cells_read_
 
battery_mask_t cell_batteries_ {0}
 
battery_mask_t cells_pending_ {0}
 
bool has_tlow_id_ {false}
 
uint8_t rejected_ {0}
 
uint8_t bat_reply_ {0}
 
bool pwr_reply_ {false}
 
bool bat_command_due_ {false}
 
bool late_reply_ {false}
 
bool cell_polling_enabled_ {true}
 
LineReader< 200 > line_reader_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent * parent_ {nullptr}
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 
- Data Fields inherited from esphome::uart::UARTDevice
uint8_t stop_bits = 1
 
uint8_t UARTParityOptions parity = UART_CONFIG_PARITY_NONE
 
uint8_t UARTParityOptions uint8_t data_bits = 8)
 
- Static Protected Member Functions inherited from esphome::uart::UARTDevice
template<typename F , typename... A>
static bool continue_after (F &f, A... args)
 Call f(args...) and return its result; a void callback always continues.
 

Detailed Description

Definition at line 56 of file pylontech.h.

Constructor & Destructor Documentation

◆ PylontechComponent()

esphome::pylontech::PylontechComponent::PylontechComponent ( )

Definition at line 88 of file pylontech.cpp.

Member Function Documentation

◆ add_cell_battery()

void esphome::pylontech::PylontechComponent::add_cell_battery ( uint8_t bat_num)
inline

Read the cells of this battery with "bat N" after every "pwr" reply.

Definition at line 82 of file pylontech.h.

◆ dispatch_one_()

void esphome::pylontech::PylontechComponent::dispatch_one_ ( )
protected

Definition at line 162 of file pylontech.cpp.

◆ dump_config()

void esphome::pylontech::PylontechComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 90 of file pylontech.cpp.

◆ loop()

void esphome::pylontech::PylontechComponent::loop ( )
overridevirtual

Read data once available.

Reimplemented from esphome::Component.

Definition at line 114 of file pylontech.cpp.

◆ parse_cell_line_()

void esphome::pylontech::PylontechComponent::parse_cell_line_ ( const char * buffer)
protected

Definition at line 330 of file pylontech.cpp.

◆ parse_header_()

void esphome::pylontech::PylontechComponent::parse_header_ ( const char * buffer)
protected

Definition at line 198 of file pylontech.cpp.

◆ process_line_()

void esphome::pylontech::PylontechComponent::process_line_ ( const char * buffer)
protected

Definition at line 211 of file pylontech.cpp.

◆ register_listener()

void esphome::pylontech::PylontechComponent::register_listener ( PylontechListener * listener)
inline

Definition at line 76 of file pylontech.h.

◆ reject_line_()

void esphome::pylontech::PylontechComponent::reject_line_ ( )
inlineprotected

Definition at line 89 of file pylontech.h.

◆ send_next_bat_()

void esphome::pylontech::PylontechComponent::send_next_bat_ ( )
protected

Definition at line 311 of file pylontech.cpp.

◆ set_cell_polling_enabled()

void esphome::pylontech::PylontechComponent::set_cell_polling_enabled ( bool enabled)
inline

Turn the "bat N" cell readings after each "pwr" reply off or on; nothing to turn off without cell sensors.

Definition at line 69 of file pylontech.h.

◆ setup()

void esphome::pylontech::PylontechComponent::setup ( )
overridevirtual

Setup the sensor and test for a connection.

Reimplemented from esphome::Component.

Definition at line 102 of file pylontech.cpp.

◆ update()

void esphome::pylontech::PylontechComponent::update ( )
overridevirtual

Schedule data readings.

Implements esphome::PollingComponent.

Definition at line 104 of file pylontech.cpp.

Field Documentation

◆ bat_command_at_

uint32_t esphome::pylontech::PylontechComponent::bat_command_at_ {0}
protected

Definition at line 110 of file pylontech.h.

◆ bat_command_due_

bool esphome::pylontech::PylontechComponent::bat_command_due_ {false}
protected

Definition at line 124 of file pylontech.h.

◆ bat_reply_

uint8_t esphome::pylontech::PylontechComponent::bat_reply_ {0}
protected

Definition at line 122 of file pylontech.h.

◆ batteries_

battery_mask_t esphome::pylontech::PylontechComponent::batteries_ {0}
protected

Definition at line 112 of file pylontech.h.

◆ cell_batteries_

battery_mask_t esphome::pylontech::PylontechComponent::cell_batteries_ {0}
protected

Definition at line 116 of file pylontech.h.

◆ cell_polling_enabled_

bool esphome::pylontech::PylontechComponent::cell_polling_enabled_ {true}
protected

Definition at line 126 of file pylontech.h.

◆ cell_slots_

std::array<PylontechListener::CellArray, PYLONTECH_CELL_BATTERY_COUNT> esphome::pylontech::PylontechComponent::cell_slots_
protected

Definition at line 109 of file pylontech.h.

◆ cells_pending_

battery_mask_t esphome::pylontech::PylontechComponent::cells_pending_ {0}
protected

Definition at line 117 of file pylontech.h.

◆ cells_read_

std::array<cell_mask_t, PYLONTECH_CELL_BATTERY_COUNT> esphome::pylontech::PylontechComponent::cells_read_
protected

Definition at line 115 of file pylontech.h.

◆ has_tlow_id_

bool esphome::pylontech::PylontechComponent::has_tlow_id_ {false}
protected

Definition at line 119 of file pylontech.h.

◆ late_reply_

bool esphome::pylontech::PylontechComponent::late_reply_ {false}
protected

Definition at line 125 of file pylontech.h.

◆ line_reader_

LineReader<200> esphome::pylontech::PylontechComponent::line_reader_
protected

Definition at line 129 of file pylontech.h.

◆ listeners_

StaticVector<PylontechListener *, PYLONTECH_LISTENER_COUNT> esphome::pylontech::PylontechComponent::listeners_
protected

Definition at line 101 of file pylontech.h.

◆ pending_

battery_mask_t esphome::pylontech::PylontechComponent::pending_ {0}
protected

Definition at line 113 of file pylontech.h.

◆ pwr_reply_

bool esphome::pylontech::PylontechComponent::pwr_reply_ {false}
protected

Definition at line 123 of file pylontech.h.

◆ rejected_

uint8_t esphome::pylontech::PylontechComponent::rejected_ {0}
protected

Definition at line 120 of file pylontech.h.

◆ slots_

std::array<PylontechListener::LineContents, PYLONTECH_BATTERY_COUNT> esphome::pylontech::PylontechComponent::slots_
protected

Definition at line 105 of file pylontech.h.


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