#include <mk2pvrouter.h>

Inheritance diagram for esphome::mk2pvrouter::Mk2PVRouter:

Public Member Functions
void	register_mk2pvrouter_listener (Mk2PVRouterListener *listener)

void	loop () override

void	dump_config () override

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

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)

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)

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

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.

Protected Types
enum class	State : uint8_t { WAITING_FOR_START , START_FRAME_RECEIVED , END_FRAME_RECEIVED }

Protected Member Functions
bool	read_chars_until_ (bool drop, uint8_t c)

uint8_t	calculate_crc_ (const char *grp, size_t grp_len)

bool	check_crc_ (const char grp, const char grp_end)

void	process_group_ (const char grp, const char grp_end)

void	publish_value_ (const char tag, const char val)

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.

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_ ()

Protected Attributes
StaticVector< Mk2PVRouterListener *, MK2PVROUTER_LISTENER_COUNT >	mk2pvrouter_listeners_

uint16_t	buf_index_ {0}

State	state_ {State::WAITING_FOR_START}

char	tag_ [MAX_TAG_SIZE]

char	val_ [MAX_VAL_SIZE]

char	buf_ [MAX_BUF_SIZE]

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}

Static Protected Attributes
static constexpr size_t	CRC_SUFFIX_LEN = 1

static constexpr uint32_t	BAUD_RATE = 9600

Detailed Description

Definition at line 36 of file mk2pvrouter.h.

Member Enumeration Documentation

◆ State

enum class esphome::mk2pvrouter::Mk2PVRouter::State : uint8_t

strongprotected

Enumerator
WAITING_FOR_START
START_FRAME_RECEIVED
END_FRAME_RECEIVED

Definition at line 48 of file mk2pvrouter.h.

Member Function Documentation

◆ calculate_crc_()

uint8_t esphome::mk2pvrouter::Mk2PVRouter::calculate_crc_	(	const char *	grp,
		size_t	grp_len )

protected

Definition at line 37 of file mk2pvrouter.cpp.

◆ check_crc_()

bool esphome::mk2pvrouter::Mk2PVRouter::check_crc_	(	const char *	grp,
		const char *	grp_end )

protected

Definition at line 49 of file mk2pvrouter.cpp.

◆ dump_config()

void esphome::mk2pvrouter::Mk2PVRouter::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 166 of file mk2pvrouter.cpp.

◆ loop()

void esphome::mk2pvrouter::Mk2PVRouter::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 111 of file mk2pvrouter.cpp.

◆ process_group_()

void esphome::mk2pvrouter::Mk2PVRouter::process_group_	(	const char *	grp,
		const char *	grp_end )

protected

Definition at line 67 of file mk2pvrouter.cpp.

◆ publish_value_()

void esphome::mk2pvrouter::Mk2PVRouter::publish_value_	(	const char *	tag,
		const char *	val )

protected

Definition at line 156 of file mk2pvrouter.cpp.

◆ read_chars_until_()

bool esphome::mk2pvrouter::Mk2PVRouter::read_chars_until_	(	bool	drop,
		uint8_t	c )

protected

Definition at line 88 of file mk2pvrouter.cpp.

◆ register_mk2pvrouter_listener()

void esphome::mk2pvrouter::Mk2PVRouter::register_mk2pvrouter_listener ( Mk2PVRouterListener * listener )

Definition at line 172 of file mk2pvrouter.cpp.

Field Documentation

◆ BAUD_RATE

uint32_t esphome::mk2pvrouter::Mk2PVRouter::BAUD_RATE = 9600

staticconstexprprotected

Definition at line 46 of file mk2pvrouter.h.

◆ buf_

char esphome::mk2pvrouter::Mk2PVRouter::buf_[MAX_BUF_SIZE]

protected

Definition at line 61 of file mk2pvrouter.h.

◆ buf_index_

uint16_t esphome::mk2pvrouter::Mk2PVRouter::buf_index_ {0}

protected

Definition at line 57 of file mk2pvrouter.h.

◆ CRC_SUFFIX_LEN

size_t esphome::mk2pvrouter::Mk2PVRouter::CRC_SUFFIX_LEN = 1

staticconstexprprotected

Definition at line 45 of file mk2pvrouter.h.

◆ mk2pvrouter_listeners_

StaticVector<Mk2PVRouterListener *, MK2PVROUTER_LISTENER_COUNT> esphome::mk2pvrouter::Mk2PVRouter::mk2pvrouter_listeners_

protected

Definition at line 55 of file mk2pvrouter.h.

◆ state_

State esphome::mk2pvrouter::Mk2PVRouter::state_ {State::WAITING_FOR_START}

protected

Definition at line 58 of file mk2pvrouter.h.

◆ tag_

char esphome::mk2pvrouter::Mk2PVRouter::tag_[MAX_TAG_SIZE]

protected

Definition at line 59 of file mk2pvrouter.h.

◆ val_

char esphome::mk2pvrouter::Mk2PVRouter::val_[MAX_VAL_SIZE]

protected

Definition at line 60 of file mk2pvrouter.h.

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

esphome/components/mk2pvrouter/mk2pvrouter.h
esphome/components/mk2pvrouter/mk2pvrouter.cpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ calculate_crc_()

◆ check_crc_()

◆ dump_config()

◆ loop()

◆ process_group_()

◆ publish_value_()

◆ read_chars_until_()

◆ register_mk2pvrouter_listener()

Field Documentation

◆ BAUD_RATE

◆ buf_

◆ buf_index_

◆ CRC_SUFFIX_LEN

◆ mk2pvrouter_listeners_

◆ state_

◆ tag_

◆ val_