#include <bl0940.h>

Inheritance diagram for esphome::bl0940::BL0940:

Public Member Functions
void	set_voltage_sensor (sensor::Sensor *voltage_sensor)

void	set_current_sensor (sensor::Sensor *current_sensor)

void	set_power_sensor (sensor::Sensor *power_sensor)

void	set_energy_sensor (sensor::Sensor *energy_sensor)

void	set_internal_temperature_sensor (sensor::Sensor *internal_temperature_sensor)

void	set_external_temperature_sensor (sensor::Sensor *external_temperature_sensor)

void	loop () override

void	update () override

void	setup () override

void	dump_config () override

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

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
float	update_temp_ (sensor::Sensor *sensor, ube16_t packed_temperature) const

void	received_package_ (const DataPacket *data) const

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

Static Protected Member Functions
static uint32_t	to_uint32_t (ube24_t input)

static int32_t	to_int32_t (sbe24_t input)

static bool	validate_checksum (const DataPacket *data)

Protected Attributes
sensor::Sensor *	voltage_sensor_ {nullptr}

sensor::Sensor *	current_sensor_ {nullptr}

sensor::Sensor *	power_sensor_ {nullptr}

sensor::Sensor *	energy_sensor_ {nullptr}

sensor::Sensor *	internal_temperature_sensor_ {nullptr}

sensor::Sensor *	external_temperature_sensor_ {nullptr}

float	max_temperature_diff_ {0}

float	power_reference_ = BL0940_PREF

float	voltage_reference_ = BL0940_UREF

float	current_reference_ = BL0940_IREF

float	energy_reference_ = BL0940_EREF

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 58 of file bl0940.h.

Member Function Documentation

◆ dump_config()

void esphome::bl0940::BL0940::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 123 of file bl0940.cpp.

◆ loop()

void esphome::bl0940::BL0940::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file bl0940.cpp.

◆ received_package_()

void esphome::bl0940::BL0940::received_package_ ( const DataPacket * data ) const

protected

Definition at line 90 of file bl0940.cpp.

◆ set_current_sensor()

void esphome::bl0940::BL0940::set_current_sensor ( sensor::Sensor * current_sensor )

inline

Definition at line 61 of file bl0940.h.

◆ set_energy_sensor()

void esphome::bl0940::BL0940::set_energy_sensor ( sensor::Sensor * energy_sensor )

inline

Definition at line 63 of file bl0940.h.

◆ set_external_temperature_sensor()

void esphome::bl0940::BL0940::set_external_temperature_sensor ( sensor::Sensor * external_temperature_sensor )

inline

Definition at line 67 of file bl0940.h.

◆ set_internal_temperature_sensor()

void esphome::bl0940::BL0940::set_internal_temperature_sensor ( sensor::Sensor * internal_temperature_sensor )

inline

Definition at line 64 of file bl0940.h.

◆ set_power_sensor()

void esphome::bl0940::BL0940::set_power_sensor ( sensor::Sensor * power_sensor )

inline

Definition at line 62 of file bl0940.h.

◆ set_voltage_sensor()

void esphome::bl0940::BL0940::set_voltage_sensor ( sensor::Sensor * voltage_sensor )

inline

Definition at line 60 of file bl0940.h.

◆ setup()

void esphome::bl0940::BL0940::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 68 of file bl0940.cpp.

◆ to_int32_t()

int32_t esphome::bl0940::BL0940::to_int32_t ( sbe24_t input )

staticprotected

Definition at line 135 of file bl0940.cpp.

◆ to_uint32_t()

uint32_t esphome::bl0940::BL0940::to_uint32_t ( ube24_t input )

staticprotected

Definition at line 133 of file bl0940.cpp.

◆ update()

void esphome::bl0940::BL0940::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 62 of file bl0940.cpp.

◆ update_temp_()

float esphome::bl0940::BL0940::update_temp_	(	sensor::Sensor *	sensor,
		ube16_t	packed_temperature
	)		const

protected

Definition at line 76 of file bl0940.cpp.

◆ validate_checksum()

bool esphome::bl0940::BL0940::validate_checksum ( const DataPacket * data )

staticprotected

Definition at line 49 of file bl0940.cpp.

Field Documentation

◆ current_reference_

float esphome::bl0940::BL0940::current_reference_ = BL0940_IREF

protected

Definition at line 94 of file bl0940.h.

◆ current_sensor_

sensor::Sensor* esphome::bl0940::BL0940::current_sensor_ {nullptr}

protected

Definition at line 79 of file bl0940.h.

◆ energy_reference_

float esphome::bl0940::BL0940::energy_reference_ = BL0940_EREF

protected

Definition at line 96 of file bl0940.h.

◆ energy_sensor_

sensor::Sensor* esphome::bl0940::BL0940::energy_sensor_ {nullptr}

protected

Definition at line 83 of file bl0940.h.

◆ external_temperature_sensor_

sensor::Sensor* esphome::bl0940::BL0940::external_temperature_sensor_ {nullptr}

protected

Definition at line 85 of file bl0940.h.

◆ internal_temperature_sensor_

sensor::Sensor* esphome::bl0940::BL0940::internal_temperature_sensor_ {nullptr}

protected

Definition at line 84 of file bl0940.h.

◆ max_temperature_diff_

float esphome::bl0940::BL0940::max_temperature_diff_ {0}

protected

Definition at line 88 of file bl0940.h.

◆ power_reference_

float esphome::bl0940::BL0940::power_reference_ = BL0940_PREF

protected

Definition at line 90 of file bl0940.h.

◆ power_sensor_

sensor::Sensor* esphome::bl0940::BL0940::power_sensor_ {nullptr}

protected

Definition at line 82 of file bl0940.h.

◆ voltage_reference_

float esphome::bl0940::BL0940::voltage_reference_ = BL0940_UREF

protected

Definition at line 92 of file bl0940.h.

◆ voltage_sensor_

sensor::Sensor* esphome::bl0940::BL0940::voltage_sensor_ {nullptr}

protected

Definition at line 78 of file bl0940.h.

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

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ loop()

◆ received_package_()

◆ set_current_sensor()

◆ set_energy_sensor()

◆ set_external_temperature_sensor()

◆ set_internal_temperature_sensor()

◆ set_power_sensor()

◆ set_voltage_sensor()

◆ setup()

◆ to_int32_t()

◆ to_uint32_t()

◆ update()

◆ update_temp_()

◆ validate_checksum()

Field Documentation

◆ current_reference_

◆ current_sensor_

◆ energy_reference_

◆ energy_sensor_

◆ external_temperature_sensor_

◆ internal_temperature_sensor_

◆ max_temperature_diff_

◆ power_reference_

◆ power_sensor_

◆ voltage_reference_

◆ voltage_sensor_