From 0d6396f24b0551f7bb41218134fed7264c26931c Mon Sep 17 00:00:00 2001 From: RJRP44 Date: Sat, 11 Nov 2023 15:29:32 +0100 Subject: [PATCH] Update manifests --- README.md | 33 +++++----------- examples/ranging_basic/CMakeLists.txt | 1 - examples/ranging_basic/README.md | 39 +++---------------- examples/ranging_basic/main/idf_component.yml | 5 +++ idf_component.yml | 10 +++-- 5 files changed, 26 insertions(+), 62 deletions(-) create mode 100644 examples/ranging_basic/main/idf_component.yml diff --git a/README.md b/README.md index 9df215e..bc36ec2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,4 @@ -

VL53L8CX library for ESP32

-

-Espressif logo -         -ST logo -

+# VL53L8CX library for ESP32 A vl53l5cx library for esp32 using the **esp-idf framework**. This library is based on [ST's Ultra Lite Driver (ULD) for VL53L8CX](https://www.st.com/content/st_com/en/products/embedded-software/imaging-software/stsw-img040.html) @@ -14,16 +9,16 @@ on [ST's Ultra Lite Driver (ULD) for VL53L8CX](https://www.st.com/content/st_co ## Contents šŸ“Œ -* [Installation](#installation-) +* [Getting started](#Getting-started) * [Wiring for the SATEL-VL53L8](#wiring-for-the-satel-VL53L8) - * [Library Installation](#library-installation) + * [Library Installation](#library-installation-) * [Examples](#examples-) * [Usual Errors](#usual-errors-) * [Stack overflow error](#stack-overflow-error-) --- -## Installation šŸ“„ +## Getting started ### Wiring for the SATEL-VL53L8 For the examples this is the used wiring, but feel free to modify it and adapt it for your needs. @@ -45,26 +40,18 @@ For the examples this is the used wiring, but feel free to modify it and adapt i | GND | GND | -### Library Installation +### Library Installation šŸ“„ -You can now 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 ! If you have not already done so, create a file named `idf_component.yml` in your `šŸ“ ./main` folder. Now just add the library to it : -```yaml -dependencies: - - #V53L8CX-Library - vl53l8cx: - git: https://github.com/RJRP44/V53L8CX-Library.git +The library is available at https://components.espressif.com/components/rjrp44/vl53l8cx. -``` - -You can now reload your cmake project, and you should see it in the cmake log and in the `šŸ“ ./managed_components` folder. +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 -Processing 2 dependencies: -[1/2] idf (5.0.0) -[2/2] vl53l8cx +idf.py add-dependency "rjrp44/vl53l8cx^0.1.0" ``` + ## Examples šŸ“„ You can find in `šŸ“ ./examples` ST's examples adapted for ESP32 with IĀ²C. diff --git a/examples/ranging_basic/CMakeLists.txt b/examples/ranging_basic/CMakeLists.txt index 7d27c6c..28c0c00 100644 --- a/examples/ranging_basic/CMakeLists.txt +++ b/examples/ranging_basic/CMakeLists.txt @@ -5,5 +5,4 @@ cmake_minimum_required(VERSION 3.16) include($ENV{IDF_PATH}/tools/cmake/project.cmake) -set(EXTRA_COMPONENT_DIRS ../..) project(ranging_basic) diff --git a/examples/ranging_basic/README.md b/examples/ranging_basic/README.md index 84e2c5e..7cf9fe9 100644 --- a/examples/ranging_basic/README.md +++ b/examples/ranging_basic/README.md @@ -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 \ No newline at end of file diff --git a/examples/ranging_basic/main/idf_component.yml b/examples/ranging_basic/main/idf_component.yml new file mode 100644 index 0000000..7b7e375 --- /dev/null +++ b/examples/ranging_basic/main/idf_component.yml @@ -0,0 +1,5 @@ +version: "1.0.1" +description: "VL53L8CX basic ranging example" +dependencies: + rjrp44/vl53l8cx: + version : "~0.1.0" diff --git a/idf_component.yml b/idf_component.yml index 6421686..ae30aa1 100644 --- a/idf_component.yml +++ b/idf_component.yml @@ -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" \ No newline at end of file + idf: ">=5.0" \ No newline at end of file