ESPHome  2024.10.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::bl0942::BL0942 Class Reference

#include <bl0942.h>

Inheritance diagram for esphome::bl0942::BL0942:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

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_frequency_sensor (sensor::Sensor *frequency_sensor)
 
void set_line_freq (LineFrequency freq)
 
void set_address (uint8_t address)
 
void set_reset (bool reset)
 
void set_current_reference (float current_ref)
 
void set_energy_reference (float energy_ref)
 
void set_power_reference (float power_ref)
 
void set_voltage_reference (float voltage_ref)
 
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

bool validate_checksum_ (DataPacket *data)
 
int read_reg_ (uint8_t reg)
 
void write_reg_ (uint8_t reg, uint32_t val)
 
void received_package_ (DataPacket *data)
 
- 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::Sensorvoltage_sensor_ {nullptr}
 
sensor::Sensorcurrent_sensor_ {nullptr}
 
sensor::Sensorpower_sensor_ {nullptr}
 
sensor::Sensorenergy_sensor_ {nullptr}
 
sensor::Sensorfrequency_sensor_ {nullptr}
 
float power_reference_ = BL0942_PREF
 
bool power_reference_set_ = false
 
float voltage_reference_ = BL0942_UREF
 
bool voltage_reference_set_ = false
 
float current_reference_ = BL0942_IREF
 
bool current_reference_set_ = false
 
float energy_reference_ = BL0942_EREF
 
bool energy_reference_set_ = false
 
uint8_t address_ = 0
 
bool reset_ = false
 
LineFrequency line_freq_ = LINE_FREQUENCY_50HZ
 
uint32_t rx_start_ = 0
 
uint32_t prev_cf_cnt_ = 0
 
- 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 87 of file bl0942.h.

Member Function Documentation

◆ dump_config()

void esphome::bl0942::BL0942::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 198 of file bl0942.cpp.

◆ loop()

void esphome::bl0942::BL0942::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file bl0942.cpp.

◆ read_reg_()

int esphome::bl0942::BL0942::read_reg_ ( uint8_t  reg)
protected

Definition at line 101 of file bl0942.cpp.

◆ received_package_()

void esphome::bl0942::BL0942::received_package_ ( DataPacket data)
protected

Definition at line 157 of file bl0942.cpp.

◆ set_address()

void esphome::bl0942::BL0942::set_address ( uint8_t  address)
inline

Definition at line 95 of file bl0942.h.

◆ set_current_reference()

void esphome::bl0942::BL0942::set_current_reference ( float  current_ref)
inline

Definition at line 97 of file bl0942.h.

◆ set_current_sensor()

void esphome::bl0942::BL0942::set_current_sensor ( sensor::Sensor current_sensor)
inline

Definition at line 90 of file bl0942.h.

◆ set_energy_reference()

void esphome::bl0942::BL0942::set_energy_reference ( float  energy_ref)
inline

Definition at line 101 of file bl0942.h.

◆ set_energy_sensor()

void esphome::bl0942::BL0942::set_energy_sensor ( sensor::Sensor energy_sensor)
inline

Definition at line 92 of file bl0942.h.

◆ set_frequency_sensor()

void esphome::bl0942::BL0942::set_frequency_sensor ( sensor::Sensor frequency_sensor)
inline

Definition at line 93 of file bl0942.h.

◆ set_line_freq()

void esphome::bl0942::BL0942::set_line_freq ( LineFrequency  freq)
inline

Definition at line 94 of file bl0942.h.

◆ set_power_reference()

void esphome::bl0942::BL0942::set_power_reference ( float  power_ref)
inline

Definition at line 105 of file bl0942.h.

◆ set_power_sensor()

void esphome::bl0942::BL0942::set_power_sensor ( sensor::Sensor power_sensor)
inline

Definition at line 91 of file bl0942.h.

◆ set_reset()

void esphome::bl0942::BL0942::set_reset ( bool  reset)
inline

Definition at line 96 of file bl0942.h.

◆ set_voltage_reference()

void esphome::bl0942::BL0942::set_voltage_reference ( float  voltage_ref)
inline

Definition at line 109 of file bl0942.h.

◆ set_voltage_sensor()

void esphome::bl0942::BL0942::set_voltage_sensor ( sensor::Sensor voltage_sensor)
inline

Definition at line 89 of file bl0942.h.

◆ setup()

void esphome::bl0942::BL0942::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 124 of file bl0942.cpp.

◆ update()

void esphome::bl0942::BL0942::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 119 of file bl0942.cpp.

◆ validate_checksum_()

bool esphome::bl0942::BL0942::validate_checksum_ ( DataPacket data)
protected

Definition at line 73 of file bl0942.cpp.

◆ write_reg_()

void esphome::bl0942::BL0942::write_reg_ ( uint8_t  reg,
uint32_t  val 
)
protected

Definition at line 87 of file bl0942.cpp.

Field Documentation

◆ address_

uint8_t esphome::bl0942::BL0942::address_ = 0
protected

Definition at line 140 of file bl0942.h.

◆ current_reference_

float esphome::bl0942::BL0942::current_reference_ = BL0942_IREF
protected

Definition at line 135 of file bl0942.h.

◆ current_reference_set_

bool esphome::bl0942::BL0942::current_reference_set_ = false
protected

Definition at line 136 of file bl0942.h.

◆ current_sensor_

sensor::Sensor* esphome::bl0942::BL0942::current_sensor_ {nullptr}
protected

Definition at line 121 of file bl0942.h.

◆ energy_reference_

float esphome::bl0942::BL0942::energy_reference_ = BL0942_EREF
protected

Definition at line 138 of file bl0942.h.

◆ energy_reference_set_

bool esphome::bl0942::BL0942::energy_reference_set_ = false
protected

Definition at line 139 of file bl0942.h.

◆ energy_sensor_

sensor::Sensor* esphome::bl0942::BL0942::energy_sensor_ {nullptr}
protected

Definition at line 125 of file bl0942.h.

◆ frequency_sensor_

sensor::Sensor* esphome::bl0942::BL0942::frequency_sensor_ {nullptr}
protected

Definition at line 126 of file bl0942.h.

◆ line_freq_

LineFrequency esphome::bl0942::BL0942::line_freq_ = LINE_FREQUENCY_50HZ
protected

Definition at line 142 of file bl0942.h.

◆ power_reference_

float esphome::bl0942::BL0942::power_reference_ = BL0942_PREF
protected

Definition at line 129 of file bl0942.h.

◆ power_reference_set_

bool esphome::bl0942::BL0942::power_reference_set_ = false
protected

Definition at line 130 of file bl0942.h.

◆ power_sensor_

sensor::Sensor* esphome::bl0942::BL0942::power_sensor_ {nullptr}
protected

Definition at line 124 of file bl0942.h.

◆ prev_cf_cnt_

uint32_t esphome::bl0942::BL0942::prev_cf_cnt_ = 0
protected

Definition at line 144 of file bl0942.h.

◆ reset_

bool esphome::bl0942::BL0942::reset_ = false
protected

Definition at line 141 of file bl0942.h.

◆ rx_start_

uint32_t esphome::bl0942::BL0942::rx_start_ = 0
protected

Definition at line 143 of file bl0942.h.

◆ voltage_reference_

float esphome::bl0942::BL0942::voltage_reference_ = BL0942_UREF
protected

Definition at line 132 of file bl0942.h.

◆ voltage_reference_set_

bool esphome::bl0942::BL0942::voltage_reference_set_ = false
protected

Definition at line 133 of file bl0942.h.

◆ voltage_sensor_

sensor::Sensor* esphome::bl0942::BL0942::voltage_sensor_ {nullptr}
protected

Definition at line 120 of file bl0942.h.


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