ESPHome  2024.5.3
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::ags10::AGS10Component Class Reference

#include <ags10.h>

Inheritance diagram for esphome::ags10::AGS10Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

void set_tvoc (sensor::Sensor *tvoc)
 Sets TVOC sensor. More...
 
void set_version (sensor::Sensor *version)
 Sets version info sensor. More...
 
void set_resistance (sensor::Sensor *resistance)
 Sets resistance info sensor. More...
 
void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
bool new_i2c_address (uint8_t newaddress)
 Modifies target address of AGS10. More...
 
bool set_zero_point_with_factory_defaults ()
 Sets zero-point with factory defaults. More...
 
bool set_zero_point_with_current_resistance ()
 Sets zero-point with current sensor resistance. More...
 
bool set_zero_point_with (uint16_t value)
 Sets zero-point with the value. More...
 
- 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::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
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 {
  NONE = 0, COMMUNICATION_FAILED, CRC_CHECK_FAILED, ILLEGAL_STATUS,
  UNSUPPORTED_UNITS
}
 Last operation error code. More...
 

Protected Member Functions

optional< uint32_t > read_tvoc_ ()
 Reads and returns value of TVOC. More...
 
optional< uint8_t > read_version_ ()
 Reads and returns a firmware version of AGS10. More...
 
optional< uint32_t > read_resistance_ ()
 Reads and returns the resistance of AGS10. More...
 
template<size_t N>
optional< std::array< uint8_t, N > > read_and_check_ (uint8_t a_register)
 Read, checks and returns data from the sensor. More...
 
template<size_t N>
uint8_t calc_crc8_ (std::array< uint8_t, N > dat, uint8_t num)
 Calculates CRC8 value. More...
 
- 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::Sensortvoc_ {nullptr}
 TVOC. More...
 
sensor::Sensorversion_ {nullptr}
 Firmvare version. More...
 
sensor::Sensorresistance_ {nullptr}
 Resistance. More...
 
enum esphome::ags10::AGS10Component::ErrorCode NONE
 
- 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}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Detailed Description

Definition at line 11 of file ags10.h.

Member Enumeration Documentation

◆ ErrorCode

Last operation error code.

Enumerator
NONE 
COMMUNICATION_FAILED 
CRC_CHECK_FAILED 
ILLEGAL_STATUS 
UNSUPPORTED_UNITS 

Definition at line 77 of file ags10.h.

Member Function Documentation

◆ calc_crc8_()

template<size_t N>
uint8_t esphome::ags10::AGS10Component::calc_crc8_ ( std::array< uint8_t, N >  dat,
uint8_t  num 
)
protected

Calculates CRC8 value.

CRC8 calculation, initial value: 0xFF, polynomial: 0x31 (x8+ x5+ x4+1)

Parameters
[in]datthe data buffer
numnumber of bytes in the buffer

Definition at line 197 of file ags10.cpp.

◆ dump_config()

void esphome::ags10::AGS10Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 59 of file ags10.cpp.

◆ get_setup_priority()

float esphome::ags10::AGS10Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 34 of file ags10.h.

◆ new_i2c_address()

bool esphome::ags10::AGS10Component::new_i2c_address ( uint8_t  newaddress)

Modifies target address of AGS10.

Sets new I2C address of AGS10.

New address is saved and takes effect immediately even after power-off.

Definition at line 90 of file ags10.cpp.

◆ read_and_check_()

template<size_t N>
optional< std::array< uint8_t, N > > esphome::ags10::AGS10Component::read_and_check_ ( uint8_t  a_register)
protected

Read, checks and returns data from the sensor.

Definition at line 177 of file ags10.cpp.

◆ read_resistance_()

optional< uint32_t > esphome::ags10::AGS10Component::read_resistance_ ( )
protected

Reads and returns the resistance of AGS10.

Definition at line 168 of file ags10.cpp.

◆ read_tvoc_()

optional< uint32_t > esphome::ags10::AGS10Component::read_tvoc_ ( )
protected

Reads and returns value of TVOC.

Definition at line 132 of file ags10.cpp.

◆ read_version_()

optional< uint8_t > esphome::ags10::AGS10Component::read_version_ ( )
protected

Reads and returns a firmware version of AGS10.

Definition at line 159 of file ags10.cpp.

◆ set_resistance()

void esphome::ags10::AGS10Component::set_resistance ( sensor::Sensor resistance)
inline

Sets resistance info sensor.

Definition at line 26 of file ags10.h.

◆ set_tvoc()

void esphome::ags10::AGS10Component::set_tvoc ( sensor::Sensor tvoc)
inline

Sets TVOC sensor.

Definition at line 16 of file ags10.h.

◆ set_version()

void esphome::ags10::AGS10Component::set_version ( sensor::Sensor version)
inline

Sets version info sensor.

Definition at line 21 of file ags10.h.

◆ set_zero_point_with()

bool esphome::ags10::AGS10Component::set_zero_point_with ( uint16_t  value)

Sets zero-point with the value.

Definition at line 111 of file ags10.cpp.

◆ set_zero_point_with_current_resistance()

bool esphome::ags10::AGS10Component::set_zero_point_with_current_resistance ( )

Sets zero-point with current sensor resistance.

Definition at line 109 of file ags10.cpp.

◆ set_zero_point_with_factory_defaults()

bool esphome::ags10::AGS10Component::set_zero_point_with_factory_defaults ( )

Sets zero-point with factory defaults.

Definition at line 107 of file ags10.cpp.

◆ setup()

void esphome::ags10::AGS10Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file ags10.cpp.

◆ update()

void esphome::ags10::AGS10Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 49 of file ags10.cpp.

Field Documentation

◆ NONE

enum esphome::ags10::AGS10Component::ErrorCode esphome::ags10::AGS10Component::NONE
protected

◆ resistance_

sensor::Sensor* esphome::ags10::AGS10Component::resistance_ {nullptr}
protected

Resistance.

Definition at line 72 of file ags10.h.

◆ tvoc_

sensor::Sensor* esphome::ags10::AGS10Component::tvoc_ {nullptr}
protected

TVOC.

Definition at line 62 of file ags10.h.

◆ version_

sensor::Sensor* esphome::ags10::AGS10Component::version_ {nullptr}
protected

Firmvare version.

Definition at line 67 of file ags10.h.


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