#include <kamstrup_kmp.h>

Inheritance diagram for esphome::kamstrup_kmp::KamstrupKMPComponent:

Public Member Functions
void	set_heat_energy_sensor (sensor::Sensor *sensor)

void	set_power_sensor (sensor::Sensor *sensor)

void	set_temp1_sensor (sensor::Sensor *sensor)

void	set_temp2_sensor (sensor::Sensor *sensor)

void	set_temp_diff_sensor (sensor::Sensor *sensor)

void	set_flow_sensor (sensor::Sensor *sensor)

void	set_volume_sensor (sensor::Sensor *sensor)

void	dump_config () override

float	get_setup_priority () const override

void	update () override

void	loop () override

void	add_custom_sensor (sensor::Sensor *sensor, uint16_t command)

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

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

bool	is_ready ()

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

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

Protected Member Functions
void	send_command_ (uint16_t command)

void	send_message_ (const uint8_t *msg, int msg_len)

void	clear_uart_rx_buffer_ ()

void	read_command_ (uint16_t command)

void	parse_command_message_ (uint16_t command, const uint8_t *msg, int msg_len)

void	set_sensor_value_ (uint16_t command, float value, uint8_t unit_idx)

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
sensor::Sensor *	heat_energy_sensor_ {nullptr}

sensor::Sensor *	power_sensor_ {nullptr}

sensor::Sensor *	temp1_sensor_ {nullptr}

sensor::Sensor *	temp2_sensor_ {nullptr}

sensor::Sensor *	temp_diff_sensor_ {nullptr}

sensor::Sensor *	flow_sensor_ {nullptr}

sensor::Sensor *	volume_sensor_ {nullptr}

std::vector< sensor::Sensor * >	custom_sensors_

std::vector< uint16_t >	custom_commands_

std::queue< uint16_t >	command_queue_

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}

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

Detailed Description

Definition at line 76 of file kamstrup_kmp.h.

Member Function Documentation

◆ add_custom_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::add_custom_sensor	(	sensor::Sensor *	sensor,
		uint16_t	command
	)

inline

Definition at line 89 of file kamstrup_kmp.h.

◆ clear_uart_rx_buffer_()

void esphome::kamstrup_kmp::KamstrupKMPComponent::clear_uart_rx_buffer_ ( )

protected

Definition at line 127 of file kamstrup_kmp.cpp.

◆ dump_config()

void esphome::kamstrup_kmp::KamstrupKMPComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file kamstrup_kmp.cpp.

◆ get_setup_priority()

float esphome::kamstrup_kmp::KamstrupKMPComponent::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file kamstrup_kmp.cpp.

◆ loop()

void esphome::kamstrup_kmp::KamstrupKMPComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 69 of file kamstrup_kmp.cpp.

◆ parse_command_message_()

void esphome::kamstrup_kmp::KamstrupKMPComponent::parse_command_message_	(	uint16_t	command,
		const uint8_t *	msg,
		int	msg_len
	)

protected

Definition at line 199 of file kamstrup_kmp.cpp.

◆ read_command_()

void esphome::kamstrup_kmp::KamstrupKMPComponent::read_command_ ( uint16_t command )

protected

Definition at line 134 of file kamstrup_kmp.cpp.

◆ send_command_()

void esphome::kamstrup_kmp::KamstrupKMPComponent::send_command_ ( uint16_t command )

protected

Definition at line 77 of file kamstrup_kmp.cpp.

◆ send_message_()

void esphome::kamstrup_kmp::KamstrupKMPComponent::send_message_	(	const uint8_t *	msg,
		int	msg_len
	)

protected

Definition at line 92 of file kamstrup_kmp.cpp.

◆ set_flow_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_flow_sensor ( sensor::Sensor * sensor )

inline

Definition at line 83 of file kamstrup_kmp.h.

◆ set_heat_energy_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_heat_energy_sensor ( sensor::Sensor * sensor )

inline

Definition at line 78 of file kamstrup_kmp.h.

◆ set_power_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_power_sensor ( sensor::Sensor * sensor )

inline

Definition at line 79 of file kamstrup_kmp.h.

◆ set_sensor_value_()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_sensor_value_	(	uint16_t	command,
		float	value,
		uint8_t	unit_idx
	)

protected

Definition at line 250 of file kamstrup_kmp.cpp.

◆ set_temp1_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_temp1_sensor ( sensor::Sensor * sensor )

inline

Definition at line 80 of file kamstrup_kmp.h.

◆ set_temp2_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_temp2_sensor ( sensor::Sensor * sensor )

inline

Definition at line 81 of file kamstrup_kmp.h.

◆ set_temp_diff_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_temp_diff_sensor ( sensor::Sensor * sensor )

inline

Definition at line 82 of file kamstrup_kmp.h.

◆ set_volume_sensor()

void esphome::kamstrup_kmp::KamstrupKMPComponent::set_volume_sensor ( sensor::Sensor * sensor )

inline

Definition at line 84 of file kamstrup_kmp.h.

◆ update()

void esphome::kamstrup_kmp::KamstrupKMPComponent::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 35 of file kamstrup_kmp.cpp.

Field Documentation

◆ command_queue_

std::queue<uint16_t> esphome::kamstrup_kmp::KamstrupKMPComponent::command_queue_

protected

Definition at line 109 of file kamstrup_kmp.h.

◆ custom_commands_

std::vector<uint16_t> esphome::kamstrup_kmp::KamstrupKMPComponent::custom_commands_

protected

Definition at line 106 of file kamstrup_kmp.h.

◆ custom_sensors_

std::vector<sensor::Sensor *> esphome::kamstrup_kmp::KamstrupKMPComponent::custom_sensors_

protected

Definition at line 105 of file kamstrup_kmp.h.

◆ flow_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::flow_sensor_ {nullptr}

protected

Definition at line 101 of file kamstrup_kmp.h.

◆ heat_energy_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::heat_energy_sensor_ {nullptr}

protected

Definition at line 96 of file kamstrup_kmp.h.

◆ power_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::power_sensor_ {nullptr}

protected

Definition at line 97 of file kamstrup_kmp.h.

◆ temp1_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::temp1_sensor_ {nullptr}

protected

Definition at line 98 of file kamstrup_kmp.h.

◆ temp2_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::temp2_sensor_ {nullptr}

protected

Definition at line 99 of file kamstrup_kmp.h.

◆ temp_diff_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::temp_diff_sensor_ {nullptr}

protected

Definition at line 100 of file kamstrup_kmp.h.

◆ volume_sensor_

sensor::Sensor* esphome::kamstrup_kmp::KamstrupKMPComponent::volume_sensor_ {nullptr}

protected

Definition at line 102 of file kamstrup_kmp.h.

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

/opt/build/esphome/esphome/components/kamstrup_kmp/kamstrup_kmp.h
/opt/build/esphome/esphome/components/kamstrup_kmp/kamstrup_kmp.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_custom_sensor()

◆ clear_uart_rx_buffer_()

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ parse_command_message_()

◆ read_command_()

◆ send_command_()

◆ send_message_()

◆ set_flow_sensor()

◆ set_heat_energy_sensor()

◆ set_power_sensor()

◆ set_sensor_value_()

◆ set_temp1_sensor()

◆ set_temp2_sensor()

◆ set_temp_diff_sensor()

◆ set_volume_sensor()

◆ update()

Field Documentation

◆ command_queue_

◆ custom_commands_

◆ custom_sensors_

◆ flow_sensor_

◆ heat_energy_sensor_

◆ power_sensor_

◆ temp1_sensor_

◆ temp2_sensor_

◆ temp_diff_sensor_

◆ volume_sensor_