ESPHome  2022.11.3
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::hm3301::HM3301Component Class Reference

#include <hm3301.h>

Inheritance diagram for esphome::hm3301::HM3301Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

 HM3301Component ()=default
 
void set_pm_1_0_sensor (sensor::Sensor *pm_1_0_sensor)
 
void set_pm_2_5_sensor (sensor::Sensor *pm_2_5_sensor)
 
void set_pm_10_0_sensor (sensor::Sensor *pm_10_0_sensor)
 
void set_aqi_sensor (sensor::Sensor *aqi_sensor)
 
void set_aqi_calculation_type (AQICalculatorType aqi_calc_type)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () 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 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 ()
 
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::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Types

enum  { NO_ERROR = 0, ERROR_PARAM = -1, ERROR_COMM = -2, ERROR_OTHERS = -128 }
 

Protected Member Functions

bool validate_checksum_ (const uint8_t *data)
 
uint16_t get_sensor_value_ (const uint8_t *data, uint8_t i)
 
- 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

enum esphome::hm3301::HM3301Component:: { ... }  NO_ERROR
 
uint8_t data_buffer_ [30]
 
sensor::Sensorpm_1_0_sensor_ {nullptr}
 
sensor::Sensorpm_2_5_sensor_ {nullptr}
 
sensor::Sensorpm_10_0_sensor_ {nullptr}
 
sensor::Sensoraqi_sensor_ {nullptr}
 
AQICalculatorType aqi_calc_type_
 
AQICalculatorFactory aqi_calculator_factory_ = AQICalculatorFactory()
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 13 of file hm3301.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
NO_ERROR 
ERROR_PARAM 
ERROR_COMM 
ERROR_OTHERS 

Definition at line 30 of file hm3301.h.

Constructor & Destructor Documentation

◆ HM3301Component()

esphome::hm3301::HM3301Component::HM3301Component ( )
default

Member Function Documentation

◆ dump_config()

void esphome::hm3301::HM3301Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 22 of file hm3301.cpp.

◆ get_sensor_value_()

uint16_t esphome::hm3301::HM3301Component::get_sensor_value_ ( const uint8_t *  data,
uint8_t  i 
)
protected

Definition at line 96 of file hm3301.cpp.

◆ get_setup_priority()

float esphome::hm3301::HM3301Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 35 of file hm3301.cpp.

◆ set_aqi_calculation_type()

void esphome::hm3301::HM3301Component::set_aqi_calculation_type ( AQICalculatorType  aqi_calc_type)
inline

Definition at line 22 of file hm3301.h.

◆ set_aqi_sensor()

void esphome::hm3301::HM3301Component::set_aqi_sensor ( sensor::Sensor aqi_sensor)
inline

Definition at line 20 of file hm3301.h.

◆ set_pm_10_0_sensor()

void esphome::hm3301::HM3301Component::set_pm_10_0_sensor ( sensor::Sensor pm_10_0_sensor)
inline

Definition at line 19 of file hm3301.h.

◆ set_pm_1_0_sensor()

void esphome::hm3301::HM3301Component::set_pm_1_0_sensor ( sensor::Sensor pm_1_0_sensor)
inline

Definition at line 17 of file hm3301.h.

◆ set_pm_2_5_sensor()

void esphome::hm3301::HM3301Component::set_pm_2_5_sensor ( sensor::Sensor pm_2_5_sensor)
inline

Definition at line 18 of file hm3301.h.

◆ setup()

void esphome::hm3301::HM3301Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file hm3301.cpp.

◆ update()

void esphome::hm3301::HM3301Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 37 of file hm3301.cpp.

◆ validate_checksum_()

bool esphome::hm3301::HM3301Component::validate_checksum_ ( const uint8_t *  data)
protected

Definition at line 87 of file hm3301.cpp.

Field Documentation

◆ aqi_calc_type_

AQICalculatorType esphome::hm3301::HM3301Component::aqi_calc_type_
protected

Definition at line 44 of file hm3301.h.

◆ aqi_calculator_factory_

AQICalculatorFactory esphome::hm3301::HM3301Component::aqi_calculator_factory_ = AQICalculatorFactory()
protected

Definition at line 45 of file hm3301.h.

◆ aqi_sensor_

sensor::Sensor* esphome::hm3301::HM3301Component::aqi_sensor_ {nullptr}
protected

Definition at line 42 of file hm3301.h.

◆ data_buffer_

uint8_t esphome::hm3301::HM3301Component::data_buffer_[30]
protected

Definition at line 37 of file hm3301.h.

◆ NO_ERROR

enum { ... } esphome::hm3301::HM3301Component::NO_ERROR

◆ pm_10_0_sensor_

sensor::Sensor* esphome::hm3301::HM3301Component::pm_10_0_sensor_ {nullptr}
protected

Definition at line 41 of file hm3301.h.

◆ pm_1_0_sensor_

sensor::Sensor* esphome::hm3301::HM3301Component::pm_1_0_sensor_ {nullptr}
protected

Definition at line 39 of file hm3301.h.

◆ pm_2_5_sensor_

sensor::Sensor* esphome::hm3301::HM3301Component::pm_2_5_sensor_ {nullptr}
protected

Definition at line 40 of file hm3301.h.


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