Intermediate
30 min

Easily implement LiDAR technology into your future projects with our TFmini solution and PIC32MZ1024EFH064

Your plug-and-play TFmini LiDAR solution

TFmini Click with PIC32MZ clicker

Published Sep 24, 2023

Click board™

TFmini Click

Dev. board

PIC32MZ clicker

Compiler

NECTO Studio

MCU

PIC32MZ1024EFH064

With our TFmini adapter, we've engineered a game-changing solution that empowers engineers and innovators to integrate LiDAR technology into their projects, accelerating development and unlocking new possibilities in distance measurements

A

A

Hardware Overview

How does it work?

TFmini Click is an adapter Click board™ that simplifies the interface of the TFmini LiDAR module with the host MCU. This Click board™ represents a small PCB connected to the mikroBUS™ socket like any other Click board™, with a 1x4 1.25mm pitch connector used for the TFmini LiDAR sensor connection. Each connector pin corresponds to a pin of the TFmini LiDAR sensor, allowing easy pin access and manipulation while retaining a perfect connection quality at all times. This Click board™ allows users to upgrade their projects with a sensor capable of measuring the distance to an object, where different

measurement ranges can be achieved. As with all LiDAR sensors, the effective detection distance will vary depending on lighting conditions and the reflectivity of your target object. These sensors come with an IP65 enclosure rating, 100Hz frame rate, and 70Klux ambient light immunity and are suitable for various industrial environments like pedestrian detection, vehicle testing, and altitude. TFmini Click can use both UART and I2C interfaces, with commonly used UART RX and TX pins as its default communication protocol operating at 115200bps by default configuration to transmit and exchange data with the host MCU. The selection

can be made by positioning the SMD switch labeled COMM SEL in an appropriate position. Note that all the switch positions must be on the same side, or the Click board™ may become unresponsive. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VIO SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used as a reference for further development.

TFmini Click top side image
TFmini Click bottom side image

Features overview

Development board

PIC32MZ Clicker is a compact starter development board that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit PIC32MZ microcontroller with FPU from Microchip, a USB connector, LED indicators, buttons, a mikroProg connector, and a header for interfacing with external electronics. Thanks to its compact design with clear and easy-recognizable silkscreen markings, it provides a fluid and immersive working experience, allowing access anywhere and under

any circumstances. Each part of the PIC32MZ Clicker development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the PIC32MZ Clicker programming method, using USB HID mikroBootloader, or through an external mikroProg connector for PIC, dsPIC, or PIC32 programmer, the Clicker board also includes a clean and regulated power supply module for the development kit. The USB Micro-B connection can provide up to 500mA of current, which is more than enough to operate all onboard

and additional modules. All communication methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, reset button, and several buttons and LED indicators. PIC32MZ Clicker is an integral part of the Mikroe ecosystem, allowing you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

PIC32MZ clicker double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC32

MCU Memory (KB)

1024

Silicon Vendor

Microchip

Pin count

64

RAM (Bytes)

524288

You complete me!

Accessories

TFmini Plus LiDAR sensor measures the distance to an object as close as 10 centimeters and as far as 12 meters without any problem. Besides low cost, small size, and low power consumption, TFmini Plus also improves the frame rate, uses a UART interface for communication with the MCU, introduces IP65 enclosures, and optimizes various compensation algorithms. As with all LiDAR sensors, the effective detection distance will vary depending on lighting conditions and the reflectivity of your target object, but what makes this sensor special is its size. The TFmini Plus LiDAR sensor does not use laser light for ranging. Instead, it contains an integrated LED and optics, so they are marked under the name "LiDAR." However, it may be more appropriate to consider this device as a "Time-of-Flight Infrared Rangefinder" (uses ToF to determine the range and not triangulation). This sensor can be connected to the existing TFmini Click board™ through a 1x4 1.25mm pitch connector.

TFmini Click accessories 1 image

TFmini S LiDAR sensor measures the distance to an object as close as 10 centimeters and as far as 12 meters without any problem. Besides low-cost, small-size, and low-power consumption, TFmini Plus also improves the frame rate, uses both UART and I2C interface for communication with the MCU, introduces IP65 enclosures, and optimizes various compensation algorithms. As with all LiDAR sensors, the effective detection distance will vary depending on lighting conditions and the reflectivity of your target object, but what makes this sensor special is its size. The TFmini S LiDAR sensor does not use laser light for ranging. Instead, it contains an integrated LED and optics, so they are marked under the name "LiDAR." However, it may be more appropriate to consider this device as a "Time-of-Flight Infrared Rangefinder" (uses ToF to determine the range and not triangulation). This sensor can be connected to the existing TFmini Click board™ through a 1x4 1.25mm pitch connector.

TFmini Click accessories 2 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
NC
NC
INT
UART TX
RB2
TX
UART RX
RB0
RX
I2C Clock
RD10
SCL
I2C Data
RD9
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

TFmini Click Schematic schematic

Step by step

Project assembly

PIC32MZ clicker front image hardware assembly

Start by selecting your development board and Click board™. Begin with the PIC32MZ clicker as your development board.

PIC32MZ clicker front image hardware assembly
GNSS2 Click front image hardware assembly
Prog-cut hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
Micro B Connector Clicker Access - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
Flip&Click PIC32MZ MCU step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for TFmini Click driver.

Key functions:

  • tfmini_get_firmware_version - This function reads the sensor firmware version

  • tfmini_get_measurement - This function reads the output data frame and obtains the distance, strength and temperature values from it

  • tfmini_send_frame - This function sends a command frame to the sensor

Open Source

Code example

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

/*!
 * @file main.c
 * @brief TFmini Click Example.
 *
 * # Description
 * This example demonstrates the use of TFmini click board by reading the measurements
 * from the attached TFmini-S or TFmini Plus sensors.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver and the click board, and reads the firmware version of the attached sensor.
 *
 * ## Application Task
 * Reads the target distance, signal strength and the internal sensor temperature every 100ms approximately,
 * and displays the results on the USB UART.
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "tfmini.h"

static tfmini_t tfmini;
static log_t logger;

void application_init ( void ) 
{
    log_cfg_t log_cfg;        /**< Logger config object. */
    tfmini_cfg_t tfmini_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    tfmini_cfg_setup( &tfmini_cfg );
    TFMINI_MAP_MIKROBUS( tfmini_cfg, MIKROBUS_1 );
    tfmini_drv_interface_selection ( &tfmini_cfg, TFMINI_DRV_SEL_UART );
    if ( TFMINI_OK != tfmini_init( &tfmini, &tfmini_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( TFMINI_OK != tfmini_default_cfg ( &tfmini ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    uint32_t fw_version = 0;
    if ( TFMINI_OK == tfmini_get_firmware_version ( &tfmini, &fw_version ) )
    {
        log_printf( &logger, " FW Version: 0x%.6LX\r\n", fw_version );
    }
    Delay_ms ( 1000 );
    
    log_info( &logger, " Application Task " );
}

void application_task ( void ) 
{
    int16_t distance = 0, strength = 0;
    float temperature = 0;
    if ( TFMINI_OK == tfmini_get_measurement ( &tfmini, &distance, &strength, &temperature ) ) 
    {
        log_printf( &logger, " Target distance: %d cm\r\n", distance );
        log_printf( &logger, " Signal strength: %d\r\n", strength );
        log_printf( &logger, " Sensor temperature: %.2f C\r\n\n", temperature );
    }
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

// ------------------------------------------------------------------------ END
/*!
 * @file main.c
 * @brief TFmini Click Example.
 *
 * # Description
 * This example demonstrates the use of TFmini click board by reading the measurements
 * from the attached TFmini-S or TFmini Plus sensors.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver and the click board, and reads the firmware version of the attached sensor.
 *
 * ## Application Task
 * Reads the target distance, signal strength and the internal sensor temperature every 100ms approximately,
 * and displays the results on the USB UART.
 *
 * @author Stefan Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "tfmini.h"

static tfmini_t tfmini;
static log_t logger;

void application_init ( void ) 
{
    log_cfg_t log_cfg;        /**< Logger config object. */
    tfmini_cfg_t tfmini_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    tfmini_cfg_setup( &tfmini_cfg );
    TFMINI_MAP_MIKROBUS( tfmini_cfg, MIKROBUS_1 );
    tfmini_drv_interface_selection ( &tfmini_cfg, TFMINI_DRV_SEL_UART );
    if ( TFMINI_OK != tfmini_init( &tfmini, &tfmini_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( TFMINI_OK != tfmini_default_cfg ( &tfmini ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    uint32_t fw_version = 0;
    if ( TFMINI_OK == tfmini_get_firmware_version ( &tfmini, &fw_version ) )
    {
        log_printf( &logger, " FW Version: 0x%.6LX\r\n", fw_version );
    }
    Delay_ms ( 1000 );
    
    log_info( &logger, " Application Task " );
}

void application_task ( void ) 
{
    int16_t distance = 0, strength = 0;
    float temperature = 0;
    if ( TFMINI_OK == tfmini_get_measurement ( &tfmini, &distance, &strength, &temperature ) ) 
    {
        log_printf( &logger, " Target distance: %d cm\r\n", distance );
        log_printf( &logger, " Signal strength: %d\r\n", strength );
        log_printf( &logger, " Sensor temperature: %.2f C\r\n\n", temperature );
    }
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.