Explore the endless potential of proximity detection with TMD3719 and PIC18F97J60
Proximity sensing: Creating smarter and safer environments
Published Oct 17, 2023
Click board™
Proximity 12 Click
Dev. board
UNI Clicker
Compiler
NECTO Studio
MCU
PIC18F97J60
With proximity detection, we're unlocking the doors to a world where automation and personalization combine to enhance every moment
A
A
Hardware Overview
How does it work?
Proximity 12 Click is based on the TMD3719, an optical sensor that integrates ambient light sensing, proximity detection, and flicker detection sensing from ams OSRAM. The ambient light and color sensing function provide six concurrent ambient light sensing channels: Red, Green, Blue, Clear, Leakage, and Wideband, which accurately measure ambient light and calculate illuminance, chromaticity, and color temperature. The TMD3719 also integrates direct detection of ambient light flicker for four selectable frequency bins, executed parallel with ambient light and color sensing. The proximity function synchronizes IR emission and detection to sense nearby objects. This function features self-maximizing dynamic range, ambient light subtraction, and advanced cross-talk cancelation. The proximity engine recognizes
detect/release events and produces a configurable interrupt, routed to the INT pin of the mikroBUS™ socket, whenever the proximity result crosses upper or lower threshold settings. Proximity 12 Click communicates with MCU using the standard I2C 2-Wire interface with a maximum clock frequency of up to 400kHz. In addition to I2C communication, several GPIO pins connected to the mikroBUS™ socket pins are also used. The SYN pin, routed to the CS pin of the mikroBUS™ socket, is used to synchronize data and allows the start of the classic ambient light, proximity sensing, and flicker detection with every new SYN signal instead of immediately. It also has two pins labeled GP1 and GP2, routed on the RST and PWM pins of the mikroBUS™ socket, used as general-purpose pins, more precisely, GP1 as open-drain
general-purpose input/output and GP2 only as an input pin. The TMD3719 requires a supply voltage of 1.8V to work correctly. Therefore, a small regulating LDO, the BH18PB1WHFV from Rohm Semiconductor, provides a 1.8V out of 3.3V mikroBUS™ rail. The LDO cuts power consumption by lowering its current consumption to approximately 2μA when the application operates in the Standby state. This Click board™ can be operated only with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. Also, it comes equipped with a library containing functions and an example code that can be used as a reference for further development.
Features overview
Development board
UNI Clicker is a compact development board designed as a complete solution that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It supports a wide range of microcontrollers, such as different ARM, PIC32, dsPIC, PIC, and AVR from various vendors like Microchip, ST, NXP, and TI (regardless of their number of pins), four mikroBUS™ sockets for Click board™ connectivity, a USB connector, LED indicators, buttons, a debugger/programmer connector, and two 26-pin headers for interfacing with external electronics. Thanks to innovative manufacturing technology, it allows you to build
gadgets with unique functionalities and features quickly. Each part of the UNI Clicker development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the UNI Clicker programming method, using a third-party programmer or CODEGRIP/mikroProg connected to onboard JTAG/SWD header, the UNI Clicker board also includes a clean and regulated power supply module for the development kit. It provides two ways of board-powering; through the USB Type-C (USB-C) connector, where onboard voltage regulators provide the appropriate voltage levels to each component on the board, or using a Li-Po/Li
Ion battery via an onboard battery connector. All communication methods that mikroBUS™ itself supports are on this board (plus USB HOST/DEVICE), including the well-established mikroBUS™ socket, a standardized socket for the MCU card (SiBRAIN standard), and several user-configurable buttons and LED indicators. UNI 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.
Microcontroller Overview
MCU Card / MCU
Type
8th Generation
Architecture
PIC
MCU Memory (KB)
128
Silicon Vendor
Microchip
Pin count
100
RAM (Bytes)
3808
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 UNI Clicker 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 12 Click driver.
Key functions:
proximity12_read_proximity- This function reads the raw proximity value measured by the click board.proximity12_read_als- This function reads all als data measured by the click board.proximity12_set_led_isink- This function sets the LEDs sink scaler and current values.
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 Proximity12 Click example
*
* # Description
* This function demonstrates the use of Proximity 12 click board.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and performs the click default configuration.
*
* ## Application Task
* Reads the proximity and ALS values and displays the results on the USB UART
* approximately every 100ms.
*
* @author Stefan Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "proximity12.h"
static proximity12_t proximity12;
static log_t logger;
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
proximity12_cfg_t proximity12_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 );
Delay_ms( 100 );
log_info( &logger, " Application Init " );
// Click initialization.
proximity12_cfg_setup( &proximity12_cfg );
PROXIMITY12_MAP_MIKROBUS( proximity12_cfg, MIKROBUS_1 );
err_t init_flag = proximity12_init( &proximity12, &proximity12_cfg );
if ( I2C_MASTER_ERROR == init_flag )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
Delay_ms( 100 );
init_flag = proximity12_default_cfg ( &proximity12 );
if ( PROXIMITY12_ERROR == init_flag )
{
log_error( &logger, " Default Cfg Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
uint16_t prox_data = 0;
proximity12_als_data_t als;
err_t error_flag = proximity12_read_proximity ( &proximity12, &prox_data );
error_flag |= proximity12_read_als ( &proximity12, &als );
if ( PROXIMITY12_OK == error_flag )
{
log_printf( &logger, " - Proximity data -\r\n" );
log_printf( &logger, " Proximity: %u\r\n", prox_data );
log_printf( &logger, " - ALS data -\r\n" );
log_printf( &logger, " Clear: %lu - Red: %lu - Green: %lu - Blue: %lu\r\n", als.clear,
als.red,
als.green,
als.blue );
log_printf( &logger, " Leakage: %lu - Wideband: %lu - IR1: %lu - IR2: %lu\r\n\r\n", als.leakage,
als.wideband,
als.ir1,
als.ir2 );
}
Delay_ms( 100 );
}
void main ( void )
{
application_init( );
for ( ; ; )
{
application_task( );
}
}
// ------------------------------------------------------------------------ END
