Functions
void	ambient6_cfg_setup (ambient6_cfg_t *cfg)
	Config Object Initialization function.

AMBIENT6_RETVAL	ambient6_init (ambient6_t ctx, ambient6_cfg_t cfg)
	Initialization function.

void	ambient6_default_cfg (ambient6_t *ctx)
	Click Default Configuration function.

void	ambient6_generic_write (ambient6_t ctx, uint8_t reg, uint8_t data_buf, uint8_t len)
	Generic write function.

void	ambient6_generic_read (ambient6_t ctx, uint8_t reg, uint8_t data_buf, uint8_t len)
	Generic read function.

uint16_t	ambient6_get_ambient_data (ambient6_t *ctx)
	Functions for read 16bit Ambient Data (ALS)

void	ambient6_settings (ambient6_t *ctx, uint16_t config_data)
	Functions for configuration device for measurement.

float	ambient6_get_ambient_light (ambient6_t *ctx)
	Functions for get Ambient Light Data.

Detailed Description

Function Documentation

◆ ambient6_cfg_setup()

void ambient6_cfg_setup ( ambient6_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.

◆ ambient6_default_cfg()

void ambient6_default_cfg ( ambient6_t * ctx )

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for Ambient6 click.

Note

Default configuration of the chip contains the settings

 
   Ambient6_settings:
      - AMBIENT6_CFG_ALS_SENSITIVITY_X2
      - AMBIENT6_CFG_ALS_TIME_SETTING_25MS
      - AMBIENT6_CFG_PERSISTENCE_NUMBER_1
      - AMBIENT6_CFG_ALS_INT_DISABLE
      - AMBIENT6_CFG_ALS_POWER_ON
   Set AMBIENT6_CMD_MODE_SETTINGS register:
      - AMBIENT6_POWER_MODE_ENABLE
      - AMBIENT6_POWER_MODE_1

◆ ambient6_generic_read()

void ambient6_generic_read	(	ambient6_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function reads data from the desired register.

◆ ambient6_generic_write()

void ambient6_generic_write	(	ambient6_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.

◆ ambient6_get_ambient_data()

uint16_t ambient6_get_ambient_data ( ambient6_t * ctx )

Functions for read 16bit Ambient Data (ALS)

Parameters

ctx	Click object.

Return values

Ambient data

◆ ambient6_get_ambient_light()

float ambient6_get_ambient_light ( ambient6_t * ctx )

Functions for get Ambient Light Data.

Parameters

ctx	Click object.

@description This function converts ambient light depending on the set Gain and measurement time.

◆ ambient6_init()

AMBIENT6_RETVAL ambient6_init	(	ambient6_t *	ctx,
		ambient6_cfg_t *	cfg )

Initialization function.

Parameters

ambient6	Click object.
cfg	Click configuration structure.

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

◆ ambient6_settings()

void ambient6_settings	(	ambient6_t *	ctx,
		uint16_t	config_data )

Functions for configuration device for measurement.

Parameters

ctx	Click object.
config_data	16Bit data for configuration

Note

- Options for settings:

 
 Sensitivity mode selection (x1,x2,x1/8 or x1/4)
    ALS integration time setting (25ms, 50ms, 100ms, 200ms, 400ms or 800ms)
    ALS persistence protect number setting (1,2,4 or 8)
    ALS interrupt enable setting (enable or disable)
    ALS shut down setting (ALS power on or ALS shut down)