Repository Summary
Description | API for the AFBR-S50 Time-Of-Flight Sensor Family. |
Checkout URI | https://github.com/broadcom/afbr-s50-api.git |
VCS Type | git |
VCS Version | main |
Last Updated | 2025-06-24 |
Dev Status | UNKNOWN |
Released | UNRELEASED |
Tags | No category tags. |
Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
Name | Version |
---|---|
pointcloud_tof | 0.0.0 |
raw_tof | 0.0.0 |
pointcloud | 0.0.0 |
serial | 1.2.1 |
README
AFBR-S50 API
Introduction
The AFBR-S50 API is the appertaining software for the AFBR-S50 Time-of-Flight Sensor family by Broadcom Inc.
The repository consists of the AFBR-S50 Core Library, a static ANSI-C library, and its accompanied header files and documentation. Additionally, example and demo projects are provided for certain processors and evaluation boards.
Documentation
The API Reference Manual can be viewed here.
Overview
File Structure
The repository is structured in the following way:
-
/AFBR-S50
: Contains the AFBR-S50 API.-
/Include
: Contains the AFBR-S50 API as ANSI-C header files. -
/Lib
: Contains the static AFBR-S50 Core Libraries for multiple Cortex-Mx architectures. -
/Test
: The HAL-Self Test suite that can be used to verify the ported HAL.
-
-
/Doxygen
: Contains additional documentation files that can be used with Doxygen to generate the API Reference Manual. -
/Projects
: Project files for several IDEs.-
/e2Studio
: Project files for the Renesas e² Studio IDE for all Renesas processors. -
/MCUXpressoIDE
: Project files for the NXP MCUXpresso IDE for all NXP processors. -
/STM32CubeIDE
: Project files for the STM32Cube IDE for all STM32 processors.
-
-
/Sources
: Contains all source files.-
/CANApp
: A CAN-Bus interface application running on the AFBR-S50 Reference Board by MikroElektronika. It listens to commands and streams 1D range values on the CAN-bus. -
/ExampleApp
: A collection of basic example applications that demonstrate the usage of the AFBR-S50 API and stream measurement data via an UART connection. -
/ExplorerApp
: A more sophisticated example application that implements a serial communication interface via USB or UART to connect to the corresponding AFBR-S50 Explorer GUI (download via the Software Development Kit from the official Broadcom webpage). -
/Platform
: The platform specific code like peripheral drivers or hardware abstraction layers (HAL).-
/NXP_MKLxxZ
: The platform code for the NXP Kinetis L-Series processors (e.g. MKL46z which is used by the AFBR-S50 Evaluation Kits). -
/Renesas_RA4M2
: The platform code for the Renesas RA4M2 series which is used for the AFBR-S50 Reference Board by MikroElektronika. -
/STM32F4xx
: The platform code for the STM32F4 Series (e.g. STM32F401RE).
-
-
Projects
All projects are located under /Projects/<IDE>/<PROJECT>
. The following
projects are available:
-
AFBR_S50_Example_<MCU>
: A simple example application that streams measurement data via an UART connection. -
AFBR_S50_ExplorerApp_<MCU>
: A more sophisticated example application that implements a serial communication interface via USB or UART to connect to the corresponding AFBR-S50 Explorer GUI (download from the official
File truncated at 100 lines see the full file