ESPHome  2024.12.2
Data Structures | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::ltr_als_ps::LTRAlsPsComponent Class Reference

#include <ltr_als_ps.h>

Inheritance diagram for esphome::ltr_als_ps::LTRAlsPsComponent:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

Data Structures

struct  AlsReadings
 

Public Member Functions

float get_setup_priority () const override
 
void setup () override
 
void dump_config () override
 
void update () override
 
void loop () override
 
void set_ltr_type (LtrType type)
 
void set_als_auto_mode (bool enable)
 
void set_als_gain (AlsGain gain)
 
void set_als_integration_time (IntegrationTime time)
 
void set_als_meas_repeat_rate (MeasurementRepeatRate rate)
 
void set_als_glass_attenuation_factor (float factor)
 
void set_ps_high_threshold (uint16_t threshold)
 
void set_ps_low_threshold (uint16_t threshold)
 
void set_ps_cooldown_time_s (uint16_t time)
 
void set_ps_gain (PsGain gain)
 
void set_ambient_light_sensor (sensor::Sensor *sensor)
 
void set_full_spectrum_counts_sensor (sensor::Sensor *sensor)
 
void set_infrared_counts_sensor (sensor::Sensor *sensor)
 
void set_actual_gain_sensor (sensor::Sensor *sensor)
 
void set_actual_integration_time_sensor (sensor::Sensor *sensor)
 
void set_proximity_counts_sensor (sensor::Sensor *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...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
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::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  State : uint8_t {
  State::NOT_INITIALIZED, State::DELAYED_SETUP, State::IDLE, State::WAITING_FOR_DATA,
  State::COLLECTING_DATA_AUTO, State::DATA_COLLECTED, State::ADJUSTMENT_IN_PROGRESS, State::READY_TO_PUBLISH,
  State::KEEP_PUBLISHING
}
 

Protected Member Functions

bool is_als_ () const
 
bool is_ps_ () const
 
bool check_part_number_ ()
 
void configure_reset_ ()
 
void configure_als_ ()
 
void configure_integration_time_ (IntegrationTime time)
 
void configure_gain_ (AlsGain gain)
 
DataAvail is_als_data_ready_ (AlsReadings &data)
 
void read_sensor_data_ (AlsReadings &data)
 
bool are_adjustments_required_ (AlsReadings &data)
 
void apply_lux_calculation_ (AlsReadings &data)
 
void publish_data_part_1_ (AlsReadings &data)
 
void publish_data_part_2_ (AlsReadings &data)
 
void configure_ps_ ()
 
uint16_t read_ps_data_ ()
 
void check_and_trigger_ps_ ()
 
bool is_any_als_sensor_enabled_ () const
 
bool is_any_ps_sensor_enabled_ () const
 
void add_on_ps_high_trigger_callback_ (std::function< void()> callback)
 
void add_on_ps_low_trigger_callback_ (std::function< void()> callback)
 
- 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

enum esphome::ltr_als_ps::LTRAlsPsComponent::State NOT_INITIALIZED
 
LtrType ltr_type_ {LtrType::LTR_TYPE_ALS_ONLY}
 
struct esphome::ltr_als_ps::LTRAlsPsComponent::AlsReadings als_readings_
 
uint16_t ps_readings_ {0xfffe}
 
bool automatic_mode_enabled_ {true}
 
AlsGain gain_ {AlsGain::GAIN_1}
 
IntegrationTime integration_time_ {IntegrationTime::INTEGRATION_TIME_100MS}
 
MeasurementRepeatRate repeat_rate_ {MeasurementRepeatRate::REPEAT_RATE_500MS}
 
float glass_attenuation_factor_ {1.0}
 
uint16_t ps_cooldown_time_s_ {5}
 
PsGain ps_gain_ {PsGain::PS_GAIN_16}
 
uint16_t ps_threshold_high_ {0xffff}
 
uint16_t ps_threshold_low_ {0x0000}
 
sensor::Sensorinfrared_counts_sensor_ {nullptr}
 
sensor::Sensorfull_spectrum_counts_sensor_ {nullptr}
 
sensor::Sensorambient_light_sensor_ {nullptr}
 
sensor::Sensoractual_gain_sensor_ {nullptr}
 
sensor::Sensoractual_integration_time_sensor_ {nullptr}
 
sensor::Sensorproximity_counts_sensor_ {nullptr}
 
CallbackManager< void()> on_ps_high_trigger_callback_
 
CallbackManager< void()> on_ps_low_trigger_callback_
 
- 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 23 of file ltr_als_ps.h.

Member Enumeration Documentation

◆ State

enum esphome::ltr_als_ps::LTRAlsPsComponent::State : uint8_t
strongprotected
Enumerator
NOT_INITIALIZED 
DELAYED_SETUP 
IDLE 
WAITING_FOR_DATA 
COLLECTING_DATA_AUTO 
DATA_COLLECTED 
ADJUSTMENT_IN_PROGRESS 
READY_TO_PUBLISH 
KEEP_PUBLISHING 

Definition at line 67 of file ltr_als_ps.h.

Member Function Documentation

◆ add_on_ps_high_trigger_callback_()

void esphome::ltr_als_ps::LTRAlsPsComponent::add_on_ps_high_trigger_callback_ ( std::function< void()>  callback)
inlineprotected

Definition at line 161 of file ltr_als_ps.h.

◆ add_on_ps_low_trigger_callback_()

void esphome::ltr_als_ps::LTRAlsPsComponent::add_on_ps_low_trigger_callback_ ( std::function< void()>  callback)
inlineprotected

Definition at line 165 of file ltr_als_ps.h.

◆ apply_lux_calculation_()

void esphome::ltr_als_ps::LTRAlsPsComponent::apply_lux_calculation_ ( AlsReadings data)
protected

Definition at line 457 of file ltr_als_ps.cpp.

◆ are_adjustments_required_()

bool esphome::ltr_als_ps::LTRAlsPsComponent::are_adjustments_required_ ( AlsReadings data)
protected

Definition at line 404 of file ltr_als_ps.cpp.

◆ check_and_trigger_ps_()

void esphome::ltr_als_ps::LTRAlsPsComponent::check_and_trigger_ps_ ( )
protected

Definition at line 216 of file ltr_als_ps.cpp.

◆ check_part_number_()

bool esphome::ltr_als_ps::LTRAlsPsComponent::check_part_number_ ( )
protected

Definition at line 239 of file ltr_als_ps.cpp.

◆ configure_als_()

void esphome::ltr_als_ps::LTRAlsPsComponent::configure_als_ ( )
protected

Definition at line 288 of file ltr_als_ps.cpp.

◆ configure_gain_()

void esphome::ltr_als_ps::LTRAlsPsComponent::configure_gain_ ( AlsGain  gain)
protected

Definition at line 340 of file ltr_als_ps.cpp.

◆ configure_integration_time_()

void esphome::ltr_als_ps::LTRAlsPsComponent::configure_integration_time_ ( IntegrationTime  time)
protected

Definition at line 356 of file ltr_als_ps.cpp.

◆ configure_ps_()

void esphome::ltr_als_ps::LTRAlsPsComponent::configure_ps_ ( )
protected

Definition at line 311 of file ltr_als_ps.cpp.

◆ configure_reset_()

void esphome::ltr_als_ps::LTRAlsPsComponent::configure_reset_ ( )
protected

Definition at line 268 of file ltr_als_ps.cpp.

◆ dump_config()

void esphome::ltr_als_ps::LTRAlsPsComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 71 of file ltr_als_ps.cpp.

◆ get_setup_priority()

float esphome::ltr_als_ps::LTRAlsPsComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 28 of file ltr_als_ps.h.

◆ is_als_()

bool esphome::ltr_als_ps::LTRAlsPsComponent::is_als_ ( ) const
inlineprotected

Definition at line 94 of file ltr_als_ps.h.

◆ is_als_data_ready_()

DataAvail esphome::ltr_als_ps::LTRAlsPsComponent::is_als_data_ready_ ( AlsReadings data)
protected

Definition at line 372 of file ltr_als_ps.cpp.

◆ is_any_als_sensor_enabled_()

bool esphome::ltr_als_ps::LTRAlsPsComponent::is_any_als_sensor_enabled_ ( ) const
inlineprotected

Definition at line 145 of file ltr_als_ps.h.

◆ is_any_ps_sensor_enabled_()

bool esphome::ltr_als_ps::LTRAlsPsComponent::is_any_ps_sensor_enabled_ ( ) const
inlineprotected

Definition at line 150 of file ltr_als_ps.h.

◆ is_ps_()

bool esphome::ltr_als_ps::LTRAlsPsComponent::is_ps_ ( ) const
inlineprotected

Definition at line 97 of file ltr_als_ps.h.

◆ loop()

void esphome::ltr_als_ps::LTRAlsPsComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 131 of file ltr_als_ps.cpp.

◆ publish_data_part_1_()

void esphome::ltr_als_ps::LTRAlsPsComponent::publish_data_part_1_ ( AlsReadings data)
protected

Definition at line 495 of file ltr_als_ps.cpp.

◆ publish_data_part_2_()

void esphome::ltr_als_ps::LTRAlsPsComponent::publish_data_part_2_ ( AlsReadings data)
protected

Definition at line 510 of file ltr_als_ps.cpp.

◆ read_ps_data_()

uint16_t esphome::ltr_als_ps::LTRAlsPsComponent::read_ps_data_ ( )
protected

Definition at line 322 of file ltr_als_ps.cpp.

◆ read_sensor_data_()

void esphome::ltr_als_ps::LTRAlsPsComponent::read_sensor_data_ ( AlsReadings data)
protected

Definition at line 391 of file ltr_als_ps.cpp.

◆ set_actual_gain_sensor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_actual_gain_sensor ( sensor::Sensor sensor)
inline

Definition at line 58 of file ltr_als_ps.h.

◆ set_actual_integration_time_sensor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_actual_integration_time_sensor ( sensor::Sensor sensor)
inline

Definition at line 59 of file ltr_als_ps.h.

◆ set_als_auto_mode()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_als_auto_mode ( bool  enable)
inline

Definition at line 40 of file ltr_als_ps.h.

◆ set_als_gain()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_als_gain ( AlsGain  gain)
inline

Definition at line 41 of file ltr_als_ps.h.

◆ set_als_glass_attenuation_factor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_als_glass_attenuation_factor ( float  factor)
inline

Definition at line 44 of file ltr_als_ps.h.

◆ set_als_integration_time()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_als_integration_time ( IntegrationTime  time)
inline

Definition at line 42 of file ltr_als_ps.h.

◆ set_als_meas_repeat_rate()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_als_meas_repeat_rate ( MeasurementRepeatRate  rate)
inline

Definition at line 43 of file ltr_als_ps.h.

◆ set_ambient_light_sensor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_ambient_light_sensor ( sensor::Sensor sensor)
inline

Definition at line 55 of file ltr_als_ps.h.

◆ set_full_spectrum_counts_sensor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_full_spectrum_counts_sensor ( sensor::Sensor sensor)
inline

Definition at line 56 of file ltr_als_ps.h.

◆ set_infrared_counts_sensor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_infrared_counts_sensor ( sensor::Sensor sensor)
inline

Definition at line 57 of file ltr_als_ps.h.

◆ set_ltr_type()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_ltr_type ( LtrType  type)
inline

Definition at line 36 of file ltr_als_ps.h.

◆ set_proximity_counts_sensor()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_proximity_counts_sensor ( sensor::Sensor sensor)
inline

Definition at line 60 of file ltr_als_ps.h.

◆ set_ps_cooldown_time_s()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_ps_cooldown_time_s ( uint16_t  time)
inline

Definition at line 50 of file ltr_als_ps.h.

◆ set_ps_gain()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_ps_gain ( PsGain  gain)
inline

Definition at line 51 of file ltr_als_ps.h.

◆ set_ps_high_threshold()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_ps_high_threshold ( uint16_t  threshold)
inline

Definition at line 48 of file ltr_als_ps.h.

◆ set_ps_low_threshold()

void esphome::ltr_als_ps::LTRAlsPsComponent::set_ps_low_threshold ( uint16_t  threshold)
inline

Definition at line 49 of file ltr_als_ps.h.

◆ setup()

void esphome::ltr_als_ps::LTRAlsPsComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 65 of file ltr_als_ps.cpp.

◆ update()

void esphome::ltr_als_ps::LTRAlsPsComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 112 of file ltr_als_ps.cpp.

Field Documentation

◆ actual_gain_sensor_

sensor::Sensor* esphome::ltr_als_ps::LTRAlsPsComponent::actual_gain_sensor_ {nullptr}
protected

Definition at line 141 of file ltr_als_ps.h.

◆ actual_integration_time_sensor_

sensor::Sensor* esphome::ltr_als_ps::LTRAlsPsComponent::actual_integration_time_sensor_ {nullptr}
protected

Definition at line 142 of file ltr_als_ps.h.

◆ als_readings_

struct esphome::ltr_als_ps::LTRAlsPsComponent::AlsReadings esphome::ltr_als_ps::LTRAlsPsComponent::als_readings_
protected

◆ ambient_light_sensor_

sensor::Sensor* esphome::ltr_als_ps::LTRAlsPsComponent::ambient_light_sensor_ {nullptr}
protected

Definition at line 140 of file ltr_als_ps.h.

◆ automatic_mode_enabled_

bool esphome::ltr_als_ps::LTRAlsPsComponent::automatic_mode_enabled_ {true}
protected

Definition at line 124 of file ltr_als_ps.h.

◆ full_spectrum_counts_sensor_

sensor::Sensor* esphome::ltr_als_ps::LTRAlsPsComponent::full_spectrum_counts_sensor_ {nullptr}
protected

Definition at line 139 of file ltr_als_ps.h.

◆ gain_

AlsGain esphome::ltr_als_ps::LTRAlsPsComponent::gain_ {AlsGain::GAIN_1}
protected

Definition at line 125 of file ltr_als_ps.h.

◆ glass_attenuation_factor_

float esphome::ltr_als_ps::LTRAlsPsComponent::glass_attenuation_factor_ {1.0}
protected

Definition at line 128 of file ltr_als_ps.h.

◆ infrared_counts_sensor_

sensor::Sensor* esphome::ltr_als_ps::LTRAlsPsComponent::infrared_counts_sensor_ {nullptr}
protected

Definition at line 138 of file ltr_als_ps.h.

◆ integration_time_

IntegrationTime esphome::ltr_als_ps::LTRAlsPsComponent::integration_time_ {IntegrationTime::INTEGRATION_TIME_100MS}
protected

Definition at line 126 of file ltr_als_ps.h.

◆ ltr_type_

LtrType esphome::ltr_als_ps::LTRAlsPsComponent::ltr_type_ {LtrType::LTR_TYPE_ALS_ONLY}
protected

Definition at line 79 of file ltr_als_ps.h.

◆ NOT_INITIALIZED

enum esphome::ltr_als_ps::LTRAlsPsComponent::State esphome::ltr_als_ps::LTRAlsPsComponent::NOT_INITIALIZED
protected

◆ on_ps_high_trigger_callback_

CallbackManager<void()> esphome::ltr_als_ps::LTRAlsPsComponent::on_ps_high_trigger_callback_
protected

Definition at line 158 of file ltr_als_ps.h.

◆ on_ps_low_trigger_callback_

CallbackManager<void()> esphome::ltr_als_ps::LTRAlsPsComponent::on_ps_low_trigger_callback_
protected

Definition at line 159 of file ltr_als_ps.h.

◆ proximity_counts_sensor_

sensor::Sensor* esphome::ltr_als_ps::LTRAlsPsComponent::proximity_counts_sensor_ {nullptr}
protected

Definition at line 143 of file ltr_als_ps.h.

◆ ps_cooldown_time_s_

uint16_t esphome::ltr_als_ps::LTRAlsPsComponent::ps_cooldown_time_s_ {5}
protected

Definition at line 130 of file ltr_als_ps.h.

◆ ps_gain_

PsGain esphome::ltr_als_ps::LTRAlsPsComponent::ps_gain_ {PsGain::PS_GAIN_16}
protected

Definition at line 131 of file ltr_als_ps.h.

◆ ps_readings_

uint16_t esphome::ltr_als_ps::LTRAlsPsComponent::ps_readings_ {0xfffe}
protected

Definition at line 92 of file ltr_als_ps.h.

◆ ps_threshold_high_

uint16_t esphome::ltr_als_ps::LTRAlsPsComponent::ps_threshold_high_ {0xffff}
protected

Definition at line 132 of file ltr_als_ps.h.

◆ ps_threshold_low_

uint16_t esphome::ltr_als_ps::LTRAlsPsComponent::ps_threshold_low_ {0x0000}
protected

Definition at line 133 of file ltr_als_ps.h.

◆ repeat_rate_

MeasurementRepeatRate esphome::ltr_als_ps::LTRAlsPsComponent::repeat_rate_ {MeasurementRepeatRate::REPEAT_RATE_500MS}
protected

Definition at line 127 of file ltr_als_ps.h.


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