ESPHome 2025.5.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::pmsx003::PMSX003Component Class Reference

#include <pmsx003.h>

Inheritance diagram for esphome::pmsx003::PMSX003Component:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

 PMSX003Component ()=default
 
float get_setup_priority () const override
 
void dump_config () override
 
void loop () override
 
void set_update_interval (uint32_t update_interval)
 
void set_type (PMSX003Type type)
 
void set_pm_1_0_std_sensor (sensor::Sensor *pm_1_0_std_sensor)
 
void set_pm_2_5_std_sensor (sensor::Sensor *pm_2_5_std_sensor)
 
void set_pm_10_0_std_sensor (sensor::Sensor *pm_10_0_std_sensor)
 
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_pm_particles_03um_sensor (sensor::Sensor *pm_particles_03um_sensor)
 
void set_pm_particles_05um_sensor (sensor::Sensor *pm_particles_05um_sensor)
 
void set_pm_particles_10um_sensor (sensor::Sensor *pm_particles_10um_sensor)
 
void set_pm_particles_25um_sensor (sensor::Sensor *pm_particles_25um_sensor)
 
void set_pm_particles_50um_sensor (sensor::Sensor *pm_particles_50um_sensor)
 
void set_pm_particles_100um_sensor (sensor::Sensor *pm_particles_100um_sensor)
 
void set_formaldehyde_sensor (sensor::Sensor *formaldehyde_sensor)
 
void set_temperature_sensor (sensor::Sensor *temperature_sensor)
 
void set_humidity_sensor (sensor::Sensor *humidity_sensor)
 
- 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.
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen.
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
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.
 
void mark_failed (const char *message)
 
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.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Protected Member Functions

optional< bool > check_byte_ ()
 
void parse_data_ ()
 
bool check_payload_length_ (uint16_t payload_length)
 
void send_command_ (PMSX0003Command cmd, uint16_t data)
 
uint16_t get_16_bit_uint_ (uint8_t start_index)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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.
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
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.
 
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.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Protected Attributes

uint8_t data_ [64]
 
uint8_t data_index_ {0}
 
uint8_t initialised_ {0}
 
uint32_t fan_on_time_ {0}
 
uint32_t last_update_ {0}
 
uint32_t last_transmission_ {0}
 
uint32_t update_interval_ {0}
 
PMSX003State state_ {PMSX003_STATE_IDLE}
 
PMSX003Type type_
 
sensor::Sensor * pm_1_0_std_sensor_ {nullptr}
 
sensor::Sensor * pm_2_5_std_sensor_ {nullptr}
 
sensor::Sensor * pm_10_0_std_sensor_ {nullptr}
 
sensor::Sensor * pm_1_0_sensor_ {nullptr}
 
sensor::Sensor * pm_2_5_sensor_ {nullptr}
 
sensor::Sensor * pm_10_0_sensor_ {nullptr}
 
sensor::Sensor * pm_particles_03um_sensor_ {nullptr}
 
sensor::Sensor * pm_particles_05um_sensor_ {nullptr}
 
sensor::Sensor * pm_particles_10um_sensor_ {nullptr}
 
sensor::Sensor * pm_particles_25um_sensor_ {nullptr}
 
sensor::Sensor * pm_particles_50um_sensor_ {nullptr}
 
sensor::Sensor * pm_particles_100um_sensor_ {nullptr}
 
sensor::Sensor * formaldehyde_sensor_ {nullptr}
 
sensor::Sensor * temperature_sensor_ {nullptr}
 
sensor::Sensor * humidity_sensor_ {nullptr}
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponent * parent_ {nullptr}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component.
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
uint32_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 
std::string error_message_ {}
 

Detailed Description

Definition at line 30 of file pmsx003.h.

Constructor & Destructor Documentation

◆ PMSX003Component()

esphome::pmsx003::PMSX003Component::PMSX003Component ( )
default

Member Function Documentation

◆ check_byte_()

optional< bool > esphome::pmsx003::PMSX003Component::check_byte_ ( )
protected

Definition at line 115 of file pmsx003.cpp.

◆ check_payload_length_()

bool esphome::pmsx003::PMSX003Component::check_payload_length_ ( uint16_t payload_length)
protected

Definition at line 165 of file pmsx003.cpp.

◆ dump_config()

void esphome::pmsx003::PMSX003Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file pmsx003.cpp.

◆ get_16_bit_uint_()

uint16_t esphome::pmsx003::PMSX003Component::get_16_bit_uint_ ( uint8_t start_index)
protected

Definition at line 317 of file pmsx003.cpp.

◆ get_setup_priority()

float esphome::pmsx003::PMSX003Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file pmsx003.h.

◆ loop()

void esphome::pmsx003::PMSX003Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 45 of file pmsx003.cpp.

◆ parse_data_()

void esphome::pmsx003::PMSX003Component::parse_data_ ( )
protected

Definition at line 206 of file pmsx003.cpp.

◆ send_command_()

void esphome::pmsx003::PMSX003Component::send_command_ ( PMSX0003Command cmd,
uint16_t data )
protected

Definition at line 182 of file pmsx003.cpp.

◆ set_formaldehyde_sensor()

void esphome::pmsx003::PMSX003Component::set_formaldehyde_sensor ( sensor::Sensor * formaldehyde_sensor)
inline

Definition at line 68 of file pmsx003.h.

◆ set_humidity_sensor()

void esphome::pmsx003::PMSX003Component::set_humidity_sensor ( sensor::Sensor * humidity_sensor)
inline

Definition at line 73 of file pmsx003.h.

◆ set_pm_10_0_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_10_0_sensor ( sensor::Sensor * pm_10_0_sensor)
inline

Definition at line 47 of file pmsx003.h.

◆ set_pm_10_0_std_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_10_0_std_sensor ( sensor::Sensor * pm_10_0_std_sensor)
inline

Definition at line 43 of file pmsx003.h.

◆ set_pm_1_0_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_1_0_sensor ( sensor::Sensor * pm_1_0_sensor)
inline

Definition at line 45 of file pmsx003.h.

◆ set_pm_1_0_std_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_1_0_std_sensor ( sensor::Sensor * pm_1_0_std_sensor)
inline

Definition at line 41 of file pmsx003.h.

◆ set_pm_2_5_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_2_5_sensor ( sensor::Sensor * pm_2_5_sensor)
inline

Definition at line 46 of file pmsx003.h.

◆ set_pm_2_5_std_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_2_5_std_sensor ( sensor::Sensor * pm_2_5_std_sensor)
inline

Definition at line 42 of file pmsx003.h.

◆ set_pm_particles_03um_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_particles_03um_sensor ( sensor::Sensor * pm_particles_03um_sensor)
inline

Definition at line 49 of file pmsx003.h.

◆ set_pm_particles_05um_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_particles_05um_sensor ( sensor::Sensor * pm_particles_05um_sensor)
inline

Definition at line 52 of file pmsx003.h.

◆ set_pm_particles_100um_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_particles_100um_sensor ( sensor::Sensor * pm_particles_100um_sensor)
inline

Definition at line 64 of file pmsx003.h.

◆ set_pm_particles_10um_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_particles_10um_sensor ( sensor::Sensor * pm_particles_10um_sensor)
inline

Definition at line 55 of file pmsx003.h.

◆ set_pm_particles_25um_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_particles_25um_sensor ( sensor::Sensor * pm_particles_25um_sensor)
inline

Definition at line 58 of file pmsx003.h.

◆ set_pm_particles_50um_sensor()

void esphome::pmsx003::PMSX003Component::set_pm_particles_50um_sensor ( sensor::Sensor * pm_particles_50um_sensor)
inline

Definition at line 61 of file pmsx003.h.

◆ set_temperature_sensor()

void esphome::pmsx003::PMSX003Component::set_temperature_sensor ( sensor::Sensor * temperature_sensor)
inline

Definition at line 72 of file pmsx003.h.

◆ set_type()

void esphome::pmsx003::PMSX003Component::set_type ( PMSX003Type type)
inline

Definition at line 39 of file pmsx003.h.

◆ set_update_interval()

void esphome::pmsx003::PMSX003Component::set_update_interval ( uint32_t update_interval)
inline

Definition at line 37 of file pmsx003.h.

Field Documentation

◆ data_

uint8_t esphome::pmsx003::PMSX003Component::data_[64]
protected

Definition at line 82 of file pmsx003.h.

◆ data_index_

uint8_t esphome::pmsx003::PMSX003Component::data_index_ {0}
protected

Definition at line 83 of file pmsx003.h.

◆ fan_on_time_

uint32_t esphome::pmsx003::PMSX003Component::fan_on_time_ {0}
protected

Definition at line 85 of file pmsx003.h.

◆ formaldehyde_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::formaldehyde_sensor_ {nullptr}
protected

Definition at line 111 of file pmsx003.h.

◆ humidity_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::humidity_sensor_ {nullptr}
protected

Definition at line 115 of file pmsx003.h.

◆ initialised_

uint8_t esphome::pmsx003::PMSX003Component::initialised_ {0}
protected

Definition at line 84 of file pmsx003.h.

◆ last_transmission_

uint32_t esphome::pmsx003::PMSX003Component::last_transmission_ {0}
protected

Definition at line 87 of file pmsx003.h.

◆ last_update_

uint32_t esphome::pmsx003::PMSX003Component::last_update_ {0}
protected

Definition at line 86 of file pmsx003.h.

◆ pm_10_0_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_10_0_sensor_ {nullptr}
protected

Definition at line 100 of file pmsx003.h.

◆ pm_10_0_std_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_10_0_std_sensor_ {nullptr}
protected

Definition at line 95 of file pmsx003.h.

◆ pm_1_0_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_1_0_sensor_ {nullptr}
protected

Definition at line 98 of file pmsx003.h.

◆ pm_1_0_std_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_1_0_std_sensor_ {nullptr}
protected

Definition at line 93 of file pmsx003.h.

◆ pm_2_5_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_2_5_sensor_ {nullptr}
protected

Definition at line 99 of file pmsx003.h.

◆ pm_2_5_std_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_2_5_std_sensor_ {nullptr}
protected

Definition at line 94 of file pmsx003.h.

◆ pm_particles_03um_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_particles_03um_sensor_ {nullptr}
protected

Definition at line 103 of file pmsx003.h.

◆ pm_particles_05um_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_particles_05um_sensor_ {nullptr}
protected

Definition at line 104 of file pmsx003.h.

◆ pm_particles_100um_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_particles_100um_sensor_ {nullptr}
protected

Definition at line 108 of file pmsx003.h.

◆ pm_particles_10um_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_particles_10um_sensor_ {nullptr}
protected

Definition at line 105 of file pmsx003.h.

◆ pm_particles_25um_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_particles_25um_sensor_ {nullptr}
protected

Definition at line 106 of file pmsx003.h.

◆ pm_particles_50um_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::pm_particles_50um_sensor_ {nullptr}
protected

Definition at line 107 of file pmsx003.h.

◆ state_

PMSX003State esphome::pmsx003::PMSX003Component::state_ {PMSX003_STATE_IDLE}
protected

Definition at line 89 of file pmsx003.h.

◆ temperature_sensor_

sensor::Sensor* esphome::pmsx003::PMSX003Component::temperature_sensor_ {nullptr}
protected

Definition at line 114 of file pmsx003.h.

◆ type_

PMSX003Type esphome::pmsx003::PMSX003Component::type_
protected

Definition at line 90 of file pmsx003.h.

◆ update_interval_

uint32_t esphome::pmsx003::PMSX003Component::update_interval_ {0}
protected

Definition at line 88 of file pmsx003.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0