ESPHome  2024.7.1
Data Structures | Public Member Functions | Protected Attributes
esphome::sdm_meter::SDMMeter Class Reference

#include <sdm_meter.h>

Inheritance diagram for esphome::sdm_meter::SDMMeter:
esphome::PollingComponent esphome::modbus::ModbusDevice esphome::Component

Data Structures

struct  SDMPhase

Public Member Functions

void set_voltage_sensor (uint8_t phase, sensor::Sensor *voltage_sensor)
void set_current_sensor (uint8_t phase, sensor::Sensor *current_sensor)
void set_active_power_sensor (uint8_t phase, sensor::Sensor *active_power_sensor)
void set_apparent_power_sensor (uint8_t phase, sensor::Sensor *apparent_power_sensor)
void set_reactive_power_sensor (uint8_t phase, sensor::Sensor *reactive_power_sensor)
void set_power_factor_sensor (uint8_t phase, sensor::Sensor *power_factor_sensor)
void set_phase_angle_sensor (uint8_t phase, sensor::Sensor *phase_angle_sensor)
void set_total_power_sensor (sensor::Sensor *total_power_sensor)
void set_frequency_sensor (sensor::Sensor *frequency_sensor)
void set_import_active_energy_sensor (sensor::Sensor *import_active_energy_sensor)
void set_export_active_energy_sensor (sensor::Sensor *export_active_energy_sensor)
void set_import_reactive_energy_sensor (sensor::Sensor *import_reactive_energy_sensor)
void set_export_reactive_energy_sensor (sensor::Sensor *export_reactive_energy_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...
void start_poller ()
void stop_poller ()
- 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 () const
bool is_ready () const
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::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)
virtual void on_modbus_read_registers (uint8_t function_code, uint16_t start_address, uint16_t number_of_registers)
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

struct esphome::sdm_meter::SDMMeter::SDMPhase phases_ [3]
sensor::Sensorfrequency_sensor_ {nullptr}
sensor::Sensortotal_power_sensor_ {nullptr}
sensor::Sensorimport_active_energy_sensor_ {nullptr}
sensor::Sensorexport_active_energy_sensor_ {nullptr}
sensor::Sensorimport_reactive_energy_sensor_ {nullptr}
sensor::Sensorexport_reactive_energy_sensor_ {nullptr}
- 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
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(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...

Detailed Description

Definition at line 12 of file sdm_meter.h.

Member Function Documentation

◆ dump_config()

void esphome::sdm_meter::SDMMeter::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 86 of file sdm_meter.cpp.

◆ on_modbus_data()

void esphome::sdm_meter::SDMMeter::on_modbus_data ( const std::vector< uint8_t > &  data)

Implements esphome::modbus::ModbusDevice.

Definition at line 13 of file sdm_meter.cpp.

◆ set_active_power_sensor()

void esphome::sdm_meter::SDMMeter::set_active_power_sensor ( uint8_t  phase,
sensor::Sensor active_power_sensor 

Definition at line 22 of file sdm_meter.h.

◆ set_apparent_power_sensor()

void esphome::sdm_meter::SDMMeter::set_apparent_power_sensor ( uint8_t  phase,
sensor::Sensor apparent_power_sensor 

Definition at line 26 of file sdm_meter.h.

◆ set_current_sensor()

void esphome::sdm_meter::SDMMeter::set_current_sensor ( uint8_t  phase,
sensor::Sensor current_sensor 

Definition at line 18 of file sdm_meter.h.

◆ set_export_active_energy_sensor()

void esphome::sdm_meter::SDMMeter::set_export_active_energy_sensor ( sensor::Sensor export_active_energy_sensor)

Definition at line 47 of file sdm_meter.h.

◆ set_export_reactive_energy_sensor()

void esphome::sdm_meter::SDMMeter::set_export_reactive_energy_sensor ( sensor::Sensor export_reactive_energy_sensor)

Definition at line 53 of file sdm_meter.h.

◆ set_frequency_sensor()

void esphome::sdm_meter::SDMMeter::set_frequency_sensor ( sensor::Sensor frequency_sensor)

Definition at line 43 of file sdm_meter.h.

◆ set_import_active_energy_sensor()

void esphome::sdm_meter::SDMMeter::set_import_active_energy_sensor ( sensor::Sensor import_active_energy_sensor)

Definition at line 44 of file sdm_meter.h.

◆ set_import_reactive_energy_sensor()

void esphome::sdm_meter::SDMMeter::set_import_reactive_energy_sensor ( sensor::Sensor import_reactive_energy_sensor)

Definition at line 50 of file sdm_meter.h.

◆ set_phase_angle_sensor()

void esphome::sdm_meter::SDMMeter::set_phase_angle_sensor ( uint8_t  phase,
sensor::Sensor phase_angle_sensor 

Definition at line 38 of file sdm_meter.h.

◆ set_power_factor_sensor()

void esphome::sdm_meter::SDMMeter::set_power_factor_sensor ( uint8_t  phase,
sensor::Sensor power_factor_sensor 

Definition at line 34 of file sdm_meter.h.

◆ set_reactive_power_sensor()

void esphome::sdm_meter::SDMMeter::set_reactive_power_sensor ( uint8_t  phase,
sensor::Sensor reactive_power_sensor 

Definition at line 30 of file sdm_meter.h.

◆ set_total_power_sensor()

void esphome::sdm_meter::SDMMeter::set_total_power_sensor ( sensor::Sensor total_power_sensor)

Definition at line 42 of file sdm_meter.h.

◆ set_voltage_sensor()

void esphome::sdm_meter::SDMMeter::set_voltage_sensor ( uint8_t  phase,
sensor::Sensor voltage_sensor 

Definition at line 14 of file sdm_meter.h.

◆ update()

void esphome::sdm_meter::SDMMeter::update ( )

Implements esphome::PollingComponent.

Definition at line 85 of file sdm_meter.cpp.

Field Documentation

◆ export_active_energy_sensor_

sensor::Sensor* esphome::sdm_meter::SDMMeter::export_active_energy_sensor_ {nullptr}

Definition at line 77 of file sdm_meter.h.

◆ export_reactive_energy_sensor_

sensor::Sensor* esphome::sdm_meter::SDMMeter::export_reactive_energy_sensor_ {nullptr}

Definition at line 79 of file sdm_meter.h.

◆ frequency_sensor_

sensor::Sensor* esphome::sdm_meter::SDMMeter::frequency_sensor_ {nullptr}

Definition at line 74 of file sdm_meter.h.

◆ import_active_energy_sensor_

sensor::Sensor* esphome::sdm_meter::SDMMeter::import_active_energy_sensor_ {nullptr}

Definition at line 76 of file sdm_meter.h.

◆ import_reactive_energy_sensor_

sensor::Sensor* esphome::sdm_meter::SDMMeter::import_reactive_energy_sensor_ {nullptr}

Definition at line 78 of file sdm_meter.h.

◆ phases_

struct esphome::sdm_meter::SDMMeter::SDMPhase esphome::sdm_meter::SDMMeter::phases_[3]

◆ total_power_sensor_

sensor::Sensor* esphome::sdm_meter::SDMMeter::total_power_sensor_ {nullptr}

Definition at line 75 of file sdm_meter.h.

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