illuminance  2.0.0.0
Functions

Functions

void illuminance_cfg_setup (illuminance_cfg_t *cfg)
 Config Object Initialization function. More...
 
ILLUMINANCE_RETVAL illuminance_init (illuminance_t *ctx, illuminance_cfg_t *cfg)
 Initialization function. More...
 
void illuminance_default_cfg (illuminance_t *ctx)
 Click Default Configuration function. More...
 
void illuminance_generic_write (illuminance_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void illuminance_generic_read (illuminance_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void illuminance_write_data (illuminance_t *ctx, uint8_t address, uint8_t write_command)
 Generic write data function. More...
 
uint8_t illuminance_read_data (illuminance_t *ctx, uint8_t addr)
 Generic read data function. More...
 
void illuminance_get_result (illuminance_t *ctx, uint16_t *value_ch0, uint16_t *value_ch1)
 Get Visible & Infrared value. More...
 
uint16_t illuminance_calculate_lux (uint16_t value_gain, uint16_t value_int, uint16_t ch0, uint16_t ch1)
 Calculate lux value. More...
 
uint8_t illuminance_get_interrupt (illuminance_t *ctx)
 Get interrupt pin status. More...
 

Detailed Description

Function Documentation

◆ illuminance_calculate_lux()

uint16_t illuminance_calculate_lux ( uint16_t  value_gain,
uint16_t  value_int,
uint16_t  ch0,
uint16_t  ch1 
)

Calculate lux value.

Parameters
ctxClick object.
value_gain0x00 - No gain, 0x01 - 16x gain
value_int0x00 - 13.7ms, 0x01 - 101ms, 0x02 - 402ms
channel0Visible & Infrared data
channel1Infrared data
Returns
16-bit resulting lux calculation

@descruotion This function calculates lux value from the TSL2561 sensor.

◆ illuminance_cfg_setup()

void illuminance_cfg_setup ( illuminance_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.

◆ illuminance_default_cfg()

void illuminance_default_cfg ( illuminance_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration ( typically power on device and set timing value ) for Illuminance click.

◆ illuminance_generic_read()

void illuminance_generic_read ( illuminance_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.

◆ illuminance_generic_write()

void illuminance_generic_write ( illuminance_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.

◆ illuminance_get_interrupt()

uint8_t illuminance_get_interrupt ( illuminance_t ctx)

Get interrupt pin status.

Parameters
ctxClick object.
Returns
Interrupt pin state.

@description This functions gets interrupt pin state.

◆ illuminance_get_result()

void illuminance_get_result ( illuminance_t ctx,
uint16_t *  value_ch0,
uint16_t *  value_ch1 
)

Get Visible & Infrared value.

Parameters
ctxClick object.
value_ch0Pointer to read Visible & Infrared value.
value_ch1Pointer to read Infrared value.

@description This function gets Visible & Infrared value.

◆ illuminance_init()

ILLUMINANCE_RETVAL illuminance_init ( illuminance_t ctx,
illuminance_cfg_t cfg 
)

Initialization function.

Parameters
illuminanceClick object.
cfgClick configuration structure.

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

◆ illuminance_read_data()

uint8_t illuminance_read_data ( illuminance_t ctx,
uint8_t  addr 
)

Generic read data function.

Parameters
ctxClick object.
addrRegister address.
Returns
8-bit data from addressed register from TSL2561

@description This function reads byte of data from register address addr of TSL2561.

◆ illuminance_write_data()

void illuminance_write_data ( illuminance_t ctx,
uint8_t  address,
uint8_t  write_command 
)

Generic write data function.

Parameters
ctxClick object.
addressRegister address.
write_commandCommand to write.

@description This function writes byte of data to TSL2561.