presence  2.0.0.0
Functions
Public function

Functions

void presence_cfg_setup (presence_cfg_t *cfg)
 Config Object Initialization function. More...
 
PRESENCE_RETVAL presence_init (presence_t *ctx, presence_cfg_t *cfg)
 Initialization function. More...
 
void presence_generic_write (presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void presence_generic_read (presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
uint8_t presence_get_interrupt_state (presence_t *ctx)
 Get interrupt state function. More...
 
void presence_general_call_addr (presence_t *ctx)
 General call address. More...
 
uint8_t presence_eeprom_process (presence_t *ctx)
 EEPRM PROCESS. More...
 
float presence_get_calib_constants ()
 Calibration constant K. More...
 
float presence_ambient_temperature (presence_t *ctx)
 Ambient Temperature. More...
 
float presence_object_temperature (presence_t *ctx)
 Object Temperature. More...
 

Detailed Description

Function Documentation

◆ presence_ambient_temperature()

float presence_ambient_temperature ( presence_t ctx)

Ambient Temperature.

Parameters
ctxClick object.
Returns
Temperaure in C

@description This function returns ambient temperature in degrees Celisius.

◆ presence_cfg_setup()

void presence_cfg_setup ( presence_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.

◆ presence_eeprom_process()

uint8_t presence_eeprom_process ( presence_t ctx)

EEPRM PROCESS.

Parameters
ctxClick object.
Returns
Has it successfully read eeprom? [ 0 - YES ] or [ 1 - NO ]

@description This Function enables , read and dsiables the eeprom and then checks whether or not it as successfully read any data from it.

Note
This function must be performed at the start of each program in order to read and accommodate all calibration coefficients.

◆ presence_general_call_addr()

void presence_general_call_addr ( presence_t ctx)

General call address.

Parameters
ctxClick object.

@description This function writes general call address and sets slave address.

◆ presence_generic_read()

void presence_generic_read ( presence_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ presence_generic_write()

void presence_generic_write ( presence_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ presence_get_calib_constants()

float presence_get_calib_constants ( )

Calibration constant K.

Returns
K value

This function returns calbration constant's K value.

◆ presence_get_interrupt_state()

uint8_t presence_get_interrupt_state ( presence_t ctx)

Get interrupt state function.

Parameters
ctxClick object.

@description This function reads state from int pin.

◆ presence_init()

PRESENCE_RETVAL presence_init ( presence_t ctx,
presence_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ presence_object_temperature()

float presence_object_temperature ( presence_t ctx)

Object Temperature.

Parameters
ctxClick object.
Returns
Temperaure in C

@description This function returns object temperature.