• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..--

api/core/11-Mar-2024-10,7726,033

READMED11-Mar-20241.8 KiB5943

README

1VL53L0X
2#######
3
4Origin:
5   ST Microelectronics
6   http://www.st.com/en/embedded-software/stsw-img005.html
7
8Status:
9   version 1.0.2
10
11Purpose:
12   ST Microelectonics official API to use vl53l0x sensor.
13
14Description:
15   This library written by STMicroelectronics is dedicated to vl53l0x time of flight sensor.
16   Instead of providing a full description of the registers, ST decided to provide a C library to drive this sensor.
17
18   This library is called from the vl53l0x driver and is kept transparent for user.
19   User is calling a standard Zephyr driver and then, the driver makes some calls to this library.
20
21   In order to fit with Zephyr rules and simplify version updates, we have done a minimum of modifications :
22      - keep only API directory
23        (remove documentation and samples, see ST website for this)
24      - rename Api to api
25      - customize api/platform to fit in Zephyr (mainly for I2C access)
26        vl53l0x_platform.c has been moved to Zephyr drivers directory.
27
28   In order to use this library, you have to :
29      * define CONFIG_HAS_STLIB and CONFIG_VL53L0X
30      * use NEWLIB_LIBC in prj.conf (needed for abs function)
31      * include vl53l0x_api.h and vl53l0x_platform.h in the driver .h
32
33Dependencies:
34   This package depends on Zephyr I2C implementation and is linked statically.
35   This library will be used by a standard Zephyr driver.
36
37URL:
38   http://www.st.com/en/embedded-software/stsw-img005.html
39
40commit:
41   version 1.0.2
42
43Maintained-by:
44   External
45
46License:
47   BSD-3-Clause
48
49License Link:
50   http://www.st.com/en/embedded-software/stsw-img005.html
51
52Patch List:
53
54   *Cast unsigned abs param to signed type
55     This will prevent a compiler warning when using clang
56     without -ffreestanding
57     Impacted files:
58      api/core/src/vl53l0x_api_core.c
59