ESPHome  2022.6.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::pm1006::PM1006Component Class Reference

#include <pm1006.h>

Inheritance diagram for esphome::pm1006::PM1006Component:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

 PM1006Component ()=default
 
void set_pm_2_5_sensor (sensor::Sensor *pm_2_5_sensor)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
void update () override
 
float get_setup_priority () const 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
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 Member Functions

optional< bool > check_byte_ () const
 
void parse_data_ ()
 
uint16_t get_16_bit_uint_ (uint8_t start_index) const
 
uint8_t pm1006_checksum_ (const uint8_t *command_data, uint8_t length) const
 
- 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::Sensorpm_2_5_sensor_ {nullptr}
 
uint8_t data_ [20]
 
uint8_t data_index_ {0}
 
uint32_t last_transmission_ {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 pm1006.h.

Constructor & Destructor Documentation

◆ PM1006Component()

esphome::pm1006::PM1006Component::PM1006Component ( )
default

Member Function Documentation

◆ check_byte_()

optional< bool > esphome::pm1006::PM1006Component::check_byte_ ( ) const
protected

Definition at line 57 of file pm1006.cpp.

◆ dump_config()

void esphome::pm1006::PM1006Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 16 of file pm1006.cpp.

◆ get_16_bit_uint_()

uint16_t esphome::pm1006::PM1006Component::get_16_bit_uint_ ( uint8_t  start_index) const
protected

Definition at line 98 of file pm1006.cpp.

◆ get_setup_priority()

float esphome::pm1006::PM1006Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file pm1006.cpp.

◆ loop()

void esphome::pm1006::PM1006Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file pm1006.cpp.

◆ parse_data_()

void esphome::pm1006::PM1006Component::parse_data_ ( )
protected

Definition at line 88 of file pm1006.cpp.

◆ pm1006_checksum_()

uint8_t esphome::pm1006::PM1006Component::pm1006_checksum_ ( const uint8_t *  command_data,
uint8_t  length 
) const
protected

Definition at line 49 of file pm1006.cpp.

◆ set_pm_2_5_sensor()

void esphome::pm1006::PM1006Component::set_pm_2_5_sensor ( sensor::Sensor pm_2_5_sensor)
inline

Definition at line 14 of file pm1006.h.

◆ setup()

void esphome::pm1006::PM1006Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file pm1006.cpp.

◆ update()

void esphome::pm1006::PM1006Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 23 of file pm1006.cpp.

Field Documentation

◆ data_

uint8_t esphome::pm1006::PM1006Component::data_[20]
protected

Definition at line 30 of file pm1006.h.

◆ data_index_

uint8_t esphome::pm1006::PM1006Component::data_index_ {0}
protected

Definition at line 31 of file pm1006.h.

◆ last_transmission_

uint32_t esphome::pm1006::PM1006Component::last_transmission_ {0}
protected

Definition at line 32 of file pm1006.h.

◆ pm_2_5_sensor_

sensor::Sensor* esphome::pm1006::PM1006Component::pm_2_5_sensor_ {nullptr}
protected

Definition at line 28 of file pm1006.h.


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