ESPHome  2022.11.3
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::ccs811::CCS811Component Class Reference

#include <ccs811.h>

Inheritance diagram for esphome::ccs811::CCS811Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

void set_co2 (sensor::Sensor *co2)
 
void set_tvoc (sensor::Sensor *tvoc)
 
void set_version (text_sensor::TextSensor *version)
 
void set_baseline (uint16_t baseline)
 
void set_humidity (sensor::Sensor *humidity)
 
void set_temperature (sensor::Sensor *temperature)
 
void setup () override
 Setup the sensor and test for a connection. More...
 
void update () override
 Schedule temperature+pressure readings. More...
 
void dump_config () 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
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 ()
 
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::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Types

enum  ErrorCode {
  UNKNOWN, COMMUNICATION_FAILED, INVALID_ID, SENSOR_REPORTED_ERROR,
  APP_INVALID, APP_START_FAILED
}
 

Protected Member Functions

optional< uint8_t > read_status_ ()
 
bool status_has_error_ ()
 
bool status_app_is_valid_ ()
 
bool status_has_data_ ()
 
void send_env_data_ ()
 
- 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

enum esphome::ccs811::CCS811Component::ErrorCode UNKNOWN
 
sensor::Sensorco2_ {nullptr}
 
sensor::Sensortvoc_ {nullptr}
 
text_sensor::TextSensorversion_ {nullptr}
 
optional< uint16_t > baseline_ {}
 
sensor::Sensorhumidity_ {nullptr}
 Input sensor for humidity reading. More...
 
sensor::Sensortemperature_ {nullptr}
 Input sensor for temperature reading. More...
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 12 of file ccs811.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
UNKNOWN 
COMMUNICATION_FAILED 
INVALID_ID 
SENSOR_REPORTED_ERROR 
APP_INVALID 
APP_START_FAILED 

Definition at line 37 of file ccs811.h.

Member Function Documentation

◆ dump_config()

void esphome::ccs811::CCS811Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 151 of file ccs811.cpp.

◆ get_setup_priority()

float esphome::ccs811::CCS811Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file ccs811.h.

◆ read_status_()

optional<uint8_t> esphome::ccs811::CCS811Component::read_status_ ( )
inlineprotected

Definition at line 31 of file ccs811.h.

◆ send_env_data_()

void esphome::ccs811::CCS811Component::send_env_data_ ( )
protected

Definition at line 125 of file ccs811.cpp.

◆ set_baseline()

void esphome::ccs811::CCS811Component::set_baseline ( uint16_t  baseline)
inline

Definition at line 17 of file ccs811.h.

◆ set_co2()

void esphome::ccs811::CCS811Component::set_co2 ( sensor::Sensor co2)
inline

Definition at line 14 of file ccs811.h.

◆ set_humidity()

void esphome::ccs811::CCS811Component::set_humidity ( sensor::Sensor humidity)
inline

Definition at line 18 of file ccs811.h.

◆ set_temperature()

void esphome::ccs811::CCS811Component::set_temperature ( sensor::Sensor temperature)
inline

Definition at line 19 of file ccs811.h.

◆ set_tvoc()

void esphome::ccs811::CCS811Component::set_tvoc ( sensor::Sensor tvoc)
inline

Definition at line 15 of file ccs811.h.

◆ set_version()

void esphome::ccs811::CCS811Component::set_version ( text_sensor::TextSensor version)
inline

Definition at line 16 of file ccs811.h.

◆ setup()

void esphome::ccs811::CCS811Component::setup ( )
overridevirtual

Setup the sensor and test for a connection.

Reimplemented from esphome::Component.

Definition at line 22 of file ccs811.cpp.

◆ status_app_is_valid_()

bool esphome::ccs811::CCS811Component::status_app_is_valid_ ( )
inlineprotected

Definition at line 33 of file ccs811.h.

◆ status_has_data_()

bool esphome::ccs811::CCS811Component::status_has_data_ ( )
inlineprotected

Definition at line 34 of file ccs811.h.

◆ status_has_error_()

bool esphome::ccs811::CCS811Component::status_has_error_ ( )
inlineprotected

Definition at line 32 of file ccs811.h.

◆ update()

void esphome::ccs811::CCS811Component::update ( )
overridevirtual

Schedule temperature+pressure readings.

Implements esphome::PollingComponent.

Definition at line 89 of file ccs811.cpp.

Field Documentation

◆ baseline_

optional<uint16_t> esphome::ccs811::CCS811Component::baseline_ {}
protected

Definition at line 49 of file ccs811.h.

◆ co2_

sensor::Sensor* esphome::ccs811::CCS811Component::co2_ {nullptr}
protected

Definition at line 46 of file ccs811.h.

◆ humidity_

sensor::Sensor* esphome::ccs811::CCS811Component::humidity_ {nullptr}
protected

Input sensor for humidity reading.

Definition at line 51 of file ccs811.h.

◆ temperature_

sensor::Sensor* esphome::ccs811::CCS811Component::temperature_ {nullptr}
protected

Input sensor for temperature reading.

Definition at line 53 of file ccs811.h.

◆ tvoc_

sensor::Sensor* esphome::ccs811::CCS811Component::tvoc_ {nullptr}
protected

Definition at line 47 of file ccs811.h.

◆ UNKNOWN

enum esphome::ccs811::CCS811Component::ErrorCode esphome::ccs811::CCS811Component::UNKNOWN
protected

◆ version_

text_sensor::TextSensor* esphome::ccs811::CCS811Component::version_ {nullptr}
protected

Definition at line 48 of file ccs811.h.


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