Public function

Functions
void	color10_cfg_setup (color10_cfg_t *cfg)
	Config Object Initialization function.
COLOR10_RETVAL	color10_init (color10_t *ctx, color10_cfg_t *cfg)
	Initialization function.
void	color10_generic_write (color10_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
uint16_t	color10_generic_read (color10_t *ctx, uint8_t cmd_addr)
	Generic read function.
void	color10_config (color10_t *ctx, uint16_t cfg_data)
	Configuration function.
uint8_t	color10_get_id (color10_t *ctx)
	ID retrieval function.
float	color10_read_color_ratio (color10_t *ctx, uint8_t color_cmd_reg)
	Color ratio function.
float	color10_get_color_value (color10_t *ctx)
	Color value function.
uint8_t	color10_get_color (float color_value)
	Color retrieval function.

Detailed Description

Function Documentation

color10_cfg_setup()

void color10_cfg_setup

(

color10_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

color10_config()

void color10_config	(	color10_t *	ctx,
		uint16_t	cfg_data )

Configuration function.

Parameters

ctx	Click object.
cfg_data	Configuration data.

@description This function configures the click according to the config data.

color10_generic_read()

uint16_t color10_generic_read	(	color10_t *	ctx,
		uint8_t	cmd_addr )

Generic read function.

Parameters

ctx	Click object.
cmd_addr	Command address.

Returns

Data read from given address.

@description This function reads data from the desired register.

color10_generic_write()

void color10_generic_write	(	color10_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

color10_get_color()

uint8_t color10_get_color

(

float

color_value

)

Color retrieval function.

Parameters

color_value

Color value

Returns

Color ID macro

@description This function identifies the color using the color value.

color10_get_color_value()

float color10_get_color_value

(

color10_t *

ctx

)

Color value function.

Parameters

ctx	Click object.

Returns

Color value.

@description This function calculates the color value.

color10_get_id()

uint8_t color10_get_id

(

color10_t *

ctx

)

ID retrieval function.

Parameters

ctx	Click object.

Returns

ID

@description This function returns the ID.

color10_init()

COLOR10_RETVAL color10_init	(	color10_t *	ctx,
		color10_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

color10_read_color_ratio()

float color10_read_color_ratio	(	color10_t *	ctx,
		uint8_t	color_cmd_reg )

Color ratio function.

Parameters

ctx	Click object.
color_cmd_reg	Color command register.

Returns

Color ratio

@description This function reads the color ratio from given register.