ESPHome  2024.11.0
Data Structures | Public Member Functions | Protected Attributes
esphome::growatt_solar::GrowattSolar Class Reference

#include <growatt_solar.h>

Inheritance diagram for esphome::growatt_solar::GrowattSolar:
esphome::PollingComponent esphome::modbus::ModbusDevice esphome::Component

Data Structures

struct  GrowattPhase
 
struct  GrowattPV
 

Public Member Functions

void loop () override
 
void update () override
 
void on_modbus_data (const std::vector< uint8_t > &data) override
 
void dump_config () override
 
void set_protocol_version (GrowattProtocolVersion protocol_version)
 
void set_inverter_status_sensor (sensor::Sensor *sensor)
 
void set_grid_frequency_sensor (sensor::Sensor *sensor)
 
void set_grid_active_power_sensor (sensor::Sensor *sensor)
 
void set_pv_active_power_sensor (sensor::Sensor *sensor)
 
void set_today_production_sensor (sensor::Sensor *sensor)
 
void set_total_energy_production_sensor (sensor::Sensor *sensor)
 
void set_inverter_module_temp_sensor (sensor::Sensor *sensor)
 
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_voltage_sensor_pv (uint8_t pv, sensor::Sensor *voltage_sensor)
 
void set_current_sensor_pv (uint8_t pv, sensor::Sensor *current_sensor)
 
void set_active_power_sensor_pv (uint8_t pv, sensor::Sensor *active_power_sensor)
 
- 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 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

bool waiting_to_update_
 
uint32_t last_send_
 
struct esphome::growatt_solar::GrowattSolar::GrowattPhase phases_ [3]
 
struct esphome::growatt_solar::GrowattSolar::GrowattPV pvs_ [2]
 
sensor::Sensorinverter_status_ {nullptr}
 
sensor::Sensorgrid_frequency_sensor_ {nullptr}
 
sensor::Sensorgrid_active_power_sensor_ {nullptr}
 
sensor::Sensorpv_active_power_sensor_ {nullptr}
 
sensor::Sensortoday_production_ {nullptr}
 
sensor::Sensortotal_energy_production_ {nullptr}
 
sensor::Sensorinverter_module_temp_ {nullptr}
 
GrowattProtocolVersion protocol_version_
 
- 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(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 20 of file growatt_solar.h.

Member Function Documentation

◆ dump_config()

void esphome::growatt_solar::GrowattSolar::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 135 of file growatt_solar.cpp.

◆ loop()

void esphome::growatt_solar::GrowattSolar::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file growatt_solar.cpp.

◆ on_modbus_data()

void esphome::growatt_solar::GrowattSolar::on_modbus_data ( const std::vector< uint8_t > &  data)
overridevirtual

Implements esphome::modbus::ModbusDevice.

Definition at line 37 of file growatt_solar.cpp.

◆ set_active_power_sensor()

void esphome::growatt_solar::GrowattSolar::set_active_power_sensor ( uint8_t  phase,
sensor::Sensor active_power_sensor 
)
inline

Definition at line 45 of file growatt_solar.h.

◆ set_active_power_sensor_pv()

void esphome::growatt_solar::GrowattSolar::set_active_power_sensor_pv ( uint8_t  pv,
sensor::Sensor active_power_sensor 
)
inline

Definition at line 54 of file growatt_solar.h.

◆ set_current_sensor()

void esphome::growatt_solar::GrowattSolar::set_current_sensor ( uint8_t  phase,
sensor::Sensor current_sensor 
)
inline

Definition at line 42 of file growatt_solar.h.

◆ set_current_sensor_pv()

void esphome::growatt_solar::GrowattSolar::set_current_sensor_pv ( uint8_t  pv,
sensor::Sensor current_sensor 
)
inline

Definition at line 51 of file growatt_solar.h.

◆ set_grid_active_power_sensor()

void esphome::growatt_solar::GrowattSolar::set_grid_active_power_sensor ( sensor::Sensor sensor)
inline

Definition at line 32 of file growatt_solar.h.

◆ set_grid_frequency_sensor()

void esphome::growatt_solar::GrowattSolar::set_grid_frequency_sensor ( sensor::Sensor sensor)
inline

Definition at line 31 of file growatt_solar.h.

◆ set_inverter_module_temp_sensor()

void esphome::growatt_solar::GrowattSolar::set_inverter_module_temp_sensor ( sensor::Sensor sensor)
inline

Definition at line 37 of file growatt_solar.h.

◆ set_inverter_status_sensor()

void esphome::growatt_solar::GrowattSolar::set_inverter_status_sensor ( sensor::Sensor sensor)
inline

Definition at line 29 of file growatt_solar.h.

◆ set_protocol_version()

void esphome::growatt_solar::GrowattSolar::set_protocol_version ( GrowattProtocolVersion  protocol_version)
inline

Definition at line 27 of file growatt_solar.h.

◆ set_pv_active_power_sensor()

void esphome::growatt_solar::GrowattSolar::set_pv_active_power_sensor ( sensor::Sensor sensor)
inline

Definition at line 33 of file growatt_solar.h.

◆ set_today_production_sensor()

void esphome::growatt_solar::GrowattSolar::set_today_production_sensor ( sensor::Sensor sensor)
inline

Definition at line 35 of file growatt_solar.h.

◆ set_total_energy_production_sensor()

void esphome::growatt_solar::GrowattSolar::set_total_energy_production_sensor ( sensor::Sensor sensor)
inline

Definition at line 36 of file growatt_solar.h.

◆ set_voltage_sensor()

void esphome::growatt_solar::GrowattSolar::set_voltage_sensor ( uint8_t  phase,
sensor::Sensor voltage_sensor 
)
inline

Definition at line 39 of file growatt_solar.h.

◆ set_voltage_sensor_pv()

void esphome::growatt_solar::GrowattSolar::set_voltage_sensor_pv ( uint8_t  pv,
sensor::Sensor voltage_sensor 
)
inline

Definition at line 48 of file growatt_solar.h.

◆ update()

void esphome::growatt_solar::GrowattSolar::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 19 of file growatt_solar.cpp.

Field Documentation

◆ grid_active_power_sensor_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::grid_active_power_sensor_ {nullptr}
protected

Definition at line 76 of file growatt_solar.h.

◆ grid_frequency_sensor_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::grid_frequency_sensor_ {nullptr}
protected

Definition at line 75 of file growatt_solar.h.

◆ inverter_module_temp_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::inverter_module_temp_ {nullptr}
protected

Definition at line 82 of file growatt_solar.h.

◆ inverter_status_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::inverter_status_ {nullptr}
protected

Definition at line 73 of file growatt_solar.h.

◆ last_send_

uint32_t esphome::growatt_solar::GrowattSolar::last_send_
protected

Definition at line 60 of file growatt_solar.h.

◆ phases_

struct esphome::growatt_solar::GrowattSolar::GrowattPhase esphome::growatt_solar::GrowattSolar::phases_[3]
protected

◆ protocol_version_

GrowattProtocolVersion esphome::growatt_solar::GrowattSolar::protocol_version_
protected

Definition at line 83 of file growatt_solar.h.

◆ pv_active_power_sensor_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::pv_active_power_sensor_ {nullptr}
protected

Definition at line 78 of file growatt_solar.h.

◆ pvs_

struct esphome::growatt_solar::GrowattSolar::GrowattPV esphome::growatt_solar::GrowattSolar::pvs_[2]
protected

◆ today_production_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::today_production_ {nullptr}
protected

Definition at line 80 of file growatt_solar.h.

◆ total_energy_production_

sensor::Sensor* esphome::growatt_solar::GrowattSolar::total_energy_production_ {nullptr}
protected

Definition at line 81 of file growatt_solar.h.

◆ waiting_to_update_

bool esphome::growatt_solar::GrowattSolar::waiting_to_update_
protected

Definition at line 59 of file growatt_solar.h.


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