Release Notes for Projects of X-CUBE-TOF1 Package
Copyright © 2022 STMicroelectronics
Purpose
The X-CUBE-TOF1 projects are a set of applicative examples that aim to explain and provide use cases of the single zone and multi zones time of flight sensors and nucleo boards. They provide basic functionalities, show main features or demonstrate performance. They are delivered with preconfigured projects for the main supported toolchains. Projects include STM32CubeMX project file (.ioc) for the graphical visualization of the STM32 microcontroller pins, peripherals configuration.
For further information of drivers’ features and usage please refer to:
- VL53L1CB driver on st.com
- VL53L3CX driver on st.com
- VL53L4CD driver on st.com
- VL53L4CX driver on st.com
- VL53L4ED driver on st.com
- VL53L5CX driver on st.com
- VL53L7CX driver on st.com
- VL53L8CX driver on st.com
List of references to the other user documents:
- X-NUCLEO-53L1A2: Multi-targets ranging sensor expansion board based on VL53L1 for STM32 Nucleo
- VL53L1CB: Time-of-Flight ranging sensor with multi-object detection and FoV programming
- VL53L1-SATEL: Breakout board for VL53L1 with multi-object detection and FoV programming
- X-NUCLEO-53L3A2: Multi-targets ranging sensor expansion board based on VL53L3CX for STM32 Nucleo
- VL53L3CX: Time-of-Flight ranging sensor with multi target detection
- VL53L3CX-SATEL: Breakout board for VL53L3CX with multi-target detection
- X-NUCLEO-53L4A2: Multi-targets ranging sensor expansion board based on VL53L4CX for STM32 Nucleo
- VL53L4CX: Time-of-Flight ranging sensor with extended range measurement
- SATEL-VL53L4CX: Breakout for VL53L4CX with extended range measurement
- VL53L4CD: Time-of-Flight high-accuracy proximity sensor
- SATEL-VL53L4CD: Breakout for VL53L4CD Time-of-Flight high-accuracy proximity sensor
- X-NUCLEO-53L4A3: Multi-targets ranging sensor expansion board based on VL53L4ED for STM32 Nucleo
- VL53L4ED: Time-of-Flight Extended temperature range high-accuracy proximity sensor
- SATEL-VL53L4ED: Breakout for VL53L4ED Time-of-Flight Extended temperature range high-accuracy proximity sensor
- X-NUCLEO-53L5A1: 8x8 multizone with wide field of view ranging sensor expansion board based on VL53L5CX for STM32 Nucleo
- VL53L5CX: Time-of-Flight 8x8 multizone ranging sensor with wide field of view
- VL53L5CX-SATEL: Breakout board for VL53L5CX
- X-NUCLEO-53L7A1: 8x8 multizone with 90 degrees field of view ranging sensor expansion board based on VL53L7CX for STM32 Nucleo
- VL53L7CX: Time-of-Flight 8x8 multizone ranging sensor with 90 degrees FoV
- SATEL-VL53L7CX: Breakout board for VL53L7CX
- X-NUCLEO-53L8A1: Time-of-Flight expansion board based on the VL53L8 series for STM32 Nucleo
- VL53L8CX: Low-power high-performance 8x8 multizone Time-of-Flight sensor
- SATEL-VL53L8: Breakout board for VL53L8 series
Update history
Main changes
Product Update
| Headline |
|---|
| No actual changes in examples, just rebuilt with latest BSP components |
Contents
Projects
Known limitations
| Headline |
|---|
| The STM32WB0xx and STM32WL3xx families are not supported in projects generation with the TOF1 pack. |
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging application examples don’t support multi target detection |
| When generating projects for STM32U5, user may encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.17.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L4ED
- VL53L5CX
- VL53L7CX
- VL53L8CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L4A3
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- X-NUCLEO-53L8A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- SATEL-VL53L4ED
- VL53L5CX-SATEL
- SATEL-VL53L7CX
- SATEL-VL53L8
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.2
- STM32CubeHAL L4 V1.13.4
Main changes
Product Update
| Headline |
|---|
| Reworked some multi sensor examples to fix sensor bad detection after reset |
| Added multi sensor example for VL53L8CX device, need for NUCLEO-53L8A1 version B for stable behavior, it is not guaranted with version A |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging application examples don’t support multi target detection |
| When generating projects for STM32U5, user may encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.15.1
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L4ED
- VL53L5CX
- VL53L7CX
- VL53L8CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L4A3
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- X-NUCLEO-53L8A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- SATEL-VL53L4ED
- VL53L5CX-SATEL
- SATEL-VL53L7CX
- SATEL-VL53L8
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.2
- STM32CubeHAL L4 V1.13.4
Main changes
Product Update
| Headline |
|---|
| Reworked examples to remove RTC (badly enabled but no use) |
| Removed erroneous I2C_RST pin assignment in VL53L8 examples |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging application examples don’t support multi target detection |
| When generating projects for STM32U5, user may encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.14.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L4ED
- VL53L5CX
- VL53L7CX
- VL53L8CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L4A3
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- X-NUCLEO-53L8A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- SATEL-VL53L4ED
- VL53L5CX-SATEL
- SATEL-VL53L7CX
- SATEL-VL53L8
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.2
- STM32CubeHAL L4 V1.13.4
Main changes
Product Update
| Headline |
|---|
| Add SATEL-VL53L4ED application examples |
| Add 53L4A3_MultiSensorRanging, 53L4A3_SimpleRanging and 53L4A3_ThresholdDetection application examples |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging application examples don’t support multi target detection |
| When generating projects for STM32U5, user may encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.13.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L4ED
- VL53L5CX
- VL53L7CX
- VL53L8CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L4A3
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- X-NUCLEO-53L8A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- SATEL-VL53L4ED
- VL53L5CX-SATEL
- SATEL-VL53L7CX
- SATEL-VL53L8
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.0
- STM32CubeHAL L4 V1.13.4
Main changes
Product Update
| Headline |
|---|
| Addition of the example selector |
| Updates components drivers for minor fixes |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging sample applications don’t support multi target detection |
| When generating projects for STM32U5 it is possible that you will encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.12.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L5CX
- VL53L7CX
- VL53L8CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- X-NUCLEO-53L8A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- VL53L5CX-SATEL
- SATEL-VL53L7CX
- SATEL-VL53L8
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.0
- STM32CubeHAL L4 V1.13.2
Main changes
Product Update
| Headline |
|---|
| Add SATEL-VL53L8CX example application |
| Add 53L8A1_SimpleRanging and 53L8A1_ThresholdDetection example applications |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging sample applications don’t support multi target detection |
| When generating projects for STM32U5 it is possible that you will encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.11.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L5CX
- VL53L7CX
- VL53L8CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- X-NUCLEO-53L8A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- VL53L5CX-SATEL
- SATEL-VL53L7CX
- SATEL-VL53L8
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.0
- STM32CubeHAL L4 V1.13.2
Main changes
Product Update
| Headline |
|---|
| Add SATEL-VL53L7CX example application |
| Add 53L7A1_MultiSensorRanging, 53L7A1_SimpleRanging and 53L7A1_ThresholdDetection example applications |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging sample applications don’t support multi target detection |
| When generating projects for STM32U5 it is possible that you will encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.37
- STM32CubeIDE v1.10.1
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L5CX
- VL53L7CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L5A1
- X-NUCLEO-53L7A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- VL53L5CX-SATEL
- SATEL-VL53L7CX
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.8.0
- STM32CubeHAL L4 V1.13.2
Main changes
Product Update
| Headline |
|---|
| Add SATEL-VL53L4CX example application |
| Add 53L4A2_MultiSensorRanging and 53L4A2_SimpleRanging example applications |
| Add SATEL-VL53L4CD example application |
| Add 53L4A1_MultiSensorRanging, 53L4A1_SimpleRanging and 53L4A1_ThresholdDetection example applications |
| Update EWARM project files to IAR V9.20.1 |
Contents
Projects
Known limitations
| Headline |
|---|
| The 53L4A2_MultiSensorRanging, 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging sample applications don’t support multi target detection |
| When generating projects for STM32U5 it is possible that you will encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V9.20.1
- ARM Keil V5.32
- STM32CubeIDE v1.8.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L4CD
- VL53L4CX
- VL53L5CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L4A1
- X-NUCLEO-53L4A2
- X-NUCLEO-53L5A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- SATEL-VL53L4CD
- SATEL-VL53L4CX
- VL53L5CX-SATEL
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.7.12
- STM32CubeHAL L4 V1.13.0
Main changes
Product Update
| Headline |
|---|
| Add VL53L1-SATEL example application |
| Add 53L1A2_MultiSensorRanging and 53L1A2_SimpleRanging example applications |
| Update .ioc configuration files to STM32CubeMX V6.4.0 |
| Update EWARM project files to IAR V8.50.9 |
| Update MDK-ARM project files to Keil V5.32.0 |
| Update STM32CubeIDE project files to V1.8.0 |
| Added Neutral license |
Contents
Projects
| Board | Name | readme |
|---|---|---|
| NUCLEO-F401RE | 53L1A2_MultiSensorRanging | readme.txt |
| NUCLEO-F401RE | 53L1A2_SimpleRanging | readme.txt |
| NUCLEO-F401RE | 53L3A2_MultiSensorRanging | readme.txt |
| NUCLEO-F401RE | 53L3A2_SimpleRanging | readme.txt |
| NUCLEO-F401RE | 53L5A1_MultiSensorRanging | readme.txt |
| NUCLEO-F401RE | 53L5A1_SimpleRanging | readme.txt |
| NUCLEO-F401RE | 53L5A1_ThresholdDetection | readme.txt |
| NUCLEO-F401RE | VL53L1CB_SimpleRanging | readme.txt |
| NUCLEO-F401RE | VL53L3CX_SimpleRanging | readme.txt |
| NUCLEO-F401RE | VL53L5CX_SimpleRanging | readme.txt |
| NUCLEO-L476RG | 53L1A2_MultiSensorRanging | readme.txt |
| NUCLEO-L476RG | 53L1A2_SimpleRanging | readme.txt |
| NUCLEO-L476RG | 53L3A2_MultiSensorRanging | readme.txt |
| NUCLEO-L476RG | 53L3A2_SimpleRanging | readme.txt |
| NUCLEO-L476RG | 53L5A1_MultiSensorRanging | readme.txt |
| NUCLEO-L476RG | 53L5A1_SimpleRanging | readme.txt |
| NUCLEO-L476RG | 53L5A1_ThresholdDetection | readme.txt |
| NUCLEO-L476RG | VL53L1CB_SimpleRanging | readme.txt |
| NUCLEO-L476RG | VL53L3CX_SimpleRanging | readme.txt |
| NUCLEO-L476RG | VL53L5CX_SimpleRanging | readme.txt |
Known limitations
| Headline |
|---|
| The 53L3A2_MultiSensorRanging and 53L1A2_MultiSensorRanging sample applications don’t support multi target detection |
| When generating projects for STM32U5 it is possible that you will encounter compilation errors related to missing BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN symbols in custom_bus.h. When manually adding BUS_I2C1_SDA_GPIO_PORT and BUS_I2C1_SDA_GPIO_PIN the application compiles without errors. |
Development toolchains and compilers
- IAR System Workbench V8.50.9
- ARM Keil V5.32
- STM32CubeIDE v1.8.0
Supported devices and boards
- NUCLEO-F401RE MB1136 rev.C
- NUCLEO-L476RG MB1136 rev.C
- VL53L1CB
- VL53L3CX
- VL53L5CX
- X-NUCLEO-53L1A2
- X-NUCLEO-53L3A2
- X-NUCLEO-53L5A1
- VL53L1-SATEL
- VL53L3CX-SATEL
- VL53L5CX-SATEL
Backward compatibility
N/A
Dependencies
This projects release is compatible with:
- STM32CubeHAL F4 V1.7.12
- STM32CubeHAL L4 V1.13.0