ESPHome  2022.6.2
Public Member Functions | Protected Attributes
esphome::pzemdc::PZEMDC Class Reference

#include <pzemdc.h>

Inheritance diagram for esphome::pzemdc::PZEMDC:
esphome::PollingComponent esphome::modbus::ModbusDevice 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_frequency_sensor (sensor::Sensor *frequency_sensor)
 
void set_powerfactor_sensor (sensor::Sensor *powerfactor_sensor)
 
void update () override
 
void on_modbus_data (const std::vector< uint8_t > &data) 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 void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
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::modbus::ModbusDevice
void set_parent (Modbus *parent)
 
void set_address (uint8_t address)
 
virtual void on_modbus_error (uint8_t function_code, uint8_t exception_code)
 
void send (uint8_t function, uint16_t start_address, uint16_t number_of_entities, uint8_t payload_len=0, const uint8_t *payload=nullptr)
 
void send_raw (const std::vector< uint8_t > &payload)
 
bool waiting_for_response ()
 

Protected Attributes

sensor::Sensorvoltage_sensor_
 
sensor::Sensorcurrent_sensor_
 
sensor::Sensorpower_sensor_
 
sensor::Sensorfrequency_sensor_
 
sensor::Sensorpower_factor_sensor_
 
- 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::modbus::ModbusDevice
friend Modbus
 
Modbusparent_
 
uint8_t address_
 

Additional Inherited Members

- 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...
 

Detailed Description

Definition at line 10 of file pzemdc.h.

Member Function Documentation

◆ dump_config()

void esphome::pzemdc::PZEMDC::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 50 of file pzemdc.cpp.

◆ on_modbus_data()

void esphome::pzemdc::PZEMDC::on_modbus_data ( const std::vector< uint8_t > &  data)
overridevirtual

Implements esphome::modbus::ModbusDevice.

Definition at line 12 of file pzemdc.cpp.

◆ set_current_sensor()

void esphome::pzemdc::PZEMDC::set_current_sensor ( sensor::Sensor current_sensor)
inline

Definition at line 13 of file pzemdc.h.

◆ set_frequency_sensor()

void esphome::pzemdc::PZEMDC::set_frequency_sensor ( sensor::Sensor frequency_sensor)
inline

Definition at line 15 of file pzemdc.h.

◆ set_power_sensor()

void esphome::pzemdc::PZEMDC::set_power_sensor ( sensor::Sensor power_sensor)
inline

Definition at line 14 of file pzemdc.h.

◆ set_powerfactor_sensor()

void esphome::pzemdc::PZEMDC::set_powerfactor_sensor ( sensor::Sensor powerfactor_sensor)
inline

Definition at line 16 of file pzemdc.h.

◆ set_voltage_sensor()

void esphome::pzemdc::PZEMDC::set_voltage_sensor ( sensor::Sensor voltage_sensor)
inline

Definition at line 12 of file pzemdc.h.

◆ update()

void esphome::pzemdc::PZEMDC::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 49 of file pzemdc.cpp.

Field Documentation

◆ current_sensor_

sensor::Sensor* esphome::pzemdc::PZEMDC::current_sensor_
protected

Definition at line 26 of file pzemdc.h.

◆ frequency_sensor_

sensor::Sensor* esphome::pzemdc::PZEMDC::frequency_sensor_
protected

Definition at line 28 of file pzemdc.h.

◆ power_factor_sensor_

sensor::Sensor* esphome::pzemdc::PZEMDC::power_factor_sensor_
protected

Definition at line 29 of file pzemdc.h.

◆ power_sensor_

sensor::Sensor* esphome::pzemdc::PZEMDC::power_sensor_
protected

Definition at line 27 of file pzemdc.h.

◆ voltage_sensor_

sensor::Sensor* esphome::pzemdc::PZEMDC::voltage_sensor_
protected

Definition at line 25 of file pzemdc.h.


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