ESPHome  2022.1.1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::pzem004t::PZEM004T Class Reference

#include <pzem004t.h>

Inheritance diagram for esphome::pzem004t::PZEM004T:
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 setup () override
 
void loop () override
 
void update () 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...
 
- 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 ()
 
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 Types

enum  PZEM004TReadState {
  SET_ADDRESS = 0xB4, READ_VOLTAGE = 0xB0, READ_CURRENT = 0xB1, READ_POWER = 0xB2,
  READ_ENERGY = 0xB3, DONE = 0x00
}
 

Protected Member Functions

void write_state_ (PZEM004TReadState state)
 
- 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_
 
sensor::Sensorcurrent_sensor_
 
sensor::Sensorpower_sensor_
 
sensor::Sensorenergy_sensor_
 
enum esphome::pzem004t::PZEM004T::PZEM004TReadState DONE
 
uint32_t last_read_ {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 10 of file pzem004t.h.

Member Enumeration Documentation

◆ PZEM004TReadState

Enumerator
SET_ADDRESS 
READ_VOLTAGE 
READ_CURRENT 
READ_POWER 
READ_ENERGY 
DONE 

Definition at line 31 of file pzem004t.h.

Member Function Documentation

◆ dump_config()

void esphome::pzem004t::PZEM004T::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 117 of file pzem004t.cpp.

◆ loop()

void esphome::pzem004t::PZEM004T::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file pzem004t.cpp.

◆ set_current_sensor()

void esphome::pzem004t::PZEM004T::set_current_sensor ( sensor::Sensor current_sensor)
inline

Definition at line 13 of file pzem004t.h.

◆ set_energy_sensor()

void esphome::pzem004t::PZEM004T::set_energy_sensor ( sensor::Sensor energy_sensor)
inline

Definition at line 15 of file pzem004t.h.

◆ set_power_sensor()

void esphome::pzem004t::PZEM004T::set_power_sensor ( sensor::Sensor power_sensor)
inline

Definition at line 14 of file pzem004t.h.

◆ set_voltage_sensor()

void esphome::pzem004t::PZEM004T::set_voltage_sensor ( sensor::Sensor voltage_sensor)
inline

Definition at line 12 of file pzem004t.h.

◆ setup()

void esphome::pzem004t::PZEM004T::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file pzem004t.cpp.

◆ update()

void esphome::pzem004t::PZEM004T::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 97 of file pzem004t.cpp.

◆ write_state_()

void esphome::pzem004t::PZEM004T::write_state_ ( PZEM004T::PZEM004TReadState  state)
protected

Definition at line 98 of file pzem004t.cpp.

Field Documentation

◆ current_sensor_

sensor::Sensor* esphome::pzem004t::PZEM004T::current_sensor_
protected

Definition at line 27 of file pzem004t.h.

◆ DONE

enum esphome::pzem004t::PZEM004T::PZEM004TReadState esphome::pzem004t::PZEM004T::DONE
protected

◆ energy_sensor_

sensor::Sensor* esphome::pzem004t::PZEM004T::energy_sensor_
protected

Definition at line 29 of file pzem004t.h.

◆ last_read_

uint32_t esphome::pzem004t::PZEM004T::last_read_ {0}
protected

Definition at line 42 of file pzem004t.h.

◆ power_sensor_

sensor::Sensor* esphome::pzem004t::PZEM004T::power_sensor_
protected

Definition at line 28 of file pzem004t.h.

◆ voltage_sensor_

sensor::Sensor* esphome::pzem004t::PZEM004T::voltage_sensor_
protected

Definition at line 26 of file pzem004t.h.


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