proximity3  2.0.0.0
Functions

Functions

void proximity3_cfg_setup (proximity3_cfg_t *cfg)
 Config Object Initialization function. More...
 
PROXIMITY3_RETVAL proximity3_init (proximity3_t *ctx, proximity3_cfg_t *cfg)
 Initialization function. More...
 
void proximity3_write_16 (proximity3_t *ctx, uint8_t reg_address, uint16_t data_in)
 Generic write function. More...
 
uint16_t proximity3_read_16 (proximity3_t *ctx, uint8_t reg_address)
 Generic read function. More...
 
uint16_t proximity3_read_ambient_light_sensor (proximity3_t *ctx)
 Read ambient light sensor data. More...
 
uint8_t proximity3_read_proximity (proximity3_t *ctx)
 Read proximity. More...
 
uint8_t proximity3_get_distance (proximity3_t *ctx)
 Get distance. More...
 
uint16_t proximity3_get_illuminance (proximity3_t *ctx)
 Get illuminance. More...
 

Detailed Description

Function Documentation

◆ proximity3_cfg_setup()

void proximity3_cfg_setup ( proximity3_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

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

Note
All used pins will be set to unconnected state.

◆ proximity3_get_distance()

uint8_t proximity3_get_distance ( proximity3_t ctx)

Get distance.

Parameters
ctxClick object.
Returns
Calculated distance.

@description This function calculates distance using data reported by sensor.

◆ proximity3_get_illuminance()

uint16_t proximity3_get_illuminance ( proximity3_t ctx)

Get illuminance.

Parameters
ctxClick object.
Returns
Illuminance data.

@description This function returns illuminance.

◆ proximity3_init()

PROXIMITY3_RETVAL proximity3_init ( proximity3_t ctx,
proximity3_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ proximity3_read_16()

uint16_t proximity3_read_16 ( proximity3_t ctx,
uint8_t  reg_address 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
Returns
16-BIT data read from the register.

@description This function reads data from the desired register.

◆ proximity3_read_ambient_light_sensor()

uint16_t proximity3_read_ambient_light_sensor ( proximity3_t ctx)

Read ambient light sensor data.

Parameters
ctxClick object.
Returns
Ambient light sensor data.

@description This function gets the data returned by the ambient light sensor.

◆ proximity3_read_proximity()

uint8_t proximity3_read_proximity ( proximity3_t ctx)

Read proximity.

Parameters
ctxClick object.
Returns
Proximity data.

@description This function returns the proximity.

◆ proximity3_write_16()

void proximity3_write_16 ( proximity3_t ctx,
uint8_t  reg_address,
uint16_t  data_in 
)

Generic write function.

Parameters
ctxClick object.
reg_addressRegister address.
data_in16-BIT data ata to be written.

@description This function writes data to the desired register.