-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
26 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,6 @@ | ||
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-S2 | ESP32-S3 | | ||
| ----------------- | ----- | -------- | -------- | -------- | -------- | | ||
# Ranging Basic | ||
This example is the most basic. It initializes the VL53L8CX ULD, and starts a ranging to capture 10 frames. | ||
|
||
# _Sample project_ | ||
|
||
(See the README.md file in the upper level 'examples' directory for more information about examples.) | ||
|
||
This is the simplest buildable example. The example is used by command `idf.py create-project` | ||
that copies the project to user specified path and set it's name. For more information follow the [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project) | ||
|
||
|
||
|
||
## How to use example | ||
We encourage the users to use the example as a template for the new projects. | ||
A recommended way is to follow the instructions on a [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project). | ||
|
||
## Example folder contents | ||
|
||
The project **sample_project** contains one source file in C language [main.c](main/main.c). The file is located in folder [main](main). | ||
|
||
ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` | ||
files that provide set of directives and instructions describing the project's source files and targets | ||
(executable, library, or both). | ||
|
||
Below is short explanation of remaining files in the project folder. | ||
|
||
``` | ||
├── CMakeLists.txt | ||
├── main | ||
│ ├── CMakeLists.txt | ||
│ └── main.c | ||
└── README.md This is the file you are currently reading | ||
``` | ||
Additionally, the sample project contains Makefile and component.mk files, used for the legacy Make based build system. | ||
They are not used or needed when building with CMake and idf.py. | ||
By default, the vl53l8cx is configured to have the following settings : | ||
- Resolution 4x4 | ||
- Ranging period 1Hz |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
version: "1.0.1" | ||
description: "VL53L8CX basic ranging example" | ||
dependencies: | ||
rjrp44/vl53l8cx: | ||
version : "~0.1.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
version: "1.0.0" | ||
description: A vl53l8cx library for esp32 using the esp-idf framework. | ||
url: https://github.com/RJRP44/V53L8CX-Library | ||
version: "0.1.1" | ||
description: "A vl53l8cx library for esp32 using the esp-idf framework." | ||
url: "https://github.com/RJRP44/VL53L8CX-Library" | ||
repository: "https://github.com/RJRP44/VL53L8CX-Library" | ||
license: "BSD-3-Clause" | ||
dependencies: | ||
idf: ">=4.4" | ||
idf: ">=5.0" |