ambient14  2.1.0.0
Macros
Ambient 14 Registers Settings

Settings for registers of Ambient 14 Click driver. More...

Macros

#define AMBIENT14_ENABLE_PWEN   0x10
 Ambient 14 ENABLE register setting. More...
 
#define AMBIENT14_ENABLE_AWEN   0x08
 
#define AMBIENT14_ENABLE_PEN   0x04
 
#define AMBIENT14_ENABLE_AEN   0x02
 
#define AMBIENT14_ENABLE_PON   0x01
 
#define AMBIENT14_SOFT_RESET   0x01
 Ambient 14 SOFTRST register setting. More...
 
#define AMBIENT14_PCFG0_PGAIN1_1X   0x00
 Ambient 14 PCFG0 register setting. More...
 
#define AMBIENT14_PCFG0_PGAIN1_2X   0x40
 
#define AMBIENT14_PCFG0_PGAIN1_4X   0x80
 
#define AMBIENT14_PCFG0_PGAIN1_8X   0xC0
 
#define AMBIENT14_PCFG0_PGAIN1_MASK   0xC0
 
#define AMBIENT14_PCFG0_PPULSE_MIN   0x00
 
#define AMBIENT14_PCFG0_PPULSE_DEFAULT   0x01
 
#define AMBIENT14_PCFG0_PPULSE_MAX   0x3F
 
#define AMBIENT14_PCFG0_PPULSE_MASK   0x3F
 
#define AMBIENT14_PCFG1_PPULSE_LENH_DEFAULT   0x00
 Ambient 14 PCFG1 register setting. More...
 
#define AMBIENT14_PCFG1_PPULSE_LENH_MASK   0xC0
 
#define AMBIENT14_PCFG1_RESERVED   0x30
 
#define AMBIENT14_PCFG1_PLDRIVE_7_MA   0x05
 
#define AMBIENT14_PCFG1_PLDRIVE_8_MA   0x06
 
#define AMBIENT14_PCFG1_PLDRIVE_9_MA   0x07
 
#define AMBIENT14_PCFG1_PLDRIVE_10_MA   0x08
 
#define AMBIENT14_PCFG1_PLDRIVE_MASK   0x0F
 
#define AMBIENT14_PCFG2_PPULSE_LENL_DEFAULT   0x20
 Ambient 14 PCFG2 register setting. More...
 
#define AMBIENT14_PCFG2_PPULSE_LENL_MASK   0xFF
 
#define AMBIENT14_CFG1_PGAIN2_2_5X   0x00
 Ambient 14 CFG1 register setting. More...
 
#define AMBIENT14_CFG1_PGAIN2_5X   0x20
 
#define AMBIENT14_CFG1_PGAIN2_10X   0x60
 
#define AMBIENT14_CFG1_PGAIN2_MASK   0x60
 
#define AMBIENT14_CFG1_AGAIN_16X   0x05
 
#define AMBIENT14_CFG1_AGAIN_128X   0x08
 
#define AMBIENT14_CFG1_AGAIN_1024X   0x0B
 
#define AMBIENT14_CFG1_AGAIN_MASK   0x1F
 
#define AMBIENT14_CFG8_RESERVED   0x29
 Ambient 14 CFG8 register setting. More...
 
#define AMBIENT14_CFG6_APC_ENABLE   0x00
 Ambient 14 CFG6 register setting. More...
 
#define AMBIENT14_CFG6_APC_DISABLE   0x40
 
#define AMBIENT14_CFG6_RESERVED   0x3F
 
#define AMBIENT14_STATUS_ASAT   0x80
 Ambient 14 STATUS register setting. More...
 
#define AMBIENT14_STATUS_PSAT   0x40
 
#define AMBIENT14_STATUS_PINT   0x20
 
#define AMBIENT14_STATUS_AINT   0x10
 
#define AMBIENT14_STATUS_CINT   0x08
 
#define AMBIENT14_STATUS_ZINT   0x04
 
#define AMBIENT14_STATUS_PSAT_REFLECTIVE   0x02
 
#define AMBIENT14_STATUS_PSAT_AMBIENT   0x01
 
#define AMBIENT14_STATUS_CLEAR_ALL   0xFF
 
#define AMBIENT14_INTENAB_ASIEN   0x80
 Ambient 14 INTENAB register setting. More...
 
#define AMBIENT14_INTENAB_PSIEN   0x40
 
#define AMBIENT14_INTENAB_PIEN   0x20
 
#define AMBIENT14_INTENAB_AIEN   0x10
 
#define AMBIENT14_INTENAB_CIEN   0x08
 
#define AMBIENT14_INTENAB_ZIEN   0x04
 
#define AMBIENT14_INTENAB_DISABLE   0x00
 
#define AMBIENT14_CALIB_CALAVG   0x80
 Ambient 14 CALIB register setting. More...
 
#define AMBIENT14_CALIB_ELECTRICAL_CALIB   0x20
 
#define AMBIENT14_CALIB_CALPRATE   0x10
 
#define AMBIENT14_CALIB_START_OFFSET_CAL   0x01
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_3   0x00
 Ambient 14 CALIBCFG register setting. More...
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_7   0x20
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_15   0x40
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_31   0x60
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_63   0x80
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_127   0xA0
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_255   0xC0
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_511   0xE0
 
#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_MASK   0xE0
 
#define AMBIENT14_CALIBCFG_RESERVED   0x10
 
#define AMBIENT14_CALIBCFG_AUTO_OFFSET_ADJ   0x08
 
#define AMBIENT14_CALIBCFG_PROX_AVG_DISABLE   0x00
 
#define AMBIENT14_CALIBCFG_PROX_AVG_2   0x01
 
#define AMBIENT14_CALIBCFG_PROX_AVG_4   0x02
 
#define AMBIENT14_CALIBCFG_PROX_AVG_8   0x03
 
#define AMBIENT14_CALIBCFG_PROX_AVG_16   0x04
 
#define AMBIENT14_CALIBCFG_PROX_AVG_MASK   0x07
 
#define AMBIENT14_CALIBSTAT_OFFSET_ADJUSTED   0x04
 Ambient 14 CALIBSTAT register setting. More...
 
#define AMBIENT14_CALIBSTAT_CALIB_FINISHED   0x01
 
#define AMBIENT14_SINGLE_STEP_MS   2.78f
 Ambient 14 integration time setting. More...
 
#define AMBIENT14_ATIME_MAX   ( 256 * AMBIENT14_SINGLE_STEP_MS )
 
#define AMBIENT14_ATIME_MIN   AMBIENT14_SINGLE_STEP_MS
 
#define AMBIENT14_ATIME_DEFAULT   100.0f
 
#define AMBIENT14_AWTIME_MAX   ( 256 * AMBIENT14_SINGLE_STEP_MS )
 
#define AMBIENT14_AWTIME_MIN   AMBIENT14_SINGLE_STEP_MS
 
#define AMBIENT14_AWTIME_DEFAULT   50.0f
 
#define AMBIENT14_PWTIME_MAX   ( 256 * AMBIENT14_SINGLE_STEP_MS )
 
#define AMBIENT14_PWTIME_MIN   AMBIENT14_SINGLE_STEP_MS
 
#define AMBIENT14_PWTIME_DEFAULT   500.0f
 
#define AMBIENT14_ROUND_TO_INT   0.5f
 
#define AMBIENT14_ILLUMINANCE_GAIN_16_TO_128   0.125f
 Ambient 14 illuminance conversion setting. More...
 
#define AMBIENT14_ILLUMINANCE_ATIME_100_GAIN_128   0.0095f
 
#define AMBIENT14_ILLUMINANCE_GAIN_1024_TO_128   8.2f
 
#define AMBIENT14_DEVICE_ID   0x50
 Ambient 14 ID value. More...
 
#define AMBIENT14_DEVICE_ADDRESS   0x39
 Ambient 14 device address setting. More...
 

Detailed Description

Settings for registers of Ambient 14 Click driver.

Macro Definition Documentation

◆ AMBIENT14_ATIME_DEFAULT

#define AMBIENT14_ATIME_DEFAULT   100.0f

◆ AMBIENT14_ATIME_MAX

#define AMBIENT14_ATIME_MAX   ( 256 * AMBIENT14_SINGLE_STEP_MS )

◆ AMBIENT14_ATIME_MIN

#define AMBIENT14_ATIME_MIN   AMBIENT14_SINGLE_STEP_MS

◆ AMBIENT14_AWTIME_DEFAULT

#define AMBIENT14_AWTIME_DEFAULT   50.0f

◆ AMBIENT14_AWTIME_MAX

#define AMBIENT14_AWTIME_MAX   ( 256 * AMBIENT14_SINGLE_STEP_MS )

◆ AMBIENT14_AWTIME_MIN

#define AMBIENT14_AWTIME_MIN   AMBIENT14_SINGLE_STEP_MS

◆ AMBIENT14_CALIB_CALAVG

#define AMBIENT14_CALIB_CALAVG   0x80

Ambient 14 CALIB register setting.

Specified setting for CALIB register of Ambient 14 Click driver.

◆ AMBIENT14_CALIB_CALPRATE

#define AMBIENT14_CALIB_CALPRATE   0x10

◆ AMBIENT14_CALIB_ELECTRICAL_CALIB

#define AMBIENT14_CALIB_ELECTRICAL_CALIB   0x20

◆ AMBIENT14_CALIB_START_OFFSET_CAL

#define AMBIENT14_CALIB_START_OFFSET_CAL   0x01

◆ AMBIENT14_CALIBCFG_AUTO_OFFSET_ADJ

#define AMBIENT14_CALIBCFG_AUTO_OFFSET_ADJ   0x08

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_127

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_127   0xA0

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_15

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_15   0x40

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_255

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_255   0xC0

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_3

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_3   0x00

Ambient 14 CALIBCFG register setting.

Specified setting for CALIBCFG register of Ambient 14 Click driver.

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_31

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_31   0x60

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_511

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_511   0xE0

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_63

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_63   0x80

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_7

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_7   0x20

◆ AMBIENT14_CALIBCFG_BINSRCH_TARGET_MASK

#define AMBIENT14_CALIBCFG_BINSRCH_TARGET_MASK   0xE0

◆ AMBIENT14_CALIBCFG_PROX_AVG_16

#define AMBIENT14_CALIBCFG_PROX_AVG_16   0x04

◆ AMBIENT14_CALIBCFG_PROX_AVG_2

#define AMBIENT14_CALIBCFG_PROX_AVG_2   0x01

◆ AMBIENT14_CALIBCFG_PROX_AVG_4

#define AMBIENT14_CALIBCFG_PROX_AVG_4   0x02

◆ AMBIENT14_CALIBCFG_PROX_AVG_8

#define AMBIENT14_CALIBCFG_PROX_AVG_8   0x03

◆ AMBIENT14_CALIBCFG_PROX_AVG_DISABLE

#define AMBIENT14_CALIBCFG_PROX_AVG_DISABLE   0x00

◆ AMBIENT14_CALIBCFG_PROX_AVG_MASK

#define AMBIENT14_CALIBCFG_PROX_AVG_MASK   0x07

◆ AMBIENT14_CALIBCFG_RESERVED

#define AMBIENT14_CALIBCFG_RESERVED   0x10

◆ AMBIENT14_CALIBSTAT_CALIB_FINISHED

#define AMBIENT14_CALIBSTAT_CALIB_FINISHED   0x01

◆ AMBIENT14_CALIBSTAT_OFFSET_ADJUSTED

#define AMBIENT14_CALIBSTAT_OFFSET_ADJUSTED   0x04

Ambient 14 CALIBSTAT register setting.

Specified setting for CALIBSTAT register of Ambient 14 Click driver.

◆ AMBIENT14_CFG1_AGAIN_1024X

#define AMBIENT14_CFG1_AGAIN_1024X   0x0B

◆ AMBIENT14_CFG1_AGAIN_128X

#define AMBIENT14_CFG1_AGAIN_128X   0x08

◆ AMBIENT14_CFG1_AGAIN_16X

#define AMBIENT14_CFG1_AGAIN_16X   0x05

◆ AMBIENT14_CFG1_AGAIN_MASK

#define AMBIENT14_CFG1_AGAIN_MASK   0x1F

◆ AMBIENT14_CFG1_PGAIN2_10X

#define AMBIENT14_CFG1_PGAIN2_10X   0x60

◆ AMBIENT14_CFG1_PGAIN2_2_5X

#define AMBIENT14_CFG1_PGAIN2_2_5X   0x00

Ambient 14 CFG1 register setting.

Specified setting for CFG1 register of Ambient 14 Click driver.

◆ AMBIENT14_CFG1_PGAIN2_5X

#define AMBIENT14_CFG1_PGAIN2_5X   0x20

◆ AMBIENT14_CFG1_PGAIN2_MASK

#define AMBIENT14_CFG1_PGAIN2_MASK   0x60

◆ AMBIENT14_CFG6_APC_DISABLE

#define AMBIENT14_CFG6_APC_DISABLE   0x40

◆ AMBIENT14_CFG6_APC_ENABLE

#define AMBIENT14_CFG6_APC_ENABLE   0x00

Ambient 14 CFG6 register setting.

Specified setting for CFG6 register of Ambient 14 Click driver.

◆ AMBIENT14_CFG6_RESERVED

#define AMBIENT14_CFG6_RESERVED   0x3F

◆ AMBIENT14_CFG8_RESERVED

#define AMBIENT14_CFG8_RESERVED   0x29

Ambient 14 CFG8 register setting.

Specified setting for CFG8 register of Ambient 14 Click driver.

◆ AMBIENT14_DEVICE_ADDRESS

#define AMBIENT14_DEVICE_ADDRESS   0x39

Ambient 14 device address setting.

Specified setting for device slave address selection of Ambient 14 Click driver.

◆ AMBIENT14_DEVICE_ID

#define AMBIENT14_DEVICE_ID   0x50

Ambient 14 ID value.

Specified ID value of Ambient 14 Click driver.

◆ AMBIENT14_ENABLE_AEN

#define AMBIENT14_ENABLE_AEN   0x02

◆ AMBIENT14_ENABLE_AWEN

#define AMBIENT14_ENABLE_AWEN   0x08

◆ AMBIENT14_ENABLE_PEN

#define AMBIENT14_ENABLE_PEN   0x04

◆ AMBIENT14_ENABLE_PON

#define AMBIENT14_ENABLE_PON   0x01

◆ AMBIENT14_ENABLE_PWEN

#define AMBIENT14_ENABLE_PWEN   0x10

Ambient 14 ENABLE register setting.

Specified setting for ENABLE register of Ambient 14 Click driver.

◆ AMBIENT14_ILLUMINANCE_ATIME_100_GAIN_128

#define AMBIENT14_ILLUMINANCE_ATIME_100_GAIN_128   0.0095f

◆ AMBIENT14_ILLUMINANCE_GAIN_1024_TO_128

#define AMBIENT14_ILLUMINANCE_GAIN_1024_TO_128   8.2f

◆ AMBIENT14_ILLUMINANCE_GAIN_16_TO_128

#define AMBIENT14_ILLUMINANCE_GAIN_16_TO_128   0.125f

Ambient 14 illuminance conversion setting.

Specified setting for illuminance conversion (Figure 13 from datasheet) of Ambient 14 Click driver.

◆ AMBIENT14_INTENAB_AIEN

#define AMBIENT14_INTENAB_AIEN   0x10

◆ AMBIENT14_INTENAB_ASIEN

#define AMBIENT14_INTENAB_ASIEN   0x80

Ambient 14 INTENAB register setting.

Specified setting for INTENAB register of Ambient 14 Click driver.

◆ AMBIENT14_INTENAB_CIEN

#define AMBIENT14_INTENAB_CIEN   0x08

◆ AMBIENT14_INTENAB_DISABLE

#define AMBIENT14_INTENAB_DISABLE   0x00

◆ AMBIENT14_INTENAB_PIEN

#define AMBIENT14_INTENAB_PIEN   0x20

◆ AMBIENT14_INTENAB_PSIEN

#define AMBIENT14_INTENAB_PSIEN   0x40

◆ AMBIENT14_INTENAB_ZIEN

#define AMBIENT14_INTENAB_ZIEN   0x04

◆ AMBIENT14_PCFG0_PGAIN1_1X

#define AMBIENT14_PCFG0_PGAIN1_1X   0x00

Ambient 14 PCFG0 register setting.

Specified setting for PCFG0 register of Ambient 14 Click driver.

◆ AMBIENT14_PCFG0_PGAIN1_2X

#define AMBIENT14_PCFG0_PGAIN1_2X   0x40

◆ AMBIENT14_PCFG0_PGAIN1_4X

#define AMBIENT14_PCFG0_PGAIN1_4X   0x80

◆ AMBIENT14_PCFG0_PGAIN1_8X

#define AMBIENT14_PCFG0_PGAIN1_8X   0xC0

◆ AMBIENT14_PCFG0_PGAIN1_MASK

#define AMBIENT14_PCFG0_PGAIN1_MASK   0xC0

◆ AMBIENT14_PCFG0_PPULSE_DEFAULT

#define AMBIENT14_PCFG0_PPULSE_DEFAULT   0x01

◆ AMBIENT14_PCFG0_PPULSE_MASK

#define AMBIENT14_PCFG0_PPULSE_MASK   0x3F

◆ AMBIENT14_PCFG0_PPULSE_MAX

#define AMBIENT14_PCFG0_PPULSE_MAX   0x3F

◆ AMBIENT14_PCFG0_PPULSE_MIN

#define AMBIENT14_PCFG0_PPULSE_MIN   0x00

◆ AMBIENT14_PCFG1_PLDRIVE_10_MA

#define AMBIENT14_PCFG1_PLDRIVE_10_MA   0x08

◆ AMBIENT14_PCFG1_PLDRIVE_7_MA

#define AMBIENT14_PCFG1_PLDRIVE_7_MA   0x05

◆ AMBIENT14_PCFG1_PLDRIVE_8_MA

#define AMBIENT14_PCFG1_PLDRIVE_8_MA   0x06

◆ AMBIENT14_PCFG1_PLDRIVE_9_MA

#define AMBIENT14_PCFG1_PLDRIVE_9_MA   0x07

◆ AMBIENT14_PCFG1_PLDRIVE_MASK

#define AMBIENT14_PCFG1_PLDRIVE_MASK   0x0F

◆ AMBIENT14_PCFG1_PPULSE_LENH_DEFAULT

#define AMBIENT14_PCFG1_PPULSE_LENH_DEFAULT   0x00

Ambient 14 PCFG1 register setting.

Specified setting for PCFG1 register of Ambient 14 Click driver.

◆ AMBIENT14_PCFG1_PPULSE_LENH_MASK

#define AMBIENT14_PCFG1_PPULSE_LENH_MASK   0xC0

◆ AMBIENT14_PCFG1_RESERVED

#define AMBIENT14_PCFG1_RESERVED   0x30

◆ AMBIENT14_PCFG2_PPULSE_LENL_DEFAULT

#define AMBIENT14_PCFG2_PPULSE_LENL_DEFAULT   0x20

Ambient 14 PCFG2 register setting.

Specified setting for PCFG2 register of Ambient 14 Click driver.

◆ AMBIENT14_PCFG2_PPULSE_LENL_MASK

#define AMBIENT14_PCFG2_PPULSE_LENL_MASK   0xFF

◆ AMBIENT14_PWTIME_DEFAULT

#define AMBIENT14_PWTIME_DEFAULT   500.0f

◆ AMBIENT14_PWTIME_MAX

#define AMBIENT14_PWTIME_MAX   ( 256 * AMBIENT14_SINGLE_STEP_MS )

◆ AMBIENT14_PWTIME_MIN

#define AMBIENT14_PWTIME_MIN   AMBIENT14_SINGLE_STEP_MS

◆ AMBIENT14_ROUND_TO_INT

#define AMBIENT14_ROUND_TO_INT   0.5f

◆ AMBIENT14_SINGLE_STEP_MS

#define AMBIENT14_SINGLE_STEP_MS   2.78f

Ambient 14 integration time setting.

Specified setting for integration time of Ambient 14 Click driver.

◆ AMBIENT14_SOFT_RESET

#define AMBIENT14_SOFT_RESET   0x01

Ambient 14 SOFTRST register setting.

Specified setting for SOFTRST register of Ambient 14 Click driver.

◆ AMBIENT14_STATUS_AINT

#define AMBIENT14_STATUS_AINT   0x10

◆ AMBIENT14_STATUS_ASAT

#define AMBIENT14_STATUS_ASAT   0x80

Ambient 14 STATUS register setting.

Specified setting for STATUS register of Ambient 14 Click driver.

◆ AMBIENT14_STATUS_CINT

#define AMBIENT14_STATUS_CINT   0x08

◆ AMBIENT14_STATUS_CLEAR_ALL

#define AMBIENT14_STATUS_CLEAR_ALL   0xFF

◆ AMBIENT14_STATUS_PINT

#define AMBIENT14_STATUS_PINT   0x20

◆ AMBIENT14_STATUS_PSAT

#define AMBIENT14_STATUS_PSAT   0x40

◆ AMBIENT14_STATUS_PSAT_AMBIENT

#define AMBIENT14_STATUS_PSAT_AMBIENT   0x01

◆ AMBIENT14_STATUS_PSAT_REFLECTIVE

#define AMBIENT14_STATUS_PSAT_REFLECTIVE   0x02

◆ AMBIENT14_STATUS_ZINT

#define AMBIENT14_STATUS_ZINT   0x04