26 LOG_SENSOR(
"",
"VL53L0X",
this);
27 LOG_UPDATE_INTERVAL(
this);
33 " Timeout: %" PRIu32
"%s\n"
34 " Timing Budget %" PRIu32
"us ",
42 if (vl53_sensor->enable_pin_ !=
nullptr) {
44 vl53_sensor->enable_pin_->setup();
45 vl53_sensor->enable_pin_->digital_write(
false);
94 while (
reg(0x83).get() == 0x00) {
96 ESP_LOGE(TAG,
"'%s' - setup timeout", LOG_STR_ARG(this->
get_log_name()));
104 uint8_t tmp =
reg(0x92).
get();
105 uint8_t spad_count = tmp & 0x7F;
106 bool spad_type_is_aperture = tmp & 0x80;
116 uint8_t ref_spad_map[6] = {};
125 uint8_t first_spad_to_enable = spad_type_is_aperture ? 12 : 0;
126 uint8_t spads_enabled = 0;
127 for (
int i = 0; i < 48; i++) {
128 uint8_t &
val = ref_spad_map[i / 8];
129 uint8_t mask = 1 << (i % 8);
131 if (i < first_spad_to_enable || spads_enabled == spad_count) {
133 }
else if (
val & mask) {
246 ESP_LOGW(TAG,
"1st reference calibration failed!");
252 ESP_LOGW(TAG,
"2nd reference calibration failed!");
262 reg(0x8A) = final_address & 0x7F;
270 ESP_LOGW(TAG,
"%s - update called before prior reading complete - initiated:%d waiting_for_interrupt:%d",
305 if (!(
value & 0x01)) {
316 uint16_t range_mm = 0;
317 const bool ok = this->
read_byte_16(0x14 + 10, &range_mm);
326 if (range_mm >= 8190) {
327 ESP_LOGD(TAG,
"'%s' - Distance is out of range, please move the target closer",
333 float range_m = range_mm / 1e3f;
334 ESP_LOGD(TAG,
"'%s' - Got distance %.3f m", LOG_STR_ARG(this->
get_log_name()), range_m);
344 uint16_t start_overhead = 1910;
345 uint16_t end_overhead = 960;
346 uint16_t msrc_overhead = 660;
347 uint16_t tcc_overhead = 590;
348 uint16_t dss_overhead = 690;
349 uint16_t pre_range_overhead = 660;
350 uint16_t final_range_overhead = 550;
353 uint32_t budget_us = start_overhead + end_overhead;
359 budget_us += (timeouts.msrc_dss_tcc_us + tcc_overhead);
362 budget_us += 2 * (timeouts.msrc_dss_tcc_us + dss_overhead);
363 }
else if (enables.msrc) {
364 budget_us += (timeouts.msrc_dss_tcc_us + msrc_overhead);
367 if (enables.pre_range)
368 budget_us += (timeouts.pre_range_us + pre_range_overhead);
370 if (enables.final_range)
371 budget_us += (timeouts.final_range_us + final_range_overhead);
381 uint16_t start_overhead = 1320;
382 uint16_t end_overhead = 960;
383 uint16_t msrc_overhead = 660;
384 uint16_t tcc_overhead = 590;
385 uint16_t dss_overhead = 690;
386 uint16_t pre_range_overhead = 660;
387 uint16_t final_range_overhead = 550;
391 if (budget_us < min_timing_budget) {
395 uint32_t used_budget_us = start_overhead + end_overhead;
401 used_budget_us += (timeouts.msrc_dss_tcc_us + tcc_overhead);
405 used_budget_us += 2 * (timeouts.msrc_dss_tcc_us + dss_overhead);
406 }
else if (enables.msrc) {
407 used_budget_us += (timeouts.msrc_dss_tcc_us + msrc_overhead);
410 if (enables.pre_range) {
411 used_budget_us += (timeouts.pre_range_us + pre_range_overhead);
414 if (enables.final_range) {
415 used_budget_us += final_range_overhead;
423 if (used_budget_us > budget_us) {
428 uint32_t final_range_timeout_us = budget_us - used_budget_us;
438 uint16_t final_range_timeout_mclks =
441 if (enables.pre_range) {
442 final_range_timeout_mclks += timeouts.pre_range_mclks;
455 uint8_t sequence_config =
reg(0x01).
get();
456 enables->
tcc = (sequence_config >> 4) & 0x1;
457 enables->
dss = (sequence_config >> 3) & 0x1;
458 enables->
msrc = (sequence_config >> 2) & 0x1;
459 enables->
pre_range = (sequence_config >> 6) & 0x1;
460 enables->
final_range = (sequence_config >> 7) & 0x1;
499 return (vcsel + 1) << 1;
503 return ((2304UL * vcsel_period_pclks * 1655UL) + 500UL) / 1000UL;
508 return ((timeout_period_mclks * macro_period_ns) + (macro_period_ns / 2)) / 1000;
513 return (((timeout_period_us * 1000) + (macro_period_ns / 2)) / macro_period_ns);
518 uint8_t msb = (reg_val >> 8) & 0xFF;
519 uint8_t lsb = (reg_val >> 0) & 0xFF;
520 return (uint16_t(lsb) << msb) + 1;
526 uint16_t ms_byte = 0;
528 if (timeout_mclks <= 0)
531 ls_byte = timeout_mclks - 1;
533 while ((ls_byte & 0xFFFFFF00) > 0) {
538 return (ms_byte << 8) | (ls_byte & 0xFF);
542 reg(0x00) = 0x01 | vhv_init_byte;
545 while ((
reg(0x13).get() & 0x07) == 0) {
546 if (
millis() - start > 1000)
void mark_failed()
Mark this component as failed.
void status_momentary_warning(uint32_t length=5000)
Set warning status flag and clear it after length ms.
const LogString * get_log_name() const
Get the name for a "%s" log argument (LOG_STR_ARG).
virtual void digital_write(bool value)=0
virtual uint32_t get_update_interval() const
Get the update interval in ms of this sensor.
uint8_t address_
store the address of the device on the bus
bool read_byte(uint8_t a_register, uint8_t *data)
bool read_byte_16(uint8_t a_register, uint16_t *data)
I2CRegister reg(uint8_t a_register)
calls the I2CRegister constructor
void set_i2c_address(uint8_t address)
We store the address of the device on the bus.
bool write_bytes(uint8_t a_register, const uint8_t *data, uint8_t len) const
bool write_byte_16(uint8_t a_register, uint16_t data) const
bool read_bytes(uint8_t a_register, uint8_t *data, uint8_t len)
Compat APIs All methods below have been added for compatibility reasons.
uint8_t get() const
returns the register value
void publish_state(float state)
Publish a new state to the front-end.
uint32_t timeout_mclks_to_microseconds_(uint16_t timeout_period_mclks, uint8_t vcsel_period_pclks)
void get_sequence_step_enables_(SequenceStepEnables *enables)
uint32_t measurement_timing_budget_us_
bool perform_single_ref_calibration_(uint8_t vhv_init_byte)
static bool enable_pin_setup_complete
bool waiting_for_interrupt_
uint16_t decode_timeout_(uint16_t reg_val)
uint32_t timeout_microseconds_to_mclks_(uint32_t timeout_period_us, uint8_t vcsel_period_pclks)
static std::list< VL53L0XSensor * > vl53_sensors
void get_sequence_step_timeouts_(SequenceStepEnables const *enables, SequenceStepTimeouts *timeouts)
bool set_measurement_timing_budget_(uint32_t budget_us)
uint32_t get_measurement_timing_budget_()
uint32_t get_macro_period_(uint8_t vcsel_period_pclks)
uint8_t get_vcsel_pulse_period_(VcselPeriodType type)
void dump_config() override
uint16_t encode_timeout_(uint16_t timeout_mclks)
ESPHOME_LOG_TAG(TAG, "vl53l0x")
@ VCSEL_PERIOD_FINAL_RANGE
void IRAM_ATTR HOT delayMicroseconds(uint32_t us)
uint32_t IRAM_ATTR HOT micros()
uint32_t IRAM_ATTR HOT millis()
uint16_t final_range_vcsel_period_pclks
uint16_t msrc_dss_tcc_mclks
uint16_t final_range_mclks
uint16_t pre_range_vcsel_period_pclks