ESPHome  2024.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::atm90e26::ATM90E26Component Class Reference

#include <atm90e26.h>

Inheritance diagram for esphome::atm90e26::ATM90E26Component:
esphome::PollingComponent esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_200KHZ > esphome::Component esphome::spi::SPIClient

Public Member Functions

void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () override
 
void set_voltage_sensor (sensor::Sensor *obj)
 
void set_current_sensor (sensor::Sensor *obj)
 
void set_power_sensor (sensor::Sensor *obj)
 
void set_reactive_power_sensor (sensor::Sensor *obj)
 
void set_forward_active_energy_sensor (sensor::Sensor *obj)
 
void set_reverse_active_energy_sensor (sensor::Sensor *obj)
 
void set_power_factor_sensor (sensor::Sensor *obj)
 
void set_freq_sensor (sensor::Sensor *freq_sensor)
 
void set_line_freq (int freq)
 
void set_meter_constant (float val)
 
void set_pl_const (uint32_t pl_const)
 
void set_gain_metering (uint16_t gain)
 
void set_gain_voltage (uint16_t gain)
 
void set_gain_ct (uint16_t gain)
 
void set_gain_pga (uint16_t gain)
 
void set_n_line_gain (uint16_t gain)
 
- 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 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 ()
 
bool is_ready ()
 
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::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH, spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_200KHZ >
 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

uint16_t read16_ (uint8_t a_register)
 
int read32_ (uint8_t addr_h, uint8_t addr_l)
 
void write16_ (uint8_t a_register, uint16_t val)
 
float get_line_voltage_ ()
 
float get_line_current_ ()
 
float get_active_power_ ()
 
float get_reactive_power_ ()
 
float get_power_factor_ ()
 
float get_forward_active_energy_ ()
 
float get_reverse_active_energy_ ()
 
float get_frequency_ ()
 
float get_chip_temperature_ ()
 
- 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::Sensorfreq_sensor_ {nullptr}
 
sensor::Sensorvoltage_sensor_ {nullptr}
 
sensor::Sensorcurrent_sensor_ {nullptr}
 
sensor::Sensorpower_sensor_ {nullptr}
 
sensor::Sensorreactive_power_sensor_ {nullptr}
 
sensor::Sensorpower_factor_sensor_ {nullptr}
 
sensor::Sensorforward_active_energy_sensor_ {nullptr}
 
sensor::Sensorreverse_active_energy_sensor_ {nullptr}
 
uint32_t cumulative_forward_active_energy_ {0}
 
uint32_t cumulative_reverse_active_energy_ {0}
 
uint16_t gain_metering_ {7481}
 
uint16_t gain_voltage_ {26400}
 
uint16_t gain_ct_ {31251}
 
uint16_t gain_pga_ {0x4}
 
uint16_t n_line_gain_ {0x2}
 
int line_freq_ {60}
 
float meter_constant_ {3200.0f}
 
uint32_t pl_const_ {1429876}
 
- 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::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 10 of file atm90e26.h.

Member Function Documentation

◆ dump_config()

void esphome::atm90e26::ATM90E26Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 134 of file atm90e26.cpp.

◆ get_active_power_()

float esphome::atm90e26::ATM90E26Component::get_active_power_ ( )
protected

Definition at line 189 of file atm90e26.cpp.

◆ get_chip_temperature_()

float esphome::atm90e26::ATM90E26Component::get_chip_temperature_ ( )
protected

◆ get_forward_active_energy_()

float esphome::atm90e26::ATM90E26Component::get_forward_active_energy_ ( )
protected

Definition at line 208 of file atm90e26.cpp.

◆ get_frequency_()

float esphome::atm90e26::ATM90E26Component::get_frequency_ ( )
protected

Definition at line 229 of file atm90e26.cpp.

◆ get_line_current_()

float esphome::atm90e26::ATM90E26Component::get_line_current_ ( )
protected

Definition at line 179 of file atm90e26.cpp.

◆ get_line_voltage_()

float esphome::atm90e26::ATM90E26Component::get_line_voltage_ ( )
protected

Definition at line 184 of file atm90e26.cpp.

◆ get_power_factor_()

float esphome::atm90e26::ATM90E26Component::get_power_factor_ ( )
protected

Definition at line 199 of file atm90e26.cpp.

◆ get_reactive_power_()

float esphome::atm90e26::ATM90E26Component::get_reactive_power_ ( )
protected

Definition at line 194 of file atm90e26.cpp.

◆ get_reverse_active_energy_()

float esphome::atm90e26::ATM90E26Component::get_reverse_active_energy_ ( )
protected

Definition at line 219 of file atm90e26.cpp.

◆ get_setup_priority()

float esphome::atm90e26::ATM90E26Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 150 of file atm90e26.cpp.

◆ read16_()

uint16_t esphome::atm90e26::ATM90E26Component::read16_ ( uint8_t  a_register)
protected

Definition at line 152 of file atm90e26.cpp.

◆ read32_()

int esphome::atm90e26::ATM90E26Component::read32_ ( uint8_t  addr_h,
uint8_t  addr_l 
)
protected

◆ set_current_sensor()

void esphome::atm90e26::ATM90E26Component::set_current_sensor ( sensor::Sensor obj)
inline

Definition at line 20 of file atm90e26.h.

◆ set_forward_active_energy_sensor()

void esphome::atm90e26::ATM90E26Component::set_forward_active_energy_sensor ( sensor::Sensor obj)
inline

Definition at line 23 of file atm90e26.h.

◆ set_freq_sensor()

void esphome::atm90e26::ATM90E26Component::set_freq_sensor ( sensor::Sensor freq_sensor)
inline

Definition at line 26 of file atm90e26.h.

◆ set_gain_ct()

void esphome::atm90e26::ATM90E26Component::set_gain_ct ( uint16_t  gain)
inline

Definition at line 32 of file atm90e26.h.

◆ set_gain_metering()

void esphome::atm90e26::ATM90E26Component::set_gain_metering ( uint16_t  gain)
inline

Definition at line 30 of file atm90e26.h.

◆ set_gain_pga()

void esphome::atm90e26::ATM90E26Component::set_gain_pga ( uint16_t  gain)
inline

Definition at line 33 of file atm90e26.h.

◆ set_gain_voltage()

void esphome::atm90e26::ATM90E26Component::set_gain_voltage ( uint16_t  gain)
inline

Definition at line 31 of file atm90e26.h.

◆ set_line_freq()

void esphome::atm90e26::ATM90E26Component::set_line_freq ( int  freq)
inline

Definition at line 27 of file atm90e26.h.

◆ set_meter_constant()

void esphome::atm90e26::ATM90E26Component::set_meter_constant ( float  val)
inline

Definition at line 28 of file atm90e26.h.

◆ set_n_line_gain()

void esphome::atm90e26::ATM90E26Component::set_n_line_gain ( uint16_t  gain)
inline

Definition at line 34 of file atm90e26.h.

◆ set_pl_const()

void esphome::atm90e26::ATM90E26Component::set_pl_const ( uint32_t  pl_const)
inline

Definition at line 29 of file atm90e26.h.

◆ set_power_factor_sensor()

void esphome::atm90e26::ATM90E26Component::set_power_factor_sensor ( sensor::Sensor obj)
inline

Definition at line 25 of file atm90e26.h.

◆ set_power_sensor()

void esphome::atm90e26::ATM90E26Component::set_power_sensor ( sensor::Sensor obj)
inline

Definition at line 21 of file atm90e26.h.

◆ set_reactive_power_sensor()

void esphome::atm90e26::ATM90E26Component::set_reactive_power_sensor ( sensor::Sensor obj)
inline

Definition at line 22 of file atm90e26.h.

◆ set_reverse_active_energy_sensor()

void esphome::atm90e26::ATM90E26Component::set_reverse_active_energy_sensor ( sensor::Sensor obj)
inline

Definition at line 24 of file atm90e26.h.

◆ set_voltage_sensor()

void esphome::atm90e26::ATM90E26Component::set_voltage_sensor ( sensor::Sensor obj)
inline

Definition at line 19 of file atm90e26.h.

◆ setup()

void esphome::atm90e26::ATM90E26Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 43 of file atm90e26.cpp.

◆ update()

void esphome::atm90e26::ATM90E26Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 10 of file atm90e26.cpp.

◆ write16_()

void esphome::atm90e26::ATM90E26Component::write16_ ( uint8_t  a_register,
uint16_t  val 
)
protected

Definition at line 168 of file atm90e26.cpp.

Field Documentation

◆ cumulative_forward_active_energy_

uint32_t esphome::atm90e26::ATM90E26Component::cumulative_forward_active_energy_ {0}
protected

Definition at line 59 of file atm90e26.h.

◆ cumulative_reverse_active_energy_

uint32_t esphome::atm90e26::ATM90E26Component::cumulative_reverse_active_energy_ {0}
protected

Definition at line 60 of file atm90e26.h.

◆ current_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::current_sensor_ {nullptr}
protected

Definition at line 53 of file atm90e26.h.

◆ forward_active_energy_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::forward_active_energy_sensor_ {nullptr}
protected

Definition at line 57 of file atm90e26.h.

◆ freq_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::freq_sensor_ {nullptr}
protected

Definition at line 51 of file atm90e26.h.

◆ gain_ct_

uint16_t esphome::atm90e26::ATM90E26Component::gain_ct_ {31251}
protected

Definition at line 63 of file atm90e26.h.

◆ gain_metering_

uint16_t esphome::atm90e26::ATM90E26Component::gain_metering_ {7481}
protected

Definition at line 61 of file atm90e26.h.

◆ gain_pga_

uint16_t esphome::atm90e26::ATM90E26Component::gain_pga_ {0x4}
protected

Definition at line 64 of file atm90e26.h.

◆ gain_voltage_

uint16_t esphome::atm90e26::ATM90E26Component::gain_voltage_ {26400}
protected

Definition at line 62 of file atm90e26.h.

◆ line_freq_

int esphome::atm90e26::ATM90E26Component::line_freq_ {60}
protected

Definition at line 66 of file atm90e26.h.

◆ meter_constant_

float esphome::atm90e26::ATM90E26Component::meter_constant_ {3200.0f}
protected

Definition at line 67 of file atm90e26.h.

◆ n_line_gain_

uint16_t esphome::atm90e26::ATM90E26Component::n_line_gain_ {0x2}
protected

Definition at line 65 of file atm90e26.h.

◆ pl_const_

uint32_t esphome::atm90e26::ATM90E26Component::pl_const_ {1429876}
protected

Definition at line 68 of file atm90e26.h.

◆ power_factor_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::power_factor_sensor_ {nullptr}
protected

Definition at line 56 of file atm90e26.h.

◆ power_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::power_sensor_ {nullptr}
protected

Definition at line 54 of file atm90e26.h.

◆ reactive_power_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::reactive_power_sensor_ {nullptr}
protected

Definition at line 55 of file atm90e26.h.

◆ reverse_active_energy_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::reverse_active_energy_sensor_ {nullptr}
protected

Definition at line 58 of file atm90e26.h.

◆ voltage_sensor_

sensor::Sensor* esphome::atm90e26::ATM90E26Component::voltage_sensor_ {nullptr}
protected

Definition at line 52 of file atm90e26.h.


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