ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::cse7761::CSE7761Component Class Referencefinal

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

 CSE7761Component (CSE7761CurrentInput current_input)
 
void set_voltage_sensor (sensor::Sensor *voltage_sensor)
 
void set_frequency_sensor (sensor::Sensor *frequency_sensor)
 
void set_power_factor_1_sensor (sensor::Sensor *power_factor_sensor_1)
 
void set_active_power_1_sensor (sensor::Sensor *power_sensor_1)
 
void set_current_1_sensor (sensor::Sensor *current_sensor_1)
 
void set_energy_1_sensor (sensor::Sensor *energy_sensor_1)
 
void set_active_power_2_sensor (sensor::Sensor *power_sensor_2)
 
void set_current_2_sensor (sensor::Sensor *current_sensor_2)
 
void set_energy_2_sensor (sensor::Sensor *energy_sensor_2)
 
void setup () override
 
void dump_config () 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.
 
void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
virtual float get_setup_priority () const
 priority of setup().
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
bool status_comm_result (bool ok)
 Clears the warning when ok, else sets it with message (default "Communication failed"); returns ok.
 
bool status_comm_result (bool ok, const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
 ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name
 
void status_momentary_warning (uint32_t length=5000)
 Set warning status flag and clear it after length ms.
 
void status_momentary_warning (const LogString *message, uint32_t length=5000)
 
 ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name
 
void status_momentary_error (uint32_t length=5000)
 Set error status flag and clear it after length ms.
 
void status_momentary_error (const LogString *message, uint32_t length=5000)
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 
- 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 set_rx_full_threshold (size_t rx_full_threshold)
 
void set_rx_full_threshold_ms (size_t time)
 
size_t get_rx_full_threshold ()
 
void set_rx_timeout (size_t rx_timeout)
 
size_t get_rx_timeout ()
 
void write_array (const uint8_t *data, size_t len)
 
void write_array_progmem (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 ()
 
size_t available ()
 
template<size_t N = 64, typename F >
bool read_available_chunks (F &&on_chunk)
 Pass the bytes available now to on_chunk(data, len) in N byte chunks; returning false stops.
 
template<size_t N = 64, typename F >
bool read_available_chunks (F &&on_chunk, size_t count)
 Same, reading exactly count bytes; count must not exceed available().
 
template<size_t N = 64, typename F >
bool read_available (F &&on_byte)
 Same as read_available_chunks(), calling on_byte(uint8_t) once per byte.
 
template<size_t N = 64, typename F >
bool read_available (F &&on_byte, size_t count)
 
void discard_available ()
 Read and drop every byte waiting in the receive buffer.
 
UARTFlushResult flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
 ESPDEPRECATED ("Use uart.final_validate_device_schema() in Python instead. Removed in 2027.3.0", "2026.9.0") void check_uart_settings(uint32_t baud_rate
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning.
 

Protected Member Functions

bool is_current_transformer_ () const
 
void write_ (uint8_t reg, uint16_t data)
 
bool read_once_ (uint8_t reg, uint8_t size, uint32_t *value)
 
bool read_ (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
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
bool set_error_flag_ (const LogString *message)
 Set the error flag and log it; true when it was not set before.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Protected Attributes

sensor::Sensor * voltage_sensor_ {nullptr}
 
sensor::Sensor * frequency_sensor_ {nullptr}
 
sensor::Sensor * power_factor_sensor_1_ {nullptr}
 
sensor::Sensor * power_sensor_1_ {nullptr}
 
sensor::Sensor * current_sensor_1_ {nullptr}
 
sensor::Sensor * power_sensor_2_ {nullptr}
 
sensor::Sensor * current_sensor_2_ {nullptr}
 
sensor::Sensor * energy_sensors_ [2] {nullptr, nullptr}
 
CSE7761DataStruct data_
 
CSE7761EnergyChannel energy_ [2]
 
const CSE7761CurrentInput current_input_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent * parent_ {nullptr}
 

Additional Inherited Members

- Data Fields inherited from esphome::Component
uint32_t length = 5000)
 
- Data Fields inherited from esphome::uart::UARTDevice
uint8_t stop_bits = 1
 
uint8_t UARTParityOptions parity = UART_CONFIG_PARITY_NONE
 
uint8_t UARTParityOptions uint8_t data_bits = 8)
 
- Static Protected Member Functions inherited from esphome::uart::UARTDevice
template<typename F , typename... A>
static bool continue_after (F &f, A... args)
 Call f(args...) and return its result; a void callback always continues.
 

Detailed Description

This class implements support for the CSE7761 UART power sensor.

Definition at line 30 of file cse7761.h.

Constructor & Destructor Documentation

◆ CSE7761Component()

esphome::cse7761::CSE7761Component::CSE7761Component ( CSE7761CurrentInput current_input)
inlineexplicit

Definition at line 32 of file cse7761.h.

Member Function Documentation

◆ chip_init_()

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

Definition at line 184 of file cse7761.cpp.

◆ coefficient_by_unit_()

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

Definition at line 165 of file cse7761.cpp.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 74 of file cse7761.cpp.

◆ get_data_()

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

Definition at line 231 of file cse7761.cpp.

◆ is_current_transformer_()

bool esphome::cse7761::CSE7761Component::is_current_transformer_ ( ) const
inlineprotected

Definition at line 62 of file cse7761.h.

◆ read_() [1/2]

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

Definition at line 160 of file cse7761.cpp.

◆ read_() [2/2]

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

Definition at line 151 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 118 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 38 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 41 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 39 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 42 of file cse7761.h.

◆ set_energy_1_sensor()

void esphome::cse7761::CSE7761Component::set_energy_1_sensor ( sensor::Sensor * energy_sensor_1)
inline

Definition at line 40 of file cse7761.h.

◆ set_energy_2_sensor()

void esphome::cse7761::CSE7761Component::set_energy_2_sensor ( sensor::Sensor * energy_sensor_2)
inline

Definition at line 43 of file cse7761.h.

◆ set_frequency_sensor()

void esphome::cse7761::CSE7761Component::set_frequency_sensor ( sensor::Sensor * frequency_sensor)
inline

Definition at line 34 of file cse7761.h.

◆ set_power_factor_1_sensor()

void esphome::cse7761::CSE7761Component::set_power_factor_1_sensor ( sensor::Sensor * power_factor_sensor_1)
inline

Definition at line 35 of file cse7761.h.

◆ set_voltage_sensor()

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

Definition at line 33 of file cse7761.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 62 of file cse7761.cpp.

◆ update()

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

Implements esphome::PollingComponent.

Definition at line 90 of file cse7761.cpp.

◆ write_()

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

Definition at line 96 of file cse7761.cpp.

Field Documentation

◆ current_input_

const CSE7761CurrentInput esphome::cse7761::CSE7761Component::current_input_
protected

Definition at line 60 of file cse7761.h.

◆ current_sensor_1_

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

Definition at line 54 of file cse7761.h.

◆ current_sensor_2_

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

Definition at line 56 of file cse7761.h.

◆ data_

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

Definition at line 58 of file cse7761.h.

◆ energy_

CSE7761EnergyChannel esphome::cse7761::CSE7761Component::energy_[2]
protected

Definition at line 59 of file cse7761.h.

◆ energy_sensors_

sensor::Sensor* esphome::cse7761::CSE7761Component::energy_sensors_[2] {nullptr, nullptr}
protected

Definition at line 57 of file cse7761.h.

◆ frequency_sensor_

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

Definition at line 51 of file cse7761.h.

◆ power_factor_sensor_1_

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

Definition at line 52 of file cse7761.h.

◆ power_sensor_1_

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

Definition at line 53 of file cse7761.h.

◆ power_sensor_2_

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

Definition at line 55 of file cse7761.h.

◆ voltage_sensor_

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

Definition at line 50 of file cse7761.h.


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