ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
esphome::bl0939::BL0939 Class Reference

#include <bl0939.h>

Inheritance diagram for esphome::bl0939::BL0939:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

void set_voltage_sensor (sensor::Sensor *voltage_sensor)
 
void set_current_sensor_1 (sensor::Sensor *current_sensor_1)
 
void set_current_sensor_2 (sensor::Sensor *current_sensor_2)
 
void set_power_sensor_1 (sensor::Sensor *power_sensor_1)
 
void set_power_sensor_2 (sensor::Sensor *power_sensor_2)
 
void set_energy_sensor_1 (sensor::Sensor *energy_sensor_1)
 
void set_energy_sensor_2 (sensor::Sensor *energy_sensor_2)
 
void set_energy_sensor_sum (sensor::Sensor *energy_sensor_sum)
 
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...
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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 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()> &&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()> &&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::Sensorvoltage_sensor_ {nullptr}
 
sensor::Sensorcurrent_sensor_1_ {nullptr}
 
sensor::Sensorcurrent_sensor_2_ {nullptr}
 
sensor::Sensorpower_sensor_1_ {nullptr}
 
sensor::Sensorpower_sensor_2_ {nullptr}
 
sensor::Sensorenergy_sensor_1_ {nullptr}
 
sensor::Sensorenergy_sensor_2_ {nullptr}
 
sensor::Sensorenergy_sensor_sum_ {nullptr}
 
float power_reference_ = BL0939_PREF
 
float voltage_reference_ = BL0939_UREF
 
float current_reference_ = BL0939_IREF
 
float energy_reference_ = BL0939_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
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 60 of file bl0939.h.

Member Function Documentation

◆ dump_config()

void esphome::bl0939::BL0939::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file bl0939.cpp.

◆ loop()

void esphome::bl0939::BL0939::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file bl0939.cpp.

◆ received_package_()

void esphome::bl0939::BL0939::received_package_ ( const DataPacket data) const
protected

Definition at line 80 of file bl0939.cpp.

◆ set_current_sensor_1()

void esphome::bl0939::BL0939::set_current_sensor_1 ( sensor::Sensor current_sensor_1)
inline

Definition at line 63 of file bl0939.h.

◆ set_current_sensor_2()

void esphome::bl0939::BL0939::set_current_sensor_2 ( sensor::Sensor current_sensor_2)
inline

Definition at line 64 of file bl0939.h.

◆ set_energy_sensor_1()

void esphome::bl0939::BL0939::set_energy_sensor_1 ( sensor::Sensor energy_sensor_1)
inline

Definition at line 67 of file bl0939.h.

◆ set_energy_sensor_2()

void esphome::bl0939::BL0939::set_energy_sensor_2 ( sensor::Sensor energy_sensor_2)
inline

Definition at line 68 of file bl0939.h.

◆ set_energy_sensor_sum()

void esphome::bl0939::BL0939::set_energy_sensor_sum ( sensor::Sensor energy_sensor_sum)
inline

Definition at line 69 of file bl0939.h.

◆ set_power_sensor_1()

void esphome::bl0939::BL0939::set_power_sensor_1 ( sensor::Sensor power_sensor_1)
inline

Definition at line 65 of file bl0939.h.

◆ set_power_sensor_2()

void esphome::bl0939::BL0939::set_power_sensor_2 ( sensor::Sensor power_sensor_2)
inline

Definition at line 66 of file bl0939.h.

◆ set_voltage_sensor()

void esphome::bl0939::BL0939::set_voltage_sensor ( sensor::Sensor voltage_sensor)
inline

Definition at line 62 of file bl0939.h.

◆ setup()

void esphome::bl0939::BL0939::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 72 of file bl0939.cpp.

◆ to_int32_t()

int32_t esphome::bl0939::BL0939::to_int32_t ( sbe24_t  input)
staticprotected

Definition at line 141 of file bl0939.cpp.

◆ to_uint32_t()

uint32_t esphome::bl0939::BL0939::to_uint32_t ( ube24_t  input)
staticprotected

Definition at line 139 of file bl0939.cpp.

◆ update()

void esphome::bl0939::BL0939::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 66 of file bl0939.cpp.

◆ validate_checksum()

bool esphome::bl0939::BL0939::validate_checksum ( const DataPacket data)
staticprotected

Definition at line 53 of file bl0939.cpp.

Field Documentation

◆ current_reference_

float esphome::bl0939::BL0939::current_reference_ = BL0939_IREF
protected

Definition at line 94 of file bl0939.h.

◆ current_sensor_1_

sensor::Sensor* esphome::bl0939::BL0939::current_sensor_1_ {nullptr}
protected

Definition at line 79 of file bl0939.h.

◆ current_sensor_2_

sensor::Sensor* esphome::bl0939::BL0939::current_sensor_2_ {nullptr}
protected

Definition at line 80 of file bl0939.h.

◆ energy_reference_

float esphome::bl0939::BL0939::energy_reference_ = BL0939_EREF
protected

Definition at line 96 of file bl0939.h.

◆ energy_sensor_1_

sensor::Sensor* esphome::bl0939::BL0939::energy_sensor_1_ {nullptr}
protected

Definition at line 85 of file bl0939.h.

◆ energy_sensor_2_

sensor::Sensor* esphome::bl0939::BL0939::energy_sensor_2_ {nullptr}
protected

Definition at line 86 of file bl0939.h.

◆ energy_sensor_sum_

sensor::Sensor* esphome::bl0939::BL0939::energy_sensor_sum_ {nullptr}
protected

Definition at line 87 of file bl0939.h.

◆ power_reference_

float esphome::bl0939::BL0939::power_reference_ = BL0939_PREF
protected

Definition at line 90 of file bl0939.h.

◆ power_sensor_1_

sensor::Sensor* esphome::bl0939::BL0939::power_sensor_1_ {nullptr}
protected

Definition at line 83 of file bl0939.h.

◆ power_sensor_2_

sensor::Sensor* esphome::bl0939::BL0939::power_sensor_2_ {nullptr}
protected

Definition at line 84 of file bl0939.h.

◆ voltage_reference_

float esphome::bl0939::BL0939::voltage_reference_ = BL0939_UREF
protected

Definition at line 92 of file bl0939.h.

◆ voltage_sensor_

sensor::Sensor* esphome::bl0939::BL0939::voltage_sensor_ {nullptr}
protected

Definition at line 78 of file bl0939.h.


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