ESPHome  2024.3.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mhz19::MHZ19Component Class Reference

#include <mhz19.h>

Inheritance diagram for esphome::mhz19::MHZ19Component:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

float get_setup_priority () const override
 
void setup () override
 
void update () override
 
void dump_config () override
 
void calibrate_zero ()
 
void abc_enable ()
 
void abc_disable ()
 
void set_temperature_sensor (sensor::Sensor *temperature_sensor)
 
void set_co2_sensor (sensor::Sensor *co2_sensor)
 
void set_abc_enabled (bool abc_enabled)
 
void set_warmup_seconds (uint32_t seconds)
 
- 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 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 ()
 
bool is_ready ()
 
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::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

bool mhz19_write_command_ (const uint8_t *command, uint8_t *response)
 
- 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...
 

Protected Attributes

sensor::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorco2_sensor_ {nullptr}
 
MHZ19ABCLogic abc_boot_logic_ {MHZ19_ABC_NONE}
 
uint32_t warmup_seconds_
 
- 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 13 of file mhz19.h.

Member Function Documentation

◆ abc_disable()

void esphome::mhz19::MHZ19Component::abc_disable ( )

Definition at line 82 of file mhz19.cpp.

◆ abc_enable()

void esphome::mhz19::MHZ19Component::abc_enable ( )

Definition at line 77 of file mhz19.cpp.

◆ calibrate_zero()

void esphome::mhz19::MHZ19Component::calibrate_zero ( )

Definition at line 72 of file mhz19.cpp.

◆ dump_config()

void esphome::mhz19::MHZ19Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 101 of file mhz19.cpp.

◆ get_setup_priority()

float esphome::mhz19::MHZ19Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 100 of file mhz19.cpp.

◆ mhz19_write_command_()

bool esphome::mhz19::MHZ19Component::mhz19_write_command_ ( const uint8_t *  command,
uint8_t *  response 
)
protected

Definition at line 87 of file mhz19.cpp.

◆ set_abc_enabled()

void esphome::mhz19::MHZ19Component::set_abc_enabled ( bool  abc_enabled)
inline

Definition at line 27 of file mhz19.h.

◆ set_co2_sensor()

void esphome::mhz19::MHZ19Component::set_co2_sensor ( sensor::Sensor co2_sensor)
inline

Definition at line 26 of file mhz19.h.

◆ set_temperature_sensor()

void esphome::mhz19::MHZ19Component::set_temperature_sensor ( sensor::Sensor temperature_sensor)
inline

Definition at line 25 of file mhz19.h.

◆ set_warmup_seconds()

void esphome::mhz19::MHZ19Component::set_warmup_seconds ( uint32_t  seconds)
inline

Definition at line 28 of file mhz19.h.

◆ setup()

void esphome::mhz19::MHZ19Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file mhz19.cpp.

◆ update()

void esphome::mhz19::MHZ19Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 31 of file mhz19.cpp.

Field Documentation

◆ abc_boot_logic_

MHZ19ABCLogic esphome::mhz19::MHZ19Component::abc_boot_logic_ {MHZ19_ABC_NONE}
protected

Definition at line 35 of file mhz19.h.

◆ co2_sensor_

sensor::Sensor* esphome::mhz19::MHZ19Component::co2_sensor_ {nullptr}
protected

Definition at line 34 of file mhz19.h.

◆ temperature_sensor_

sensor::Sensor* esphome::mhz19::MHZ19Component::temperature_sensor_ {nullptr}
protected

Definition at line 33 of file mhz19.h.

◆ warmup_seconds_

uint32_t esphome::mhz19::MHZ19Component::warmup_seconds_
protected

Definition at line 36 of file mhz19.h.


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