color4  2.1.0.0
Main Page

Color 4 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Nenad Filipovic
  • Date : Dec 2022.
  • Type : I2C type

Software Support

We provide a library for the Color 4 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Color 4 Click driver.

Standard key functions :

Example key functions :

Example Description

This library contains API for the Color 4 Click driver. This driver provides the functions for the sensor configuration and for reading RGBW and ambient light data from the device. This example displays RGBW data, Ambient light level, CCT data and the light color names.

The demo application is composed of two sections :

Application Init

Initialization of I2C module and log UART. After driver initialization, default settings turn on the device.

void application_init ( void )
{
log_cfg_t log_cfg;
color4_cfg_t color4_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
color4_cfg_setup( &color4_cfg );
COLOR4_MAP_MIKROBUS( color4_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == color4_init( &color4, &color4_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( COLOR4_ERROR == color4_default_cfg ( &color4 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
log_printf( &logger, " ----------------------\r\n" );
Delay_ms( 100 );
}

Application Task

This example demonstrates the use of the Color 4 Click board™. Reads and displays the results of the RGBW, Ambient light level, calculate the correlated color temperature. This example also detects and displays the light color names. Results are being sent to the UART Terminal, where you can track their changes.

void application_task ( void )
{
if ( COLOR4_OK == color4_get_color_data( &color4, COLOR4_RED, &red_data ) )
{
log_printf( &logger, " Red: %u\r\n", red_data );
}
if ( COLOR4_OK == color4_get_color_data( &color4, COLOR4_GREEN, &green_data ) )
{
log_printf( &logger, " Green: %u\r\n", green_data );
}
if ( COLOR4_OK == color4_get_color_data( &color4, COLOR4_BLUE, &blue_data ) )
{
log_printf( &logger, " Blue: %u\r\n", blue_data );
}
if ( COLOR4_OK == color4_get_color_data( &color4, COLOR4_WHITE, &white_data ) )
{
log_printf( &logger, " White: %u\r\n", white_data );
}
log_printf( &logger, " - - - - - - - - - - - \r\n" );
if ( COLOR4_OK == color4_get_ambient_light( &color4, &ambient_light ) )
{
log_printf( &logger, " ALS lux level: %.2f\r\n", ambient_light );
}
if ( COLOR4_OK == color4_get_cct( &color4, &cct ) )
{
log_printf( &logger, " CCT: %.2f\r\n", cct );
}
log_printf( &logger, " - - - - - - - - - - - \r\n" );
log_printf( &logger, " ----------------------\r\n" );
Delay_ms( 1000 );
}

Note

Color detection is obtained based on the analysis of calculate the correlated color temperature (CCT) data and the CIE 1931 chromaticity diagram. For more details please refer to the “Designing the VEML6040 into an Application” application note (www.vishay.com/doc?84331).

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Color4

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


COLOR4_RED
@ COLOR4_RED
Definition: color4.h:179
color4_cfg_t
Color 4 Click configuration object.
Definition: color4.h:153
color4_default_cfg
err_t color4_default_cfg(color4_t *ctx)
Color 4 default configuration function.
color4_init
err_t color4_init(color4_t *ctx, color4_cfg_t *cfg)
Color 4 initialization function.
color4_ch_color_t
color4_ch_color_t
Color 4 Click channel selection value data.
Definition: color4.h:178
application_task
void application_task(void)
Definition: main.c:137
COLOR4_MAP_MIKROBUS
#define COLOR4_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: color4.h:125
color4_get_color_data
err_t color4_get_color_data(color4_t *ctx, color4_ch_color_t ch_color, uint16_t *color_data)
Color 4 get color data function.
COLOR4_WHITE
@ COLOR4_WHITE
Definition: color4.h:182
color4_cfg_setup
void color4_cfg_setup(color4_cfg_t *cfg)
Color 4 configuration object setup function.
COLOR4_ERROR
@ COLOR4_ERROR
Definition: color4.h:169
display_color
void display_color(void)
Definition: main.c:55
color4_set_config
err_t color4_set_config(color4_t *ctx, color4_config_t config)
Color 4 set configuration function.
COLOR4_GREEN
@ COLOR4_GREEN
Definition: color4.h:180
color4_config_t
Color 4 Click sensor configuration object.
Definition: color4.h:191
color4_t
Color 4 Click context object.
Definition: color4.h:137
application_init
void application_init(void)
Definition: main.c:99
COLOR4_BLUE
@ COLOR4_BLUE
Definition: color4.h:181
color4_get_cct
err_t color4_get_cct(color4_t *ctx, float *cct)
Color 4 get CCT data function.
color4_get_ambient_light
err_t color4_get_ambient_light(color4_t *ctx, float *ambient_light)
Color 4 get ambient light level function.
COLOR4_OK
@ COLOR4_OK
Definition: color4.h:168