ESPHome  2024.2.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sds011::SDS011Component Class Reference

#include <sds011.h>

Inheritance diagram for esphome::sds011::SDS011Component:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

 SDS011Component ()=default
void set_rx_mode_only (bool rx_mode_only)
 Manually set the rx-only mode. Defaults to false. More...
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 setup () override
void dump_config () override
void loop () override
float get_setup_priority () const override
void set_update_interval (uint32_t val)
void set_update_interval_min (uint8_t update_interval_min)
void set_working_state (bool working_state)
- 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 ()
bool is_ready ()
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

void sds011_write_command_ (const uint8_t *command)
uint8_t sds011_checksum_ (const uint8_t *command_data, uint8_t length) const
optional< bool > check_byte_ () const
void parse_data_ ()
uint16_t get_16_bit_uint_ (uint8_t start_index) const
- 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. 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...

Protected Attributes

sensor::Sensorpm_2_5_sensor_ {nullptr}
sensor::Sensorpm_10_0_sensor_ {nullptr}
uint8_t data_ [10]
uint8_t data_index_ {0}
uint32_t last_transmission_ {0}
uint8_t update_interval_min_
bool rx_mode_only_
- 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 sds011.h.

Constructor & Destructor Documentation

◆ SDS011Component()

esphome::sds011::SDS011Component::SDS011Component ( )

Member Function Documentation

◆ check_byte_()

optional< bool > esphome::sds011::SDS011Component::check_byte_ ( ) const

Definition at line 128 of file sds011.cpp.

◆ dump_config()

void esphome::sds011::SDS011Component::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 68 of file sds011.cpp.

◆ get_16_bit_uint_()

uint16_t esphome::sds011::SDS011Component::get_16_bit_uint_ ( uint8_t  start_index) const

Definition at line 182 of file sds011.cpp.

◆ get_setup_priority()

float esphome::sds011::SDS011Component::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 108 of file sds011.cpp.

◆ loop()

void esphome::sds011::SDS011Component::loop ( )

Reimplemented from esphome::Component.

Definition at line 77 of file sds011.cpp.

◆ parse_data_()

void esphome::sds011::SDS011Component::parse_data_ ( )

Definition at line 163 of file sds011.cpp.

◆ sds011_checksum_()

uint8_t esphome::sds011::SDS011Component::sds011_checksum_ ( const uint8_t *  command_data,
uint8_t  length 
) const

Definition at line 120 of file sds011.cpp.

◆ sds011_write_command_()

void esphome::sds011::SDS011Component::sds011_write_command_ ( const uint8_t *  command)

Definition at line 112 of file sds011.cpp.

◆ set_pm_10_0_sensor()

void esphome::sds011::SDS011Component::set_pm_10_0_sensor ( sensor::Sensor pm_10_0_sensor)

Definition at line 18 of file sds011.h.

◆ set_pm_2_5_sensor()

void esphome::sds011::SDS011Component::set_pm_2_5_sensor ( sensor::Sensor pm_2_5_sensor)

Definition at line 17 of file sds011.h.

◆ set_rx_mode_only()

void esphome::sds011::SDS011Component::set_rx_mode_only ( bool  rx_mode_only)

Manually set the rx-only mode. Defaults to false.

Definition at line 110 of file sds011.cpp.

◆ set_update_interval()

void esphome::sds011::SDS011Component::set_update_interval ( uint32_t  val)

Definition at line 25 of file sds011.h.

◆ set_update_interval_min()

void esphome::sds011::SDS011Component::set_update_interval_min ( uint8_t  update_interval_min)

Definition at line 185 of file sds011.cpp.

◆ set_working_state()

void esphome::sds011::SDS011Component::set_working_state ( bool  working_state)

Definition at line 53 of file sds011.cpp.

◆ setup()

void esphome::sds011::SDS011Component::setup ( )

Reimplemented from esphome::Component.

Definition at line 31 of file sds011.cpp.

Field Documentation

◆ data_

uint8_t esphome::sds011::SDS011Component::data_[10]

Definition at line 40 of file sds011.h.

◆ data_index_

uint8_t esphome::sds011::SDS011Component::data_index_ {0}

Definition at line 41 of file sds011.h.

◆ last_transmission_

uint32_t esphome::sds011::SDS011Component::last_transmission_ {0}

Definition at line 42 of file sds011.h.

◆ pm_10_0_sensor_

sensor::Sensor* esphome::sds011::SDS011Component::pm_10_0_sensor_ {nullptr}

Definition at line 38 of file sds011.h.

◆ pm_2_5_sensor_

sensor::Sensor* esphome::sds011::SDS011Component::pm_2_5_sensor_ {nullptr}

Definition at line 37 of file sds011.h.

◆ rx_mode_only_

bool esphome::sds011::SDS011Component::rx_mode_only_

Definition at line 45 of file sds011.h.

◆ update_interval_min_

uint8_t esphome::sds011::SDS011Component::update_interval_min_

Definition at line 43 of file sds011.h.

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