These are basic demo applications that serve as starting point for the customers own implementation. The example applications are kept simple and are documented well within the source code in order to make it easy to follow and understand their purpose. Each example application shows different use cases of the AFBR-S50 API. The following apps are currently implemented:

The Simple Example demonstrates the most basic usage of the API. It triggers new measurement cycles from the main thread.
The Advanced Example demonstrates a more advanced usage of the API. It leverages from the periodic interrupt timer (PIT) module and triggers measurements from a periodic interrupt service routine outside of the scope of the main thread.
The High-Speed Example demonstration the high-framerate measurement modes of the AFBR-S50 API. Note that adequate hardware is required to achieve really high measurement rates.
The Multi-Device Example demonstration of the usage of multiple devices from a single MCU. Note that adequate hardware is required to talk to multiple devices.

Note: All examples are combined into a single project (AFBR_S50_Example_<TARGET>) per IDE. In order to select a certain example, go to the example.h (within Project > App > examples > example.h) and select the specific example by setting the API_EXAMPLE preprocessor definition. Also note that the HAL Self Test and the Crosstalk Calibration CLI can be enabled/disabled here.

Note: Usually, the first slave (SPI_SLAVE = 1) identifier is used for all current evaluation or reference boards. Only some deprecated evaluation boards may use the fifth (SPI_SLAVE = 5) SPI slave which needs to be set manually in the example.h (within Project > App > examples > example.h) file by changing the SPI_SLAVE preprocessor definition accordingly.

Simple Example

The Simple Example demonstrates the most basic usage of the API. It triggers new measurement cycles from the main thread.

The API calls the Argus_TriggerMeasurement method in the main thread loop in order to invoke another measurement cycle. The code is polling the module status to wait for the measurement data to be ready. Once a new raw measurement data set is ready, the Argus_EvaluateData method is called to obtain meaningful values like range and signal quality. The data values of the measurement cycle is streamed via an UART connection.

In order to observe the values, open a connection via a terminal (e.g. Termite). Setup the connection using 115200 bps, 8N1, no handshake:

Baud rate	Data Bits	Stop Bits	Parity	Flow Control
115200 bps	8	1	none	none

Range values will start to occur on the terminal as soon as the program starts its execution.

Note that the project will provide additional information via the serial stream upon program initialization. Especially the HAL Self Test might be executed optionally in oder to verify the current HAL implementation.

In order to get started with the project, please read the Build And Run Projects section.

The example source files are located in Sources/ExampleApp. The actual example must be configured using the preprocessor constants in the main file. Refer the documentation in the source code for more information.

The example projects are located in Project/<IDE>/AFBR_S50_Example_<MCU>, depending on your target. The following target/IDE combinations are provided:

MCU	IDE	Path	Comment
NXP MKL46z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL46z`	Runs on FRDM-KL46Z evaluation board by NXP
NXP MKL17z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL17z`
STM32 F401RE	STM32CubeIDE	`Projects/STM32CubeIDE/AFBR_S50_Example_F401RE`	Runs on NUCLEO-F401RE evaluation board by STM
Renesas RA4M2	e² Studio	`Projects/e2studio/AFBR_S50_Example_RA4M2`	Runs on AFBR-S50 Reference Board by MikroElektronika

See also Build And Run Projects for an overview of featured boards/MCUs/IDEs.

01_simple_example.c

Advanced Example

The Advanced Example demonstrates a more advanced usage of the API. It triggers new measurement cycles from a periodic interrupt autonomously.

The API calls the Argus_StartMeasurementTimer method once upon initialization from the main thread in order to start autonomous measurement cycles. This required the optional Periodic Interrupt Timer (PIT) (see the timer HAL interface) periodically from its interrupt service routine.

The main thread loop is idle until the measurement data ready callback is invoked. Once a new raw measurement data set is ready, the Argus_EvaluateData method is called to obtain meaningful values like range and signal quality. The data values of the measurement cycle is streamed via an UART connection.

In order to observe the values, open a connection via a terminal (e.g. Termite). Setup the connection using 115200 bps, 8N1, no handshake:

Baud rate	Data Bits	Stop Bits	Parity	Flow Control
115200 bps	8	1	none	none

Range values will start to occur on the terminal as soon as the program starts its execution.

Note that the project will provide additional information via the serial stream upon program initialization. Especially the HAL Self Test might be executed optionally in oder to verify the current HAL implementation.

In order to get started with the project, please read the Build And Run Projects section.

The example source files are located in Sources/ExampleApp. The actual example must be configured using the preprocessor constants in the main file. Refer the documentation in the source code for more information.

The example projects are located in Project/<IDE>/AFBR_S50_Example_<MCU>, depending on your target. The following target/IDE combinations are provided:

MCU	IDE	Path	Comment
NXP MKL46z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL46z`	Runs on FRDM-KL46Z evaluation board by NXP
NXP MKL17z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL17z`
STM32 F401RE	STM32CubeIDE	`Projects/STM32CubeIDE/AFBR_S50_Example_F401RE`	Runs on NUCLEO-F401RE evaluation board by STM
Renesas RA4M2	e² Studio	`Projects/e2studio/AFBR_S50_Example_RA4M2`	Runs on AFBR-S50 Reference Board by MikroElektronika

See also Build And Run Projects for an overview of featured boards/MCUs/IDEs.

02_advanced_example.c

High-Speed Example

The High-Speed Example demonstrates the fast measurement capabilities of the API. It is based in the Advanced Example and utilizes the AFBR-S50 configuration API to achieve up to 1000 measurements-per-second.

These configuration parameters needs to be changed to prepare the device for High-Speed Mode:

Feature	Value	API Call	Comment
Dual-Frequency Mode (DFM)	disabled	Argus_SetConfigurationDFMMode	See also Dual Frequency Mode for more information on the DFM feature.
Smart-Power-Save (SPS)	disabled	Argus_SetConfigurationSmartPowerSaveEnabled
Frame Rate (Frame Time)	1 ms/frame	Argus_SetConfigurationFrameTime	Frame Rate is actually set in Frame Time which is the inverse value.

In additional to the changes above, the print_results method in the main.c file is stripped down to the essential values, which are the time elapsed since the previous frame in milliseconds and the range value in millimeter. If more data is sent via UART, the baud rate of the UART must be increased in order to prevent the UART from slowing down the program flow and thus the measurement execution.

In order to observe the values, open a connection via a terminal (e.g. Termite). Setup the connection using 115200 bps, 8N1, no handshake:

Baud rate	Data Bits	Stop Bits	Parity	Flow Control
115200 bps	8	1	none	none

Range values will start to occur on the terminal as soon as the program starts its execution.

Note that the project will provide additional information via the serial stream upon program initialization. Especially the HAL Self Test might be executed optionally in oder to verify the current HAL implementation.

In order to get started with the project, please read the Build And Run Projects section.

The example source files are located in Sources/ExampleApp. The actual example must be configured using the preprocessor constants in the main file. Refer the documentation in the source code for more information.

The example projects are located in Project/<IDE>/AFBR_S50_Example_<MCU>, depending on your target. The following target/IDE combinations are provided:

MCU	IDE	Path	Comment
NXP MKL46z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL46z`	Runs on FRDM-KL46Z evaluation board by NXP
NXP MKL17z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL17z`
STM32 F401RE	STM32CubeIDE	`Projects/STM32CubeIDE/AFBR_S50_Example_F401RE`	Runs on NUCLEO-F401RE evaluation board by STM
Renesas RA4M2	e² Studio	`Projects/e2studio/AFBR_S50_Example_RA4M2`	Runs on AFBR-S50 Reference Board by MikroElektronika

See also Build And Run Projects for an overview of featured boards/MCUs/IDEs.

03_high_speed_example.c

Multi-Device Example

The Multi-Device Example demonstrates how to use multiple device per microcontroller. An new instance of the API (just like in OOP) is created for each tine-of-flight sensor present. The main thread triggers measurement cycle alternatively on each device in a round robbin manner.

The example is based on the Simple Example and triggers each device individually with a call to Argus_TriggerMeasurement in a simple nested loop.

The code is polling the module status to wait for the measurement data to be ready. Once a new raw measurement data set is ready, the Argus_EvaluateData method is called for the current instance to obtain meaningful values like range and signal quality. The data values of the current device are streamed via an UART connection.

In order to observe the values, open a connection via a terminal (e.g. Termite). Setup the connection using 115200 bps, 8N1, no handshake:

Baud rate	Data Bits	Stop Bits	Parity	Flow Control
115200 bps	8	1	none	none

Range values will start to occur on the terminal as soon as the program starts its execution.

Note that the project will provide additional information via the serial stream upon program initialization. Especially the HAL Self Test might be executed optionally for each instance in oder to verify the current HAL implementation.

In order to get started with the project, please read the Build And Run Projects section.

The example source files are located in Sources/ExampleApp. The actual example must be configured using the preprocessor constants in the main file. Refer the documentation in the source code for more information.

The example projects are located in Project/<IDE>/AFBR_S50_Example_<MCU>, depending on your target. The following target/IDE combinations are provided:

MCU	IDE	Path	Comment
NXP MKL46z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL46z`	Runs on FRDM-KL46Z evaluation board by NXP
NXP MKL17z	MCUXpressoIDE	`Projects/MCUXpressoIDE/AFBR_S50_Example_KL17z`
STM32 F401RE	STM32CubeIDE	`Projects/STM32CubeIDE/AFBR_S50_Example_F401RE`	Runs on NUCLEO-F401RE evaluation board by STM
Renesas RA4M2	e² Studio	`Projects/e2studio/AFBR_S50_Example_RA4M2`	Runs on AFBR-S50 Reference Board by MikroElektronika

See also Build And Run Projects for an overview of featured boards/MCUs/IDEs.

04_multi_device_example.c