Achieve advanced proximity measurement with TMD2635 and STM32F031K6
The dynamic duo for detecting your presence!
Published Oct 01, 2024
Click board™
Proximity 17 Click
Dev. board
Nucleo 32 with STM32F031K6 MCU
Compiler
NECTO Studio
MCU
STM32F031K6
Experience seamless and accurate detection of nearby objects with our state-of-the-art proximity solution, designed to enhance performance and safety in various applications
A
A
Hardware Overview
How does it work?
Proximity 17 Click is based on the TMD2635, a miniature close-range proximity sensor module from ams AG. The TMD2635 implements a 940nm infrared VCSEL (Vertical Cavity Surface Emitting Laser) factory calibrated for IR proximity response alongside a digital I2C serial interface. The proximity detection feature provides object detection (e.g., close proximity) by photodiode detection of reflected IR energy sourced by the integrated VCSEL emitter. The proximity engine also features a wide range offset adjustment to compensate for unwanted IR energy reflection at the sensor. The results are further improved by automatic ambient light subtraction. The TMD2635 does not require a specific Power-Up sequence but requires a supply
voltage of 1.8V to work correctly. Therefore, a small regulating LDO, the MAX8511, provides a 1.8V out of selected mikroBUS™ power rail. Also, it can be shut down through software with a low standby current, allowing the power rails to remain powered at all times. Proximity 17 Click communicates with MCU using the standard I2C 2-Wire interface with a maximum clock frequency of 400kHz, fully adjustable through software registers with a 14-bit proximity result stored in a PDATA register. Since the sensor for operation requires a power supply of 1.8V, this Click board™ also features the PCA9306 and SN74LVC1T45 voltage-level translators. The I2C interface bus lines are routed to the voltage-level translators allowing this Click board™
to work with both 3.3V and 5V MCUs properly. Also, it uses an interrupt pin, the INT pin of the mikroBUS™ socket, used when an interrupt occurs to alert the system when proximity result crosses upper or lower threshold settings. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. However, the 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.
Features overview
Development board
Nucleo 32 with STM32F031K6 MCU board provides an affordable and flexible platform for experimenting with STM32 microcontrollers in 32-pin packages. Featuring Arduino™ Nano connectivity, it allows easy expansion with specialized shields, while being mbed-enabled for seamless integration with online resources. The
board includes an on-board ST-LINK/V2-1 debugger/programmer, supporting USB reenumeration with three interfaces: Virtual Com port, mass storage, and debug port. It offers a flexible power supply through either USB VBUS or an external source. Additionally, it includes three LEDs (LD1 for USB communication, LD2 for power,
and LD3 as a user LED) and a reset push button. The STM32 Nucleo-32 board is supported by various Integrated Development Environments (IDEs) such as IAR™, Keil®, and GCC-based IDEs like AC6 SW4STM32, making it a versatile tool for developers.
Microcontroller Overview
MCU Card / MCU
Architecture
ARM Cortex-M0
MCU Memory (KB)
32
Silicon Vendor
STMicroelectronics
Pin count
32
RAM (Bytes)
4096
You complete me!
Accessories
Click Shield for Nucleo-32 is the perfect way to expand your development board's functionalities with STM32 Nucleo-32 pinout. The Click Shield for Nucleo-32 provides two mikroBUS™ sockets to add any functionality from our ever-growing range of Click boards™. We are fully stocked with everything, from sensors and WiFi transceivers to motor control and audio amplifiers. The Click Shield for Nucleo-32 is compatible with the STM32 Nucleo-32 board, providing an affordable and flexible way for users to try out new ideas and quickly create prototypes with any STM32 microcontrollers, choosing from the various combinations of performance, power consumption, and features. The STM32 Nucleo-32 boards do not require any separate probe as they integrate the ST-LINK/V2-1 debugger/programmer and come with the STM32 comprehensive software HAL library and various packaged software examples. This development platform provides users with an effortless and common way to combine the STM32 Nucleo-32 footprint compatible board with their favorite Click boards™ in their upcoming projects.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Start by selecting your development board and Click board™. Begin with the Nucleo 32 with STM32F031K6 MCU as your development board.
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 Proximity 17 Click driver.
Key functions:
proximity17_get_int_pinThis function returns the INT pin logic state.proximity17_read_proximityThis function reads the raw proximity data. The higher the value, the closer the detected object is.proximity17_soft_resetThis function executes the device software reset command.
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 Proximity17 Click example
*
* # Description
* This example demonstrates the use of Proximity 17 Click board by reading and
* displaying the proximity data on the USB UART.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and logger, and performs the Click default configuration.
*
* ## Application Task
* Reads the proximity data and displays it on the USB UART approximately once per second.
* The higher the proximity value, the closer the detected object is.
*
* @author Stefan Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "proximity17.h"
static proximity17_t proximity17;
static log_t logger;
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
proximity17_cfg_t proximity17_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.
proximity17_cfg_setup( &proximity17_cfg );
PROXIMITY17_MAP_MIKROBUS( proximity17_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == proximity17_init( &proximity17, &proximity17_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( PROXIMITY17_ERROR == proximity17_default_cfg ( &proximity17 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
uint16_t proximity;
if ( PROXIMITY17_OK == proximity17_read_proximity ( &proximity17, &proximity ) )
{
log_printf ( &logger, " Proximity: %u\r\n\n", proximity );
Delay_ms ( 1000 );
}
}
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
