ESPHome  2024.7.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::senseair::SenseAirComponent Class Reference

#include <senseair.h>

Inheritance diagram for esphome::senseair::SenseAirComponent:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

float get_setup_priority () const override
void set_co2_sensor (sensor::Sensor *co2_sensor)
void update () override
void dump_config () override
void background_calibration ()
void background_calibration_result ()
void abc_get_period ()
void abc_enable ()
void abc_disable ()
- 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 setup ()
 Where the component's initialization should happen. More...
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 () 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. 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 senseair_write_command_ (const uint8_t *command, uint8_t *response, uint8_t response_length)
- 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::Sensorco2_sensor_ {nullptr}
- 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 11 of file senseair.h.

Member Function Documentation

◆ abc_disable()

void esphome::senseair::SenseAirComponent::abc_disable ( )

Definition at line 101 of file senseair.cpp.

◆ abc_enable()

void esphome::senseair::SenseAirComponent::abc_enable ( )

Definition at line 93 of file senseair.cpp.

◆ abc_get_period()

void esphome::senseair::SenseAirComponent::abc_get_period ( )

Definition at line 109 of file senseair.cpp.

◆ background_calibration()

void esphome::senseair::SenseAirComponent::background_calibration ( )

Definition at line 64 of file senseair.cpp.

◆ background_calibration_result()

void esphome::senseair::SenseAirComponent::background_calibration_result ( )

Definition at line 73 of file senseair.cpp.

◆ dump_config()

void esphome::senseair::SenseAirComponent::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 143 of file senseair.cpp.

◆ get_setup_priority()

float esphome::senseair::SenseAirComponent::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 13 of file senseair.h.

◆ senseair_write_command_()

bool esphome::senseair::SenseAirComponent::senseair_write_command_ ( const uint8_t *  command,
uint8_t *  response,
uint8_t  response_length 

Definition at line 127 of file senseair.cpp.

◆ set_co2_sensor()

void esphome::senseair::SenseAirComponent::set_co2_sensor ( sensor::Sensor co2_sensor)

Definition at line 14 of file senseair.h.

◆ update()

void esphome::senseair::SenseAirComponent::update ( )

Implements esphome::PollingComponent.

Definition at line 21 of file senseair.cpp.

Field Documentation

◆ co2_sensor_

sensor::Sensor* esphome::senseair::SenseAirComponent::co2_sensor_ {nullptr}

Definition at line 28 of file senseair.h.

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