ESPHome  2022.1.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ltr390::LTR390Component Class Reference

#include <ltr390.h>

Inheritance diagram for esphome::ltr390::LTR390Component:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Public Member Functions

float get_setup_priority () const override
 
void setup () override
 
void dump_config () override
 
void update () override
 
void set_gain_value (LTR390GAIN gain)
 
void set_res_value (LTR390RESOLUTION res)
 
void set_wfac_value (float wfac)
 
void set_light_sensor (sensor::Sensor *light_sensor)
 
void set_als_sensor (sensor::Sensor *als_sensor)
 
void set_uvi_sensor (sensor::Sensor *uvi_sensor)
 
void set_uv_sensor (sensor::Sensor *uv_sensor)
 
- 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)
 
ErrorCode write (const uint8_t *data, uint8_t len)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len)
 
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)
 
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 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 write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

optional< uint32_t > read_sensor_data_ (LTR390MODE mode)
 
void read_als_ ()
 
void read_uvs_ ()
 
void read_mode_ (int mode_index)
 
- 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

bool reading_
 
std::vector< std::tuple< LTR390MODE, std::function< void()> > > mode_funcs_
 
LTR390GAIN gain_
 
LTR390RESOLUTION res_
 
float wfac_
 
sensor::Sensorlight_sensor_ {nullptr}
 
sensor::Sensorals_sensor_ {nullptr}
 
sensor::Sensoruvi_sensor_ {nullptr}
 
sensor::Sensoruv_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::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 52 of file ltr390.h.

Member Function Documentation

◆ dump_config()

void esphome::ltr390::LTR390Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 156 of file ltr390.cpp.

◆ get_setup_priority()

float esphome::ltr390::LTR390Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 54 of file ltr390.h.

◆ read_als_()

void esphome::ltr390::LTR390Component::read_als_ ( )
protected

Definition at line 54 of file ltr390.cpp.

◆ read_mode_()

void esphome::ltr390::LTR390Component::read_mode_ ( int  mode_index)
protected

Definition at line 85 of file ltr390.cpp.

◆ read_sensor_data_()

optional< uint32_t > esphome::ltr390::LTR390Component::read_sensor_data_ ( LTR390MODE  mode)
protected

Definition at line 26 of file ltr390.cpp.

◆ read_uvs_()

void esphome::ltr390::LTR390Component::read_uvs_ ( )
protected

Definition at line 70 of file ltr390.cpp.

◆ set_als_sensor()

void esphome::ltr390::LTR390Component::set_als_sensor ( sensor::Sensor als_sensor)
inline

Definition at line 64 of file ltr390.h.

◆ set_gain_value()

void esphome::ltr390::LTR390Component::set_gain_value ( LTR390GAIN  gain)
inline

Definition at line 59 of file ltr390.h.

◆ set_light_sensor()

void esphome::ltr390::LTR390Component::set_light_sensor ( sensor::Sensor light_sensor)
inline

Definition at line 63 of file ltr390.h.

◆ set_res_value()

void esphome::ltr390::LTR390Component::set_res_value ( LTR390RESOLUTION  res)
inline

Definition at line 60 of file ltr390.h.

◆ set_uv_sensor()

void esphome::ltr390::LTR390Component::set_uv_sensor ( sensor::Sensor uv_sensor)
inline

Definition at line 66 of file ltr390.h.

◆ set_uvi_sensor()

void esphome::ltr390::LTR390Component::set_uvi_sensor ( sensor::Sensor uvi_sensor)
inline

Definition at line 65 of file ltr390.h.

◆ set_wfac_value()

void esphome::ltr390::LTR390Component::set_wfac_value ( float  wfac)
inline

Definition at line 61 of file ltr390.h.

◆ setup()

void esphome::ltr390::LTR390Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 108 of file ltr390.cpp.

◆ update()

void esphome::ltr390::LTR390Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 158 of file ltr390.cpp.

Field Documentation

◆ als_sensor_

sensor::Sensor* esphome::ltr390::LTR390Component::als_sensor_ {nullptr}
protected

Definition at line 86 of file ltr390.h.

◆ gain_

LTR390GAIN esphome::ltr390::LTR390Component::gain_
protected

Definition at line 81 of file ltr390.h.

◆ light_sensor_

sensor::Sensor* esphome::ltr390::LTR390Component::light_sensor_ {nullptr}
protected

Definition at line 85 of file ltr390.h.

◆ mode_funcs_

std::vector<std::tuple<LTR390MODE, std::function<void()> > > esphome::ltr390::LTR390Component::mode_funcs_
protected

Definition at line 79 of file ltr390.h.

◆ reading_

bool esphome::ltr390::LTR390Component::reading_
protected

Definition at line 76 of file ltr390.h.

◆ res_

LTR390RESOLUTION esphome::ltr390::LTR390Component::res_
protected

Definition at line 82 of file ltr390.h.

◆ uv_sensor_

sensor::Sensor* esphome::ltr390::LTR390Component::uv_sensor_ {nullptr}
protected

Definition at line 89 of file ltr390.h.

◆ uvi_sensor_

sensor::Sensor* esphome::ltr390::LTR390Component::uvi_sensor_ {nullptr}
protected

Definition at line 88 of file ltr390.h.

◆ wfac_

float esphome::ltr390::LTR390Component::wfac_
protected

Definition at line 83 of file ltr390.h.


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