color9 2.0.0.0
Main Page

Color 9 click

Color 9 Click is a very accurate color sensing Click board� which features the APDS-9250, IR and ambient light sensor, from Broadcom. It contains a specially designed matrix of photosensitive elements, which can sense red, green, blue and IR component.

click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Color9 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

‍This library contains API for Color9 Click driver.

Standard key functions :

  • Config Object Initialization function.

    ‍void color9_cfg_setup ( color9_cfg_t *cfg );

    - Initialization function.

    ‍COLOR9_RETVAL color9_init ( color9_t *ctx, color9_cfg_t *cfg );

    Example key functions :

  • This function gets Green measurement reading.

    ‍uint32_t color9_get_green ( color9_t* ctx );

    - This function gets Blue measurement reading.

    ‍uint32_t color9_get_blue ( color9_t* ctx );

  • This function gets Red measurement reading.

    ‍uint32_t color9_get_red ( color9_t* ctx );

    Examples Description

‍ This example reads data from the sensor, and then logs IR, green, blue and red measurements.

The demo application is composed of two sections :

Application Init

‍Initialize the driver and test if the sensor is present. If the ID read from the sensor is correct execute the initialization procedure.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
COLOR9_MAP_MIKROBUS( cfg, MIKROBUS_1 );
color9_init( &color9, &cfg );
ID = color9_read( &color9, COLOR9_PART_ID );
if ( ID == 0xB2 )
{
log_printf( &logger, "Register ID 0x%x\r\n", ID );
}
else
{
log_printf( &logger, "Error\r\n" );
while ( 1 );
}
}
#define COLOR9_LS_MEAS_RATE_1000ms
Definition color9.h:118
#define COLOR9_LS_MEAS_BITWIDTH_13
Definition color9.h:111
#define COLOR9_PART_ID
Definition color9.h:67
#define COLOR9_MAIN_CTRL_CS_MODE
Definition color9.h:97
#define COLOR9_MAIN_CTRL_LS_EN
Definition color9.h:98
#define COLOR9_MAP_MIKROBUS(cfg, mikrobus)
Definition color9.h:171
void color9_cfg_setup(color9_cfg_t *cfg)
Config Object Initialization function.
void color9_reg_ctrl(color9_t *ctx, uint8_t cfg)
Function for setting the main configuration register.
COLOR9_RETVAL color9_init(color9_t *ctx, color9_cfg_t *cfg)
Initialization function.
uint8_t color9_read(color9_t *ctx, uint8_t reg_addr)
Generic read function.
void color9_meas_rate(color9_t *ctx, uint8_t resolution, uint8_t meas_rate)
Configure measurement rates.
void application_init(void)
Definition main.c:37
Click configuration structure definition.
Definition color9.h:215

Application Task

‍Wait for the color data to be available then read the data and send it to the serial port.

void application_task ( void )
{
conv_complete = color9_get_status_reg( &color9 );
if ( conv_complete & 0x08 )
{
conv_complete = 0;
measurement_data = color9_get_Ir( &color9 );
log_printf( &logger, "Ir: %d\r\n", measurement_data );
measurement_data = color9_get_green( &color9 );
log_printf(&logger, "Green: %d\r\n", measurement_data);
measurement_data = color9_get_blue( &color9 );
log_printf(&logger, "Blue: %d\r\n", measurement_data);
measurement_data = color9_get_red( &color9 );
log_printf(&logger, "Red: %d\r\n", measurement_data);
}
}
uint32_t color9_get_red(color9_t *ctx)
Gets value of Red measurement reading.
uint32_t color9_get_green(color9_t *ctx)
Gets value of Green measurement reading.
uint32_t color9_get_blue(color9_t *ctx)
Gets value of Blue measurement reading.
uint8_t color9_get_status_reg(color9_t *ctx)
Status register value.
uint32_t color9_get_Ir(color9_t *ctx)
Get value of IR measurement reading.
void application_task(void)
Definition main.c:78

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Color9

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.