ESPHome  2022.6.2
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes
esphome::vl53l0x::VL53L0XSensor Class Reference

#include <vl53l0x_sensor.h>

Inheritance diagram for esphome::vl53l0x::VL53L0XSensor:
esphome::sensor::Sensor esphome::PollingComponent esphome::i2c::I2CDevice esphome::EntityBase esphome::Component

Public Member Functions

 VL53L0XSensor ()
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void update () override
 
void loop () override
 
void set_signal_rate_limit (float signal_rate_limit)
 
void set_long_range (bool long_range)
 
void set_timeout_us (uint32_t timeout_us)
 
void set_enable_pin (GPIOPin *enable)
 
- Public Member Functions inherited from esphome::sensor::Sensor
 Sensor ()
 
 Sensor (const std::string &name)
 
std::string get_unit_of_measurement ()
 Get the unit of measurement, using the manual override if set. More...
 
void set_unit_of_measurement (const std::string &unit_of_measurement)
 Manually set the unit of measurement. More...
 
int8_t get_accuracy_decimals ()
 Get the accuracy in decimals, using the manual override if set. More...
 
void set_accuracy_decimals (int8_t accuracy_decimals)
 Manually set the accuracy in decimals. More...
 
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const std::string &device_class)
 Manually set the device class. More...
 
StateClass get_state_class ()
 Get the state class, using the manual override if set. More...
 
void set_state_class (StateClass state_class)
 Manually set the state class. More...
 
bool get_force_update () const
 Get whether force update mode is enabled. More...
 
void set_force_update (bool force_update)
 Set force update mode. More...
 
void add_filter (Filter *filter)
 Add a filter to the filter chain. Will be appended to the back. More...
 
void add_filters (const std::vector< Filter *> &filters)
 Add a list of vectors to the back of the filter chain. More...
 
void set_filters (const std::vector< Filter *> &filters)
 Clear the filters and replace them by filters. More...
 
void clear_filters ()
 Clear the entire filter chain. More...
 
float get_state () const
 Getter-syntax for .state. More...
 
float get_raw_state () const
 Getter-syntax for .raw_state. More...
 
void publish_state (float state)
 Publish a new state to the front-end. More...
 
void add_on_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time a filtered value arrives. More...
 
void add_on_raw_state_callback (std::function< void(float)> &&callback)
 Add a callback that will be called every time the sensor sends a raw value. More...
 
bool has_state () const
 Return whether this sensor has gotten a full state (that passed through all filters) yet. More...
 
virtual std::string unique_id ()
 A unique ID for this sensor, empty for no unique id. More...
 
void internal_send_state_to_frontend (float state)
 
- Public Member Functions inherited from esphome::EntityBase
 EntityBase ()
 
 EntityBase (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_object_id ()
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
const std::string & get_icon () const
 
void set_icon (const std::string &name)
 
- 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
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  VcselPeriodType { VCSEL_PERIOD_PRE_RANGE, VCSEL_PERIOD_FINAL_RANGE }
 

Protected Member Functions

uint32_t get_measurement_timing_budget_ ()
 
bool set_measurement_timing_budget_ (uint32_t budget_us)
 
void get_sequence_step_enables_ (SequenceStepEnables *enables)
 
void get_sequence_step_timeouts_ (SequenceStepEnables const *enables, SequenceStepTimeouts *timeouts)
 
uint8_t get_vcsel_pulse_period_ (VcselPeriodType type)
 
uint32_t get_macro_period_ (uint8_t vcsel_period_pclks)
 
uint32_t timeout_mclks_to_microseconds_ (uint16_t timeout_period_mclks, uint8_t vcsel_period_pclks)
 
uint32_t timeout_microseconds_to_mclks_ (uint32_t timeout_period_us, uint8_t vcsel_period_pclks)
 
uint16_t decode_timeout_ (uint16_t reg_val)
 
uint16_t encode_timeout_ (uint16_t timeout_mclks)
 
bool perform_single_ref_calibration_ (uint8_t vhv_init_byte)
 
- Protected Member Functions inherited from esphome::sensor::Sensor
virtual std::string unit_of_measurement ()
 Override this to set the default unit of measurement. More...
 
virtual int8_t accuracy_decimals ()
 Override this to set the default accuracy in decimals. More...
 
virtual std::string device_class ()
 Override this to set the default device class. More...
 
virtual StateClass state_class ()
 Override this to set the default state class. More...
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 
- 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

float signal_rate_limit_
 
bool long_range_
 
GPIOPinenable_pin_ {nullptr}
 
uint32_t measurement_timing_budget_us_
 
bool initiated_read_ {false}
 
bool waiting_for_interrupt_ {false}
 
uint8_t stop_variable_
 
uint16_t timeout_start_us_
 
uint16_t timeout_us_ {}
 
- Protected Attributes inherited from esphome::sensor::Sensor
CallbackManager< void(float)> raw_callback_
 Storage for raw state callbacks. More...
 
CallbackManager< void(float)> callback_
 Storage for filtered state callbacks. More...
 
bool has_state_ {false}
 
Filterfilter_list_ {nullptr}
 Store all active filters. More...
 
optional< std::string > unit_of_measurement_
 Unit of measurement override. More...
 
optional< int8_t > accuracy_decimals_
 Accuracy in decimals override. More...
 
optional< std::string > device_class_
 Device class override. More...
 
optional< StateClassstate_class_ {STATE_CLASS_NONE}
 State class override. More...
 
bool force_update_ {false}
 Force update mode. More...
 
- Protected Attributes inherited from esphome::EntityBase
std::string name_
 
std::string object_id_
 
std::string icon_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_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}
 
I2CBusbus_ {nullptr}
 

Static Protected Attributes

static std::list< VL53L0XSensor * > vl53_sensors
 
static bool enable_pin_setup_complete = false
 

Additional Inherited Members

- Data Fields inherited from esphome::sensor::Sensor
float state
 This member variable stores the last state that has passed through all filters. More...
 
float raw_state
 This member variable stores the current raw state of the sensor, without any filters applied. More...
 

Detailed Description

Definition at line 24 of file vl53l0x_sensor.h.

Member Enumeration Documentation

◆ VcselPeriodType

Enumerator
VCSEL_PERIOD_PRE_RANGE 
VCSEL_PERIOD_FINAL_RANGE 

Definition at line 165 of file vl53l0x_sensor.h.

Constructor & Destructor Documentation

◆ VL53L0XSensor()

esphome::vl53l0x::VL53L0XSensor::VL53L0XSensor ( )

Definition at line 21 of file vl53l0x_sensor.cpp.

Member Function Documentation

◆ decode_timeout_()

uint16_t esphome::vl53l0x::VL53L0XSensor::decode_timeout_ ( uint16_t  reg_val)
inlineprotected

Definition at line 219 of file vl53l0x_sensor.h.

◆ dump_config()

void esphome::vl53l0x::VL53L0XSensor::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 23 of file vl53l0x_sensor.cpp.

◆ encode_timeout_()

uint16_t esphome::vl53l0x::VL53L0XSensor::encode_timeout_ ( uint16_t  timeout_mclks)
inlineprotected

Definition at line 225 of file vl53l0x_sensor.h.

◆ get_macro_period_()

uint32_t esphome::vl53l0x::VL53L0XSensor::get_macro_period_ ( uint8_t  vcsel_period_pclks)
inlineprotected

Definition at line 206 of file vl53l0x_sensor.h.

◆ get_measurement_timing_budget_()

uint32_t esphome::vl53l0x::VL53L0XSensor::get_measurement_timing_budget_ ( )
inlineprotected

Definition at line 42 of file vl53l0x_sensor.h.

◆ get_sequence_step_enables_()

void esphome::vl53l0x::VL53L0XSensor::get_sequence_step_enables_ ( SequenceStepEnables enables)
inlineprotected

Definition at line 156 of file vl53l0x_sensor.h.

◆ get_sequence_step_timeouts_()

void esphome::vl53l0x::VL53L0XSensor::get_sequence_step_timeouts_ ( SequenceStepEnables const *  enables,
SequenceStepTimeouts timeouts 
)
inlineprotected

Definition at line 167 of file vl53l0x_sensor.h.

◆ get_setup_priority()

float esphome::vl53l0x::VL53L0XSensor::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file vl53l0x_sensor.h.

◆ get_vcsel_pulse_period_()

uint8_t esphome::vl53l0x::VL53L0XSensor::get_vcsel_pulse_period_ ( VcselPeriodType  type)
inlineprotected

Definition at line 193 of file vl53l0x_sensor.h.

◆ loop()

void esphome::vl53l0x::VL53L0XSensor::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 283 of file vl53l0x_sensor.cpp.

◆ perform_single_ref_calibration_()

bool esphome::vl53l0x::VL53L0XSensor::perform_single_ref_calibration_ ( uint8_t  vhv_init_byte)
inlineprotected

Definition at line 243 of file vl53l0x_sensor.h.

◆ set_enable_pin()

void esphome::vl53l0x::VL53L0XSensor::set_enable_pin ( GPIOPin enable)
inline

Definition at line 39 of file vl53l0x_sensor.h.

◆ set_long_range()

void esphome::vl53l0x::VL53L0XSensor::set_long_range ( bool  long_range)
inline

Definition at line 37 of file vl53l0x_sensor.h.

◆ set_measurement_timing_budget_()

bool esphome::vl53l0x::VL53L0XSensor::set_measurement_timing_budget_ ( uint32_t  budget_us)
inlineprotected

Definition at line 79 of file vl53l0x_sensor.h.

◆ set_signal_rate_limit()

void esphome::vl53l0x::VL53L0XSensor::set_signal_rate_limit ( float  signal_rate_limit)
inline

Definition at line 36 of file vl53l0x_sensor.h.

◆ set_timeout_us()

void esphome::vl53l0x::VL53L0XSensor::set_timeout_us ( uint32_t  timeout_us)
inline

Definition at line 38 of file vl53l0x_sensor.h.

◆ setup()

void esphome::vl53l0x::VL53L0XSensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file vl53l0x_sensor.cpp.

◆ timeout_mclks_to_microseconds_()

uint32_t esphome::vl53l0x::VL53L0XSensor::timeout_mclks_to_microseconds_ ( uint16_t  timeout_period_mclks,
uint8_t  vcsel_period_pclks 
)
inlineprotected

Definition at line 210 of file vl53l0x_sensor.h.

◆ timeout_microseconds_to_mclks_()

uint32_t esphome::vl53l0x::VL53L0XSensor::timeout_microseconds_to_mclks_ ( uint32_t  timeout_period_us,
uint8_t  vcsel_period_pclks 
)
inlineprotected

Definition at line 214 of file vl53l0x_sensor.h.

◆ update()

void esphome::vl53l0x::VL53L0XSensor::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 260 of file vl53l0x_sensor.cpp.

Field Documentation

◆ enable_pin_

GPIOPin* esphome::vl53l0x::VL53L0XSensor::enable_pin_ {nullptr}
protected

Definition at line 261 of file vl53l0x_sensor.h.

◆ enable_pin_setup_complete

bool esphome::vl53l0x::VL53L0XSensor::enable_pin_setup_complete = false
staticprotected

Definition at line 271 of file vl53l0x_sensor.h.

◆ initiated_read_

bool esphome::vl53l0x::VL53L0XSensor::initiated_read_ {false}
protected

Definition at line 263 of file vl53l0x_sensor.h.

◆ long_range_

bool esphome::vl53l0x::VL53L0XSensor::long_range_
protected

Definition at line 260 of file vl53l0x_sensor.h.

◆ measurement_timing_budget_us_

uint32_t esphome::vl53l0x::VL53L0XSensor::measurement_timing_budget_us_
protected

Definition at line 262 of file vl53l0x_sensor.h.

◆ signal_rate_limit_

float esphome::vl53l0x::VL53L0XSensor::signal_rate_limit_
protected

Definition at line 259 of file vl53l0x_sensor.h.

◆ stop_variable_

uint8_t esphome::vl53l0x::VL53L0XSensor::stop_variable_
protected

Definition at line 265 of file vl53l0x_sensor.h.

◆ timeout_start_us_

uint16_t esphome::vl53l0x::VL53L0XSensor::timeout_start_us_
protected

Definition at line 267 of file vl53l0x_sensor.h.

◆ timeout_us_

uint16_t esphome::vl53l0x::VL53L0XSensor::timeout_us_ {}
protected

Definition at line 268 of file vl53l0x_sensor.h.

◆ vl53_sensors

std::list< VL53L0XSensor * > esphome::vl53l0x::VL53L0XSensor::vl53_sensors
staticprotected

Definition at line 270 of file vl53l0x_sensor.h.

◆ waiting_for_interrupt_

bool esphome::vl53l0x::VL53L0XSensor::waiting_for_interrupt_ {false}
protected

Definition at line 264 of file vl53l0x_sensor.h.


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