#include <pipsolar.h>

Inheritance diagram for esphome::pipsolar::Pipsolar:

Protected Types
enum	State { STATE_IDLE = 0 , STATE_POLL = 1 , STATE_COMMAND = 2 , STATE_POLL_COMPLETE = 3 , STATE_COMMAND_COMPLETE = 4 , STATE_POLL_CHECKED = 5 }

Protected Member Functions
void	add_polling_command_ (const char *command, ENUMPollingCommand polling_command)

void	empty_uart_buffer_ ()

uint8_t	check_incoming_crc_ ()

uint8_t	check_incoming_length_ (uint8_t length)

uint16_t	pipsolar_crc_ (uint8_t *msg, uint8_t len)

bool	send_next_command_ ()

bool	send_next_poll_ ()

void	handle_poll_response_ (ENUMPollingCommand polling_command, const char *message)

void	handle_poll_error_ (ENUMPollingCommand polling_command)

void	handle_qpiri_ (const char *message)

void	handle_qpigs_ (const char *message)

void	handle_qmod_ (const char *message)

void	handle_qflag_ (const char *message)

void	handle_qpiws_ (const char *message)

void	handle_qt_ (const char *message)

void	handle_qmn_ (const char *message)

void	skip_start_ (const char message, size_t pos)

void	skip_field_ (const char message, size_t pos)

std::string	read_field_ (const char message, size_t pos)

void	read_float_sensor_ (const char message, size_t pos, sensor::Sensor *sensor)

void	read_int_sensor_ (const char message, size_t pos, sensor::Sensor *sensor)

void	publish_binary_sensor_ (esphome::optional< bool > b, binary_sensor::BinarySensor *sensor)

esphome::optional< bool >	get_bit_ (std::string bits, uint8_t bit_pos)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name.

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 interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

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 timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

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.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
std::string	command_queue_ [COMMAND_QUEUE_LENGTH]

uint8_t	command_queue_position_ = 0

uint8_t	read_buffer_ [PIPSOLAR_READ_BUFFER_LENGTH]

size_t	read_pos_ {0}

uint32_t	command_start_millis_ = 0

uint8_t	state_

uint8_t	last_polling_command_ = 0

PollingCommand	enabled_polling_commands_ [POLLING_COMMANDS_MAX]

Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent *	parent_ {nullptr}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Static Protected Attributes
static const size_t	PIPSOLAR_READ_BUFFER_LENGTH = 128

static const size_t	COMMAND_QUEUE_LENGTH = 10

static const size_t	COMMAND_TIMEOUT = 5000

static const size_t	POLLING_COMMANDS_MAX = 15

Additional Inherited Members
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 (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.

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms.

virtual 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)

virtual float	get_loop_priority () const
	priority of loop().

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Detailed Description

Definition at line 60 of file pipsolar.h.

Member Enumeration Documentation

◆ State

enum esphome::pipsolar::Pipsolar::State

protected

Enumerator
STATE_IDLE
STATE_POLL
STATE_COMMAND
STATE_POLL_COMPLETE
STATE_COMMAND_COMPLETE
STATE_POLL_CHECKED

Definition at line 236 of file pipsolar.h.

Member Function Documentation

◆ add_polling_command_()

void esphome::pipsolar::Pipsolar::add_polling_command_	(	const char *	command,
		ENUMPollingCommand	polling_command )

protected

Definition at line 749 of file pipsolar.cpp.

◆ check_incoming_crc_()

uint8_t esphome::pipsolar::Pipsolar::check_incoming_crc_ ( )

protected

Definition at line 153 of file pipsolar.cpp.

◆ check_incoming_length_()

uint8_t esphome::pipsolar::Pipsolar::check_incoming_length_ ( uint8_t length )

protected

Definition at line 146 of file pipsolar.cpp.

◆ empty_uart_buffer_()

void esphome::pipsolar::Pipsolar::empty_uart_buffer_ ( )

protected

Definition at line 15 of file pipsolar.cpp.

◆ get_bit_()

esphome::optional< bool > esphome::pipsolar::Pipsolar::get_bit_	(	std::string	bits,
		uint8_t	bit_pos )

protected

Definition at line 725 of file pipsolar.cpp.

◆ handle_poll_error_()

void esphome::pipsolar::Pipsolar::handle_poll_error_ ( ENUMPollingCommand polling_command )

protected

Definition at line 269 of file pipsolar.cpp.

◆ handle_poll_response_()

void esphome::pipsolar::Pipsolar::handle_poll_response_	(	ENUMPollingCommand	polling_command,
		const char *	message )

protected

Definition at line 242 of file pipsolar.cpp.

◆ handle_qflag_()

void esphome::pipsolar::Pipsolar::handle_qflag_ ( const char * message )

protected

Definition at line 422 of file pipsolar.cpp.

◆ handle_qmn_()

void esphome::pipsolar::Pipsolar::handle_qmn_ ( const char * message )

protected

Definition at line 656 of file pipsolar.cpp.

◆ handle_qmod_()

void esphome::pipsolar::Pipsolar::handle_qmod_ ( const char * message )

protected

Definition at line 410 of file pipsolar.cpp.

◆ handle_qpigs_()

void esphome::pipsolar::Pipsolar::handle_qpigs_ ( const char * message )

protected

Definition at line 357 of file pipsolar.cpp.

◆ handle_qpiri_()

void esphome::pipsolar::Pipsolar::handle_qpiri_ ( const char * message )

protected

Definition at line 274 of file pipsolar.cpp.

◆ handle_qpiws_()

void esphome::pipsolar::Pipsolar::handle_qpiws_ ( const char * message )

protected

Definition at line 481 of file pipsolar.cpp.

◆ handle_qt_()

void esphome::pipsolar::Pipsolar::handle_qt_ ( const char * message )

protected

Definition at line 650 of file pipsolar.cpp.

◆ pipsolar_crc_()

uint16_t esphome::pipsolar::Pipsolar::pipsolar_crc_	(	uint8_t *	msg,
		uint8_t	len )

protected

Definition at line 773 of file pipsolar.cpp.

◆ publish_binary_sensor_()

void esphome::pipsolar::Pipsolar::publish_binary_sensor_	(	esphome::optional< bool >	b,
		binary_sensor::BinarySensor *	sensor )

protected

Definition at line 715 of file pipsolar.cpp.

◆ read_field_()

std::string esphome::pipsolar::Pipsolar::read_field_	(	const char *	message,
		size_t *	pos )

protected

Definition at line 677 of file pipsolar.cpp.

◆ read_float_sensor_()

void esphome::pipsolar::Pipsolar::read_float_sensor_	(	const char *	message,
		size_t *	pos,
		sensor::Sensor *	sensor )

protected

Definition at line 697 of file pipsolar.cpp.

◆ read_int_sensor_()

void esphome::pipsolar::Pipsolar::read_int_sensor_	(	const char *	message,
		size_t *	pos,
		sensor::Sensor *	sensor )

protected

Definition at line 705 of file pipsolar.cpp.

◆ send_next_command_()

bool esphome::pipsolar::Pipsolar::send_next_command_ ( )

protected

Definition at line 170 of file pipsolar.cpp.

◆ send_next_poll_()

bool esphome::pipsolar::Pipsolar::send_next_poll_ ( )

protected

Definition at line 196 of file pipsolar.cpp.

◆ skip_field_()

void esphome::pipsolar::Pipsolar::skip_field_	(	const char *	message,
		size_t *	pos )

protected

Definition at line 667 of file pipsolar.cpp.

◆ skip_start_()

void esphome::pipsolar::Pipsolar::skip_start_	(	const char *	message,
		size_t *	pos )

protected

Definition at line 662 of file pipsolar.cpp.

Field Documentation

◆ command_queue_

std::string esphome::pipsolar::Pipsolar::command_queue_[COMMAND_QUEUE_LENGTH]

protected

Definition at line 229 of file pipsolar.h.

◆ COMMAND_QUEUE_LENGTH

const size_t esphome::pipsolar::Pipsolar::COMMAND_QUEUE_LENGTH = 10

staticprotected

Definition at line 196 of file pipsolar.h.

◆ command_queue_position_

uint8_t esphome::pipsolar::Pipsolar::command_queue_position_ = 0

protected

Definition at line 230 of file pipsolar.h.

◆ command_start_millis_

uint32_t esphome::pipsolar::Pipsolar::command_start_millis_ = 0

protected

Definition at line 234 of file pipsolar.h.

◆ COMMAND_TIMEOUT

const size_t esphome::pipsolar::Pipsolar::COMMAND_TIMEOUT = 5000

staticprotected

Definition at line 197 of file pipsolar.h.

◆ enabled_polling_commands_

PollingCommand esphome::pipsolar::Pipsolar::enabled_polling_commands_[POLLING_COMMANDS_MAX]

protected

Definition at line 246 of file pipsolar.h.

◆ last_polling_command_

uint8_t esphome::pipsolar::Pipsolar::last_polling_command_ = 0

protected

Definition at line 245 of file pipsolar.h.

◆ PIPSOLAR_READ_BUFFER_LENGTH

const size_t esphome::pipsolar::Pipsolar::PIPSOLAR_READ_BUFFER_LENGTH = 128

staticprotected

Definition at line 195 of file pipsolar.h.

◆ POLLING_COMMANDS_MAX

const size_t esphome::pipsolar::Pipsolar::POLLING_COMMANDS_MAX = 15

staticprotected

Definition at line 198 of file pipsolar.h.

◆ read_buffer_

uint8_t esphome::pipsolar::Pipsolar::read_buffer_[PIPSOLAR_READ_BUFFER_LENGTH]

protected

Definition at line 231 of file pipsolar.h.

◆ read_pos_

size_t esphome::pipsolar::Pipsolar::read_pos_ {0}

protected

Definition at line 232 of file pipsolar.h.

◆ state_

uint8_t esphome::pipsolar::Pipsolar::state_

protected

Definition at line 235 of file pipsolar.h.

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

esphome/components/pipsolar/pipsolar.h
esphome/components/pipsolar/pipsolar.cpp

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ add_polling_command_()

◆ check_incoming_crc_()

◆ check_incoming_length_()

◆ empty_uart_buffer_()

◆ get_bit_()

◆ handle_poll_error_()

◆ handle_poll_response_()

◆ handle_qflag_()

◆ handle_qmn_()

◆ handle_qmod_()

◆ handle_qpigs_()

◆ handle_qpiri_()

◆ handle_qpiws_()

◆ handle_qt_()

◆ pipsolar_crc_()

◆ publish_binary_sensor_()

◆ read_field_()

◆ read_float_sensor_()

◆ read_int_sensor_()

◆ send_next_command_()

◆ send_next_poll_()

◆ skip_field_()

◆ skip_start_()

Field Documentation

◆ command_queue_

◆ COMMAND_QUEUE_LENGTH

◆ command_queue_position_

◆ command_start_millis_

◆ COMMAND_TIMEOUT

◆ enabled_polling_commands_

◆ last_polling_command_

◆ PIPSOLAR_READ_BUFFER_LENGTH

◆ POLLING_COMMANDS_MAX

◆ read_buffer_

◆ read_pos_

◆ state_