ESPHome  2024.4.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::cs5460a::CS5460AComponent Class Reference

#include <cs5460a.h>

Inheritance diagram for esphome::cs5460a::CS5460AComponent:
esphome::Component esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ > esphome::spi::SPIClient

Public Member Functions

void set_samples (uint32_t samples)
void set_phase_offset (int8_t phase_offset)
void set_pga_gain (CS5460APGAGain pga_gain)
void set_gains (float current_gain, float voltage_gain)
void set_hpf_enable (bool current_hpf, bool voltage_hpf)
void set_pulse_energy_wh (float pulse_energy_wh)
void set_current_sensor (sensor::Sensor *current_sensor)
void set_voltage_sensor (sensor::Sensor *voltage_sensor)
void set_power_sensor (sensor::Sensor *power_sensor)
void restart ()
void setup () override
void loop () override
float get_setup_priority () const override
void dump_config () override
- Public Member Functions inherited from esphome::Component
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 ()
bool is_ready ()
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::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_1MHZ >
 SPIDevice ()
 SPIDevice (SPIComponent *parent, GPIOPin *cs_pin)
void spi_setup () override
void spi_teardown () override
void set_spi_parent (SPIComponent *parent)
void set_cs_pin (GPIOPin *cs)
void set_data_rate (uint32_t data_rate)
void set_bit_order (SPIBitOrder order)
void set_mode (SPIMode mode)
uint8_t read_byte ()
void read_array (uint8_t *data, size_t length)
void write (uint16_t data, size_t num_bits)
 Write a single data item, up to 32 bits. More...
void write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)
void write_byte (uint8_t data)
void transfer_array (uint8_t *data, size_t length)
 Write the array data, replace with received data. More...
void transfer_array (std::array< uint8_t, N > &data)
uint8_t transfer_byte (uint8_t data)
void write_byte16 (uint16_t data)
 Write 16 bit data. More...
void write_array16 (const uint16_t *data, size_t length)
 Write an array of data as 16 bit values, byte-swapping if required. More...
void enable ()
void disable ()
void write_array (const uint8_t *data, size_t length)
void write_array (const std::array< uint8_t, N > &data)
void write_array (const std::vector< uint8_t > &data)
- Public Member Functions inherited from esphome::spi::SPIClient
 SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)
bool spi_is_ready ()

Protected Member Functions

void write_register_ (enum CS5460ARegister addr, uint32_t value)
uint32_t read_register_ (uint8_t addr)
bool softreset_ ()
void hw_init_ ()
void restart_ ()
void started_ ()
void schedule_next_check_ ()
bool check_status_ ()
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
virtual void call_setup ()
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

uint32_t samples_
int8_t phase_offset_
CS5460APGAGain pga_gain_
float current_gain_
float voltage_gain_
bool current_hpf_
bool voltage_hpf_
float pulse_energy_wh_
sensor::Sensorcurrent_sensor_ {nullptr}
sensor::Sensorvoltage_sensor_ {nullptr}
sensor::Sensorpower_sensor_ {nullptr}
float current_multiplier_
float voltage_multiplier_
float power_multiplier_
float pulse_freq_
uint32_t expect_data_ts_
uint32_t prev_raw_current_ {0}
uint32_t prev_raw_energy_ {0}
- 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::spi::SPIClient
SPIBitOrder bit_order_ {BIT_ORDER_MSB_FIRST}
SPIMode mode_ {MODE0}
uint32_t data_rate_ {1000000}
SPIComponentparent_ {nullptr}
GPIOPincs_ {nullptr}
SPIDelegatedelegate_ {SPIDelegate::NULL_DELEGATE}

Detailed Description

Definition at line 56 of file cs5460a.h.

Member Function Documentation

◆ check_status_()

bool esphome::cs5460a::CS5460AComponent::check_status_ ( )

Definition at line 167 of file cs5460a.cpp.

◆ dump_config()

void esphome::cs5460a::CS5460AComponent::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 319 of file cs5460a.cpp.

◆ get_setup_priority()

float esphome::cs5460a::CS5460AComponent::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 80 of file cs5460a.h.

◆ hw_init_()

void esphome::cs5460a::CS5460AComponent::hw_init_ ( )

Definition at line 77 of file cs5460a.cpp.

◆ loop()

void esphome::cs5460a::CS5460AComponent::loop ( )

Reimplemented from esphome::Component.

Definition at line 79 of file cs5460a.h.

◆ read_register_()

uint32_t esphome::cs5460a::CS5460AComponent::read_register_ ( uint8_t  addr)

Definition at line 16 of file cs5460a.cpp.

◆ restart()

void esphome::cs5460a::CS5460AComponent::restart ( )

Definition at line 76 of file cs5460a.h.

◆ restart_()

void esphome::cs5460a::CS5460AComponent::restart_ ( )

Definition at line 104 of file cs5460a.cpp.

◆ schedule_next_check_()

void esphome::cs5460a::CS5460AComponent::schedule_next_check_ ( )

Definition at line 132 of file cs5460a.cpp.

◆ set_current_sensor()

void esphome::cs5460a::CS5460AComponent::set_current_sensor ( sensor::Sensor current_sensor)

Definition at line 72 of file cs5460a.h.

◆ set_gains()

void esphome::cs5460a::CS5460AComponent::set_gains ( float  current_gain,
float  voltage_gain 

Definition at line 63 of file cs5460a.h.

◆ set_hpf_enable()

void esphome::cs5460a::CS5460AComponent::set_hpf_enable ( bool  current_hpf,
bool  voltage_hpf 

Definition at line 67 of file cs5460a.h.

◆ set_pga_gain()

void esphome::cs5460a::CS5460AComponent::set_pga_gain ( CS5460APGAGain  pga_gain)

Definition at line 62 of file cs5460a.h.

◆ set_phase_offset()

void esphome::cs5460a::CS5460AComponent::set_phase_offset ( int8_t  phase_offset)

Definition at line 61 of file cs5460a.h.

◆ set_power_sensor()

void esphome::cs5460a::CS5460AComponent::set_power_sensor ( sensor::Sensor power_sensor)

Definition at line 74 of file cs5460a.h.

◆ set_pulse_energy_wh()

void esphome::cs5460a::CS5460AComponent::set_pulse_energy_wh ( float  pulse_energy_wh)

Definition at line 71 of file cs5460a.h.

◆ set_samples()

void esphome::cs5460a::CS5460AComponent::set_samples ( uint32_t  samples)

Definition at line 60 of file cs5460a.h.

◆ set_voltage_sensor()

void esphome::cs5460a::CS5460AComponent::set_voltage_sensor ( sensor::Sensor voltage_sensor)

Definition at line 73 of file cs5460a.h.

◆ setup()

void esphome::cs5460a::CS5460AComponent::setup ( )

Reimplemented from esphome::Component.

Definition at line 54 of file cs5460a.cpp.

◆ softreset_()

bool esphome::cs5460a::CS5460AComponent::softreset_ ( )

Definition at line 27 of file cs5460a.cpp.

◆ started_()

void esphome::cs5460a::CS5460AComponent::started_ ( )

Definition at line 115 of file cs5460a.cpp.

◆ write_register_()

void esphome::cs5460a::CS5460AComponent::write_register_ ( enum CS5460ARegister  addr,
uint32_t  value 

Definition at line 9 of file cs5460a.cpp.

Field Documentation

◆ current_gain_

float esphome::cs5460a::CS5460AComponent::current_gain_

Definition at line 87 of file cs5460a.h.

◆ current_hpf_

bool esphome::cs5460a::CS5460AComponent::current_hpf_

Definition at line 89 of file cs5460a.h.

◆ current_multiplier_

float esphome::cs5460a::CS5460AComponent::current_multiplier_

Definition at line 105 of file cs5460a.h.

◆ current_sensor_

sensor::Sensor* esphome::cs5460a::CS5460AComponent::current_sensor_ {nullptr}

Definition at line 92 of file cs5460a.h.

◆ expect_data_ts_

uint32_t esphome::cs5460a::CS5460AComponent::expect_data_ts_

Definition at line 109 of file cs5460a.h.

◆ pga_gain_

CS5460APGAGain esphome::cs5460a::CS5460AComponent::pga_gain_

Definition at line 86 of file cs5460a.h.

◆ phase_offset_

int8_t esphome::cs5460a::CS5460AComponent::phase_offset_

Definition at line 85 of file cs5460a.h.

◆ power_multiplier_

float esphome::cs5460a::CS5460AComponent::power_multiplier_

Definition at line 107 of file cs5460a.h.

◆ power_sensor_

sensor::Sensor* esphome::cs5460a::CS5460AComponent::power_sensor_ {nullptr}

Definition at line 94 of file cs5460a.h.

◆ prev_raw_current_

uint32_t esphome::cs5460a::CS5460AComponent::prev_raw_current_ {0}

Definition at line 110 of file cs5460a.h.

◆ prev_raw_energy_

uint32_t esphome::cs5460a::CS5460AComponent::prev_raw_energy_ {0}

Definition at line 111 of file cs5460a.h.

◆ pulse_energy_wh_

float esphome::cs5460a::CS5460AComponent::pulse_energy_wh_

Definition at line 91 of file cs5460a.h.

◆ pulse_freq_

float esphome::cs5460a::CS5460AComponent::pulse_freq_

Definition at line 108 of file cs5460a.h.

◆ samples_

uint32_t esphome::cs5460a::CS5460AComponent::samples_

Definition at line 84 of file cs5460a.h.

◆ voltage_gain_

float esphome::cs5460a::CS5460AComponent::voltage_gain_

Definition at line 88 of file cs5460a.h.

◆ voltage_hpf_

bool esphome::cs5460a::CS5460AComponent::voltage_hpf_

Definition at line 90 of file cs5460a.h.

◆ voltage_multiplier_

float esphome::cs5460a::CS5460AComponent::voltage_multiplier_

Definition at line 106 of file cs5460a.h.

◆ voltage_sensor_

sensor::Sensor* esphome::cs5460a::CS5460AComponent::voltage_sensor_ {nullptr}

Definition at line 93 of file cs5460a.h.

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