#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, STATE_POLL_DECODED = 6 }

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)

uint8_t	send_next_command_ ()

void	send_next_poll_ ()

void	queue_command_ (const char *command, uint8_t length)

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

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(uint8_t)> &&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(uint8_t)> &&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
uint32_t	last_poll_ = 0

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	used_polling_commands_ [15]

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
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Static Protected Attributes
static const size_t	PIPSOLAR_READ_BUFFER_LENGTH = 110

static const size_t	COMMAND_QUEUE_LENGTH = 10

static const size_t	COMMAND_TIMEOUT = 5000

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	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::PollingComponent
	PollingComponent ()

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

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen. More...

virtual float	get_setup_priority () const
	priority of setup(). More...

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 () 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="unspecified")

void	status_set_error (const char *message="unspecified")

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...

Detailed Description

Definition at line 54 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
STATE_POLL_DECODED

Definition at line 208 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 874 of file pipsolar.cpp.

◆ check_incoming_crc_()

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

protected

Definition at line 773 of file pipsolar.cpp.

◆ check_incoming_length_()

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

protected

Definition at line 766 of file pipsolar.cpp.

◆ empty_uart_buffer_()

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

protected

Definition at line 15 of file pipsolar.cpp.

◆ pipsolar_crc_()

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

protected

Definition at line 899 of file pipsolar.cpp.

◆ queue_command_()

void esphome::pipsolar::Pipsolar::queue_command_	(	const char *	command,
		uint8_t	length
	)

protected

Definition at line 845 of file pipsolar.cpp.

◆ send_next_command_()

uint8_t esphome::pipsolar::Pipsolar::send_next_command_ ( )

protected

Definition at line 791 of file pipsolar.cpp.

◆ send_next_poll_()

void esphome::pipsolar::Pipsolar::send_next_poll_ ( )

protected

Definition at line 817 of file pipsolar.cpp.

Field Documentation

◆ command_queue_

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

protected

Definition at line 201 of file pipsolar.h.

◆ COMMAND_QUEUE_LENGTH

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

staticprotected

Definition at line 190 of file pipsolar.h.

◆ command_queue_position_

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

protected

Definition at line 202 of file pipsolar.h.

◆ command_start_millis_

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

protected

Definition at line 206 of file pipsolar.h.

◆ COMMAND_TIMEOUT

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

staticprotected

Definition at line 191 of file pipsolar.h.

◆ last_poll_

uint32_t esphome::pipsolar::Pipsolar::last_poll_ = 0

protected

Definition at line 192 of file pipsolar.h.

◆ last_polling_command_

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

protected

Definition at line 218 of file pipsolar.h.

◆ PIPSOLAR_READ_BUFFER_LENGTH

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

staticprotected

Definition at line 189 of file pipsolar.h.

◆ read_buffer_

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

protected

Definition at line 203 of file pipsolar.h.

◆ read_pos_

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

protected

Definition at line 204 of file pipsolar.h.

◆ state_

uint8_t esphome::pipsolar::Pipsolar::state_

protected

Definition at line 207 of file pipsolar.h.

◆ used_polling_commands_

PollingCommand esphome::pipsolar::Pipsolar::used_polling_commands_[15]

protected

Definition at line 219 of file pipsolar.h.

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

/opt/build/esphome/esphome/components/pipsolar/pipsolar.h
/opt/build/esphome/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_()

◆ pipsolar_crc_()

◆ queue_command_()

◆ send_next_command_()

◆ send_next_poll_()

Field Documentation

◆ command_queue_

◆ COMMAND_QUEUE_LENGTH

◆ command_queue_position_

◆ command_start_millis_

◆ COMMAND_TIMEOUT

◆ last_poll_

◆ last_polling_command_

◆ PIPSOLAR_READ_BUFFER_LENGTH

◆ read_buffer_

◆ read_pos_

◆ state_

◆ used_polling_commands_