Skip to content

Commit

Permalink
Update manifests
Browse files Browse the repository at this point in the history
  • Loading branch information
RJRP44 committed Nov 11, 2023
1 parent ec2e0ea commit 0d6396f
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 62 deletions.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
<h1 style="text-align: center;"> VL53L8CX library for ESP32 </h1>
<p style="text-align: center;">
<img src="https://seeklogo.com/images/E/espressif-systems-logo-1350B9E771-seeklogo.com.png" alt="Espressif logo" width="40">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
<img src="https://upload.wikimedia.org/wikipedia/fr/e/e0/STMicroelectronics_%28logo-2020%29.svg" alt="ST logo" width="160">
</p>
# 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)
Expand All @@ -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.
Expand All @@ -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.
Expand Down
1 change: 0 additions & 1 deletion examples/ranging_basic/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
39 changes: 5 additions & 34 deletions examples/ranging_basic/README.md
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
5 changes: 5 additions & 0 deletions examples/ranging_basic/main/idf_component.yml
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"
10 changes: 6 additions & 4 deletions idf_component.yml
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"

0 comments on commit 0d6396f

Please sign in to comment.