This file contains API for Color 16 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Data Structures
struct	color16_data_t
	Color 16 Click data object. More...

struct	color16_t
	Color 16 Click context object. More...

struct	color16_cfg_t
	Color 16 Click configuration object. More...

Macros
#define	COLOR16_REG_AUXID 0x58
	Color 16 register list.

#define	COLOR16_REG_REVID 0x59

#define	COLOR16_REG_ID 0x5A

#define	COLOR16_REG_CFG_12 0x66

#define	COLOR16_REG_ENABLE 0x80

#define	COLOR16_REG_ATIME 0x81

#define	COLOR16_REG_WTIME 0x83

#define	COLOR16_REG_SP_TH_L_LSB 0x84

#define	COLOR16_REG_SP_TH_L_MSB 0x85

#define	COLOR16_REG_SP_TH_H_LSB 0x86

#define	COLOR16_REG_SP_TH_H_MSB 0x87

#define	COLOR16_REG_STATUS 0x93

#define	COLOR16_REG_ASTATUS 0x94

#define	COLOR16_REG_DATA_0_L 0x95

#define	COLOR16_REG_DATA_0_H 0x96

#define	COLOR16_REG_DATA_1_L 0x97

#define	COLOR16_REG_DATA_1_H 0x98

#define	COLOR16_REG_DATA_2_L 0x99

#define	COLOR16_REG_DATA_2_H 0x9A

#define	COLOR16_REG_DATA_3_L 0x9B

#define	COLOR16_REG_DATA_3_H 0x9C

#define	COLOR16_REG_DATA_4_L 0x9D

#define	COLOR16_REG_DATA_4_H 0x9E

#define	COLOR16_REG_DATA_5_L 0x9F

#define	COLOR16_REG_DATA_5_H 0xA0

#define	COLOR16_REG_DATA_6_L 0xA1

#define	COLOR16_REG_DATA_6_H 0xA2

#define	COLOR16_REG_DATA_7_L 0xA3

#define	COLOR16_REG_DATA_7_H 0xA4

#define	COLOR16_REG_DATA_8_L 0xA5

#define	COLOR16_REG_DATA_8_H 0xA6

#define	COLOR16_REG_DATA_9_L 0xA7

#define	COLOR16_REG_DATA_9_H 0xA8

#define	COLOR16_REG_DATA_10_L 0xA9

#define	COLOR16_REG_DATA_10_H 0xAA

#define	COLOR16_REG_DATA_11_L 0xAB

#define	COLOR16_REG_DATA_11_H 0xAC

#define	COLOR16_REG_DATA_12_L 0xAD

#define	COLOR16_REG_DATA_12_H 0xAE

#define	COLOR16_REG_DATA_13_L 0xAF

#define	COLOR16_REG_DATA_13_H 0xB0

#define	COLOR16_REG_DATA_14_L 0xB1

#define	COLOR16_REG_DATA_14_H 0xB2

#define	COLOR16_REG_DATA_15_L 0xB3

#define	COLOR16_REG_DATA_15_H 0xB4

#define	COLOR16_REG_DATA_16_L 0xB5

#define	COLOR16_REG_DATA_16_H 0xB6

#define	COLOR16_REG_DATA_17_L 0xB7

#define	COLOR16_REG_DATA_17_H 0xB8

#define	COLOR16_REG_STATUS_2 0x90

#define	COLOR16_REG_STATUS_3 0x91

#define	COLOR16_REG_STATUS_5 0xBB

#define	COLOR16_REG_STATUS_4 0xBC

#define	COLOR16_REG_CFG_0 0xBF

#define	COLOR16_REG_CFG_1 0xC6

#define	COLOR16_REG_CFG_3 0xC7

#define	COLOR16_REG_CFG_6 0xF5

#define	COLOR16_REG_CFG_8 0xC9

#define	COLOR16_REG_CFG_9 0xCA

#define	COLOR16_REG_CFG_10 0x65

#define	COLOR16_REG_PERS 0xCF

#define	COLOR16_REG_GPIO 0x6B

#define	COLOR16_REG_ASTEP_LSB 0xD4

#define	COLOR16_REG_ASTEP_MSB 0xD5

#define	COLOR16_REG_CFG_20 0xD6

#define	COLOR16_REG_LED 0xCD

#define	COLOR16_REG_AGC_GAIN_MAX 0xD7

#define	COLOR16_REG_AZ_CONFIG 0xDE

#define	COLOR16_REG_FD_TIME_1 0xE0

#define	COLOR16_REG_FD_TIME_2 0xE2

#define	COLOR16_REG_FD_CFG_0 0xDF

#define	COLOR16_REG_FD_STATUS 0xE3

#define	COLOR16_REG_INTENAB 0xF9

#define	COLOR16_REG_CONTROL 0xFA

#define	COLOR16_REG_FIFO_MAP 0xFC

#define	COLOR16_REG_FIFO_LVL 0xFD

#define	COLOR16_REG_FDATA_L 0xFE

#define	COLOR16_REG_FDATA_H 0xFF

#define	COLOR16_ENABLE_FDEN 0x40
	Color 16 ENABLE register setting.

#define	COLOR16_ENABLE_SMUXEN 0x10

#define	COLOR16_ENABLE_WEN 0x08

#define	COLOR16_ENABLE_SP_EN 0x02

#define	COLOR16_ENABLE_PON 0x01

#define	COLOR16_ENABLE_POFF 0x00

#define	COLOR16_CFG_0_LOW_POWER 0x20
	Color 16 CFG_0 register setting.

#define	COLOR16_CFG_0_REG_BANK 0x10

#define	COLOR16_CFG_0_WLONG 0x04

#define	COLOR16_CFG_1_AGAIN_0p5 0x00
	Color 16 CFG_1 register setting.

#define	COLOR16_CFG_1_AGAIN_1 0x01

#define	COLOR16_CFG_1_AGAIN_2 0x02

#define	COLOR16_CFG_1_AGAIN_4 0x03

#define	COLOR16_CFG_1_AGAIN_8 0x04

#define	COLOR16_CFG_1_AGAIN_16 0x05

#define	COLOR16_CFG_1_AGAIN_32 0x06

#define	COLOR16_CFG_1_AGAIN_64 0x07

#define	COLOR16_CFG_1_AGAIN_128 0x08

#define	COLOR16_CFG_1_AGAIN_256 0x09

#define	COLOR16_CFG_1_AGAIN_512 0x0A

#define	COLOR16_CFG_1_AGAIN_1024 0x0B

#define	COLOR16_CFG_1_AGAIN_2048 0x0C

#define	COLOR16_CFG_1_AGAIN_MASK 0x1F

#define	COLOR16_CFG_20_FD_FIFO_8BIT 0x80
	Color 16 CFG_20 register setting.

#define	COLOR16_CFG_20_AUTO_SMUX_6CH 0x00

#define	COLOR16_CFG_20_AUTO_SMUX_12CH 0x40

#define	COLOR16_CFG_20_AUTO_SMUX_18CH 0x60

#define	COLOR16_CFG_20_AUTO_SMUX_MASK 0x60

#define	COLOR16_CONTROL_SW_RESET 0x08
	Color 16 CONTROL register setting.

#define	COLOR16_CONTROL_SP_MAN_AZ 0x04

#define	COLOR16_CONTROL_FIFO_CLR 0x02

#define	COLOR16_CONTROL_CLEAR_SAI_ACT 0x01

#define	COLOR16_LED_OFF 0x00
	Color 16 LED register setting.

#define	COLOR16_LED_ON 0x80

#define	COLOR16_LED_DRIVE_CURR_MIN 4

#define	COLOR16_LED_DRIVE_CURR_MAX 258

#define	COLOR16_LED_DRIVE_CURR_STEP 2

#define	COLOR16_LED_DRIVE_CURR_DEFAULT 8

#define	COLOR16_STATUS_ASAT 0x80
	Color 16 STATUS register setting.

#define	COLOR16_STATUS_AINT 0x08

#define	COLOR16_STATUS_FINT 0x04

#define	COLOR16_STATUS_SINT 0x01

#define	COLOR16_ASTATUS_ASAT 0x80
	Color 16 ASTATUS register setting.

#define	COLOR16_ASTATUS_AGAIN_MASK 0x0F

#define	COLOR16_STATUS_2_AVALID 0x40
	Color 16 STATUS_2 register setting.

#define	COLOR16_STATUS_2_ASAT_DIG 0x10

#define	COLOR16_STATUS_2_ASAT_ANA 0x08

#define	COLOR16_STATUS_2_FDSAT_ANA 0x02

#define	COLOR16_STATUS_2_FDSAT_DIG 0x01

#define	COLOR16_DEVICE_ID 0x81
	Color 16 device ID value.

#define	COLOR16_ACCESS_REG_BANK_ABOVE_80H 0
	Color 16 register bank access setting.

#define	COLOR16_ACCESS_REG_BANK_20H_7FH 1

#define	COLOR16_SINGLE_STEP_MS 0.00278f
	Color 16 integration time setting.

#define	COLOR16_ATIME_MAX 255

#define	COLOR16_ASTEP_MAX 65534

#define	COLOR16_INTEGRATION_TIME_MAX ( ( float ) ( COLOR16_ATIME_MAX + 1 ) * ( COLOR16_ASTEP_MAX + 1 ) * COLOR16_SINGLE_STEP_MS )

#define	COLOR16_INTEGRATION_TIME_MIN COLOR16_SINGLE_STEP_MS

#define	COLOR16_INTEGRATION_TIME_DEFAULT 90.0f

#define	COLOR16_WAIT_STEP_MS 2.78f

#define	COLOR16_WTIME_MAX 255

#define	COLOR16_WAIT_TIME_MAX ( ( float ) ( COLOR16_WTIME_MAX + 1 ) * COLOR16_WAIT_STEP_MS )

#define	COLOR16_WAIT_TIME_MIN COLOR16_WAIT_STEP_MS

#define	COLOR16_WAIT_TIME_DEFAULT 100.0f

#define	COLOR16_DEVICE_ADDRESS 0x39
	Color 16 device address setting.

#define	COLOR16_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	color16_return_value_t { COLOR16_OK = 0 , COLOR16_ERROR = -1 }
	Color 16 Click return value data. More...

Functions
void	color16_cfg_setup (color16_cfg_t *cfg)
	Color 16 configuration object setup function.

err_t	color16_init (color16_t ctx, color16_cfg_t cfg)
	Color 16 initialization function.

err_t	color16_default_cfg (color16_t *ctx)
	Color 16 default configuration function.

err_t	color16_generic_write (color16_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	Color 16 I2C writing function.

err_t	color16_generic_read (color16_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	Color 16 I2C reading function.

err_t	color16_write_register (color16_t *ctx, uint8_t reg, uint8_t data_in)
	Color 16 write register function.

err_t	color16_read_register (color16_t ctx, uint8_t reg, uint8_t data_out)
	Color 16 read register function.

err_t	color16_write_register_word (color16_t *ctx, uint8_t reg, uint16_t data_in)
	Color 16 write register word function.

err_t	color16_read_register_word (color16_t ctx, uint8_t reg, uint16_t data_out)
	Color 16 read register word function.

err_t	color16_check_communication (color16_t *ctx)
	Color 16 check communication function.

void	color16_set_ldr_pin (color16_t *ctx, uint8_t state)
	Color 16 set ldr pin function.

uint8_t	color16_get_int_pin (color16_t *ctx)
	Color 16 get int pin function.

err_t	color16_set_reg_bank_access (color16_t *ctx, uint8_t reg_bank)
	Color 16 set reg bank access function.

err_t	color16_disable_ext_led (color16_t *ctx)
	Color 16 disable ext led function.

err_t	color16_enable_ext_led (color16_t *ctx, uint8_t led_curr)
	Color 16 enable ext led function.

err_t	color16_set_integration_time_ms (color16_t *ctx, float int_time_ms)
	Color 16 set integration time ms function.

err_t	color16_set_wait_time_ms (color16_t *ctx, float wait_time_ms)
	Color 16 set wait time ms function.

err_t	color16_read_data (color16_t ctx, color16_data_t data_out)
	Color 16 read data function.

Detailed Description

This file contains API for Color 16 Click Driver.

Enumeration Type Documentation

◆ color16_return_value_t

enum color16_return_value_t

Color 16 Click return value data.

Predefined enum values for driver return values.

Enumerator
COLOR16_OK
COLOR16_ERROR

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ color16_return_value_t