proxfusion2  2.0.0.0
Functions

Functions

void proxfusion2_cfg_setup (proxfusion2_cfg_t *cfg)
 Config Object Initialization function. More...
 
PROXFUSION2_RETVAL proxfusion2_init (proxfusion2_t *ctx, proxfusion2_cfg_t *cfg)
 Initialization function. More...
 
void proxfusion2_default_cfg (proxfusion2_t *ctx)
 Click Default Configuration function. More...
 
void proxfusion2_write_byte (proxfusion2_t *ctx, uint8_t reg, uint8_t d_data)
 Function for writing one byte into the register. More...
 
uint8_t proxfusion2_read_byte (proxfusion2_t *ctx, uint8_t reg)
 Function for reads one byte from register. More...
 
uint16_t proxfusion2_read_data (proxfusion2_t *ctx, uint8_t reg)
 Function for reads two byte from register. More...
 
void proxfusion2_default_config (proxfusion2_t *ctx)
 Function for configuration chip. More...
 
uint8_t proxfusion2_init_func (proxfusion2_t *ctx)
 Function for init chip. More...
 
uint8_t proxfusion2_detect_touch (proxfusion2_t *ctx)
 Function for detect Touch. More...
 
uint8_t proxfusion2_detect_dark_light (proxfusion2_t *ctx, uint8_t *als_range)
 Function for read ambient light. More...
 
uint8_t proxfusion2_detect_hall (proxfusion2_t *ctx)
 Function for read Hall-effect. More...
 

Detailed Description

Function Documentation

◆ proxfusion2_cfg_setup()

void proxfusion2_cfg_setup ( proxfusion2_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ proxfusion2_default_cfg()

void proxfusion2_default_cfg ( proxfusion2_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for ProxFusion2 click.

◆ proxfusion2_default_config()

void proxfusion2_default_config ( proxfusion2_t ctx)

Function for configuration chip.

Parameters
proxfusion2Click object.
Returns
The function contains all necessary sensors for operation and measurement.

◆ proxfusion2_detect_dark_light()

uint8_t proxfusion2_detect_dark_light ( proxfusion2_t ctx,
uint8_t *  als_range 
)

Function for read ambient light.

Parameters
als_rangeALS range (0-10)
proxfusion2Click object.
Return values
1- DARK or 0 - LIGHT

◆ proxfusion2_detect_hall()

uint8_t proxfusion2_detect_hall ( proxfusion2_t ctx)

Function for read Hall-effect.

Parameters
proxfusion2Click object.
Return values
1- NORTH, 2 - SOUTH or 0 - NO_HALL

◆ proxfusion2_detect_touch()

uint8_t proxfusion2_detect_touch ( proxfusion2_t ctx)

Function for detect Touch.

Parameters
proxfusion2Click object.
Return values
1- TOUCH_DETECTED or 0 - NO_TOUCH

◆ proxfusion2_init()

PROXFUSION2_RETVAL proxfusion2_init ( proxfusion2_t ctx,
proxfusion2_cfg_t cfg 
)

Initialization function.

Parameters
proxfusion2Click object.
cfgClick configuration structure.

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

◆ proxfusion2_init_func()

uint8_t proxfusion2_init_func ( proxfusion2_t ctx)

Function for init chip.

Parameters
proxfusion2Click object.
Returns
Error code if init failed

◆ proxfusion2_read_byte()

uint8_t proxfusion2_read_byte ( proxfusion2_t ctx,
uint8_t  reg 
)

Function for reads one byte from register.

Parameters
proxfusion2Click object.
regRegister from which the data is read
Returns
data that is read

◆ proxfusion2_read_data()

uint16_t proxfusion2_read_data ( proxfusion2_t ctx,
uint8_t  reg 
)

Function for reads two byte from register.

Parameters
proxfusion2Click object.
regRegister from which the data is read
Returns
data that is read

◆ proxfusion2_write_byte()

void proxfusion2_write_byte ( proxfusion2_t ctx,
uint8_t  reg,
uint8_t  d_data 
)

Function for writing one byte into the register.

Parameters
proxfusion2Click object.
regRegister in which the data will be written
d_dataData which be written in register