Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rjrp44/vl53l5cx-library

💽 A vl53l5cx library for esp32 using the esp-idf framework
https://github.com/rjrp44/vl53l5cx-library

esp-idf esp32 esp32-library tof-sensor vl53v5cx

Last synced: 20 days ago
JSON representation

💽 A vl53l5cx library for esp32 using the esp-idf framework

Host: GitHub
URL: https://github.com/rjrp44/vl53l5cx-library
Owner: RJRP44
License: bsd-3-clause
Created: 2022-06-21T06:53:36.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-04-10T14:25:39.000Z (9 months ago)
Last Synced: 2024-04-10T17:13:22.187Z (9 months ago)
Topics: esp-idf, esp32, esp32-library, tof-sensor, vl53v5cx
Language: C
Homepage:
Size: 433 KB
Stars: 12
Watchers: 2
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # VL53L5CX library for ESP32

[![Component Registry](https://components.espressif.com/components/rjrp44/vl53l5cx/badge.svg)](https://components.espressif.com/components/rjrp44/vl53l5cx)

[![Uld Version](https://img.shields.io/badge/uld_version-1.3.11-white)](https://www.st.com/content/st_com/en/products/embedded-software/imaging-software/stsw-img023.html)

A vl53l5cx library for esp32 using the **esp-idf framework**. This library is based

on [ST's  Ultra Lite Driver (ULD) for VL53L5CX](https://www.st.com/content/st_com/en/products/embedded-software/imaging-software/stsw-img023.html) v1.3.11

. This library is just an adaptation of the ST's library for esp-32.

> **Warning**

> This Library is **not** compatible with Arduino framework

## Contents 📌

* [Getting started](#Getting-started)

    * [Wiring for the VL53L5CX-SATEL](#wiring-for-the-vl53l5cx-satel- )

    * [Library Installation](#library-installation-)

* [Examples](#examples-)

* [Usual Errors](#usual-errors-)

    * [Stack overflow error](#stack-overflow-error-)

* [More parameters](#more-parameters-)

---

## Getting started

### Wiring for the VL53L5CX-SATEL 🔌

For the examples this is the used wiring, but feel free to modify it and adapt it for your needs.

| VL53L5CX-SATEL Pins | ESP32S3 Pins                                  |           

|---------------------|-----------------------------------------------|

| INT                 | NC                                            |

| I2C_RST             | NC                                            |

| SDA                 | GPIO1, 2.2 kΩ pullup resistor required to 3v3 |

| SCL                 | GPIO2, 2.2 kΩ pullup resistor required to 3v3 |

| LPn                 | 3V3                                           |

| PWREN               | NC                                            |

| AVDD                | 3V3                                           |

| IOVDD               | 3V3                                           |

| GND                 | GND                                           |

### Library Installation 📥

The library is available at https://components.espressif.com/components/rjrp44/vl53l5cx.

So, you can use the [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html) to easily import this library into your project.

To add this component to your project, run:

```log

idf.py add-dependency "rjrp44/vl53l5cx^2.0.4" 

```

## Examples 📄

You can find in `📁 ./examples` ST's examples adapted for ESP32 with I²C. For more information about the available features read [UM2884](https://www.st.com/resource/en/user_manual/um2884-a-guide-to-using-the-vl53l5cx-multizone-timeofflight-ranging-sensor-with-wide-field-of-view-ultra-lite-driver-uld-stmicroelectronics.pdf).

## Usual errors 🐛

### Stack overflow error 💽

If by running an example you get a stack overflow error, this means that your main stack size is too small.

```log

***ERROR*** A stack overflow in task main has been detected.

```

**Increase the main stack size :**

Run `idf.py menuconfig`. Go to Component `Component config -> ESP System settings` and increase the Main task stack size to at least `7168`.

## More parameters ⚙

In order to get more control over your sensor configuration, run `idf.py menuconfig` and go to `Component Config -> Vl53l5cx`.

## 📝 License

Copyright © 2024 [RJRP](https://www.github.com/RJRP44).

This project is [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause/)  licensed.

## ✨ Show your support

Give a ⭐️ if this project helped you!

## 👤 Authors

- [@RJRP](https://www.github.com/RJRP44)