ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::cse7761::CSE7761Component Class Reference

This class implements support for the CSE7761 UART power sensor. More...

#include <cse7761.h>

Inheritance diagram for esphome::cse7761::CSE7761Component:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

void set_voltage_sensor (sensor::Sensor *voltage_sensor)
 
void set_active_power_1_sensor (sensor::Sensor *power_sensor_1)
 
void set_current_1_sensor (sensor::Sensor *current_sensor_1)
 
void set_active_power_2_sensor (sensor::Sensor *power_sensor_2)
 
void set_current_2_sensor (sensor::Sensor *current_sensor_2)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () 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 void loop ()
 This method will be called repeatedly. 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 write_ (uint8_t reg, uint16_t data)
 
bool read_once_ (uint8_t reg, uint8_t size, uint32_t *value)
 
uint32_t read_ (uint8_t reg, uint8_t size)
 
uint32_t coefficient_by_unit_ (uint32_t unit)
 
bool chip_init_ ()
 
void get_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()> &&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...
 

Protected Attributes

sensor::Sensorvoltage_sensor_ {nullptr}
 
sensor::Sensorpower_sensor_1_ {nullptr}
 
sensor::Sensorcurrent_sensor_1_ {nullptr}
 
sensor::Sensorpower_sensor_2_ {nullptr}
 
sensor::Sensorcurrent_sensor_2_ {nullptr}
 
CSE7761DataStruct data_
 
- 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

This class implements support for the CSE7761 UART power sensor.

Definition at line 22 of file cse7761.h.

Member Function Documentation

◆ chip_init_()

bool esphome::cse7761::CSE7761Component::chip_init_ ( )
protected

Definition at line 164 of file cse7761.cpp.

◆ coefficient_by_unit_()

uint32_t esphome::cse7761::CSE7761Component::coefficient_by_unit_ ( uint32_t  unit)
protected

Definition at line 152 of file cse7761.cpp.

◆ dump_config()

void esphome::cse7761::CSE7761Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 57 of file cse7761.cpp.

◆ get_data_()

void esphome::cse7761::CSE7761Component::get_data_ ( )
protected

Definition at line 194 of file cse7761.cpp.

◆ get_setup_priority()

float esphome::cse7761::CSE7761Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 66 of file cse7761.cpp.

◆ read_()

uint32_t esphome::cse7761::CSE7761Component::read_ ( uint8_t  reg,
uint8_t  size 
)
protected

Definition at line 139 of file cse7761.cpp.

◆ read_once_()

bool esphome::cse7761::CSE7761Component::read_once_ ( uint8_t  reg,
uint8_t  size,
uint32_t *  value 
)
protected

Definition at line 100 of file cse7761.cpp.

◆ set_active_power_1_sensor()

void esphome::cse7761::CSE7761Component::set_active_power_1_sensor ( sensor::Sensor power_sensor_1)
inline

Definition at line 25 of file cse7761.h.

◆ set_active_power_2_sensor()

void esphome::cse7761::CSE7761Component::set_active_power_2_sensor ( sensor::Sensor power_sensor_2)
inline

Definition at line 27 of file cse7761.h.

◆ set_current_1_sensor()

void esphome::cse7761::CSE7761Component::set_current_1_sensor ( sensor::Sensor current_sensor_1)
inline

Definition at line 26 of file cse7761.h.

◆ set_current_2_sensor()

void esphome::cse7761::CSE7761Component::set_current_2_sensor ( sensor::Sensor current_sensor_2)
inline

Definition at line 28 of file cse7761.h.

◆ set_voltage_sensor()

void esphome::cse7761::CSE7761Component::set_voltage_sensor ( sensor::Sensor voltage_sensor)
inline

Definition at line 24 of file cse7761.h.

◆ setup()

void esphome::cse7761::CSE7761Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file cse7761.cpp.

◆ update()

void esphome::cse7761::CSE7761Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 68 of file cse7761.cpp.

◆ write_()

void esphome::cse7761::CSE7761Component::write_ ( uint8_t  reg,
uint16_t  data 
)
protected

Definition at line 74 of file cse7761.cpp.

Field Documentation

◆ current_sensor_1_

sensor::Sensor* esphome::cse7761::CSE7761Component::current_sensor_1_ {nullptr}
protected

Definition at line 38 of file cse7761.h.

◆ current_sensor_2_

sensor::Sensor* esphome::cse7761::CSE7761Component::current_sensor_2_ {nullptr}
protected

Definition at line 40 of file cse7761.h.

◆ data_

CSE7761DataStruct esphome::cse7761::CSE7761Component::data_
protected

Definition at line 41 of file cse7761.h.

◆ power_sensor_1_

sensor::Sensor* esphome::cse7761::CSE7761Component::power_sensor_1_ {nullptr}
protected

Definition at line 37 of file cse7761.h.

◆ power_sensor_2_

sensor::Sensor* esphome::cse7761::CSE7761Component::power_sensor_2_ {nullptr}
protected

Definition at line 39 of file cse7761.h.

◆ voltage_sensor_

sensor::Sensor* esphome::cse7761::CSE7761Component::voltage_sensor_ {nullptr}
protected

Definition at line 36 of file cse7761.h.


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