Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
ambient8_click.h File Reference

mikrosdk interface More...

#include <stdint.h>
Include dependency graph for ambient8_click.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define LTR303ALS_MODE   LTR303ALS_MODE_ONE_SHOT
 
#define AMBIENT8_DEVICE_ADDRESS   0x29
 
#define LTR303ALS_T_ACTIVE   10 /* time [ms] before data after setting active mode */
 
#define LTR303ALS_T_POWERUP   100 /* time [ms] before data after power-up */
 
#define LTR303ALS_PARTID   0xA0
 
#define LTR303ALS_MANFID   0x05
 
#define LTR303ALS_MODE_STANDBY   0x00
 
#define LTR303ALS_MODE_ACTIVE   0x01
 
#define LTR303ALS_SW_RESET   0x02
 
#define LTR303ALS_GAIN_1X   0x00
 
#define LTR303ALS_GAIN_2X   0x04
 
#define LTR303ALS_GAIN_4X   0x08
 
#define LTR303ALS_GAIN_8X   0x0C
 
#define LTR303ALS_GAIN_48X   0x18
 
#define LTR303ALS_GAIN_96X   0x1C
 
#define LTR303ALS_DATA_VALID   0x80
 
#define LTR303ALS_DATA_STATUS   0x04
 
#define LTR303ALS_TMEAS_50   0x00
 
#define LTR303ALS_TMEAS_100   0x01
 
#define LTR303ALS_TMEAS_200   0x02
 
#define LTR303ALS_TMEAS_500   0x03
 
#define LTR303ALS_TMEAS_1000   0x04
 
#define LTR303ALS_TMEAS_2000   0x05
 
#define LTR303ALS_TINT_50   0x08
 
#define LTR303ALS_TINT_100   0x00
 
#define LTR303ALS_TINT_150   0x20
 
#define LTR303ALS_TINT_200   0x10
 
#define LTR303ALS_TINT_250   0x28
 
#define LTR303ALS_TINT_300   0x30
 
#define LTR303ALS_TINT_350   0x38
 
#define LTR303ALS_TINT_400   0x18
 
#define LTR303ALS_GAIN   1
 
#define LTR303ALS_TINT   100
 
#define LTR303ALS_TMEAS   200
 

Enumerations

enum  ltr303als_mode { LTR303ALS_MODE_ONE_SHOT , LTR303ALS_MODE_CONTINUOUS }
 
enum  ambient8_status { AMBIENT8_ST_OK = 0 , AMBIENT8_ST_FAIL = 1 , AMBIENT8_ST_INVALID = 2 }
 
enum  sif_ltr303als_reg_address {
  LTR303ALS_REG_CONTROL = 0x80 , LTR303ALS_REG_MEAS_RATE = 0x85 , LTR303ALS_REG_PART_ID = 0x86 , LTR303ALS_REG_MANUFAC_ID = 0x87 ,
  LTR303ALS_REG_DATA_CH1_0 = 0x88 , LTR303ALS_REG_DATA_CH1_1 = 0x89 , LTR303ALS_REG_DATA_CH0_0 = 0x8A , LTR303ALS_REG_DATA_CH0_1 = 0x8B ,
  LTR303ALS_REG_STATUS = 0x8C , LTR303ALS_REG_INTERRUPT = 0x8F , LTR303ALS_REG_THRES_UP_0 = 0x97 , LTR303ALS_REG_THRES_UP_1 = 0x98 ,
  LTR303ALS_REG_THRES_LOW_0 = 0x99 , LTR303ALS_REG_THRES_LOW_1 = 0x9A , LTR303ALS_REG_INT_PERS = 0x9E , REG_LTR303ALS_CONTR = 0x80 ,
  REG_LTR303ALS_MEAS_RATE = 0x85 , REG_LTR303ALS_PART_ID = 0x86 , REG_LTR303ALS_MANUFAC_ID = 0x87 , REG_LTR303ALS_DATA_CH1_0 = 0x88 ,
  REG_LTR303ALS_DATA_CH1_1 = 0x89 , REG_LTR303ALS_DATA_CH0_0 = 0x8A , REG_LTR303ALS_DATA_CH0_1 = 0x8B , REG_LTR303ALS_STATUS = 0x8C ,
  REG_LTR303ALS_INTERRUPT = 0x8F , REG_LTR303ALS_THRES_UP_0 = 0x97 , REG_LTR303ALS_THRES_UP_1 = 0x98 , REG_LTR303ALS_THRES_LOW_0 = 0x99 ,
  REG_LTR303ALS_THRES_LOW_1 = 0x9A , REG_LTR303ALS_INT_PERS = 0x9E
}
 

Functions

uint8_t MIKROSDK_AMBIENT8_Initialise (void)
 
uint8_t MIKROSDK_AMBIENT8_Reinitialise (void)
 
uint8_t MIKROSDK_AMBIENT8_Reconfigure (uint16_t meastime, uint16_t inttime, uint8_t gain)
 
uint8_t MIKROSDK_AMBIENT8_Acquire (uint32_t *illuminance_ch0, uint32_t *illuminance_ch1, uint32_t *illuminance_ambient)
 

Detailed Description

mikrosdk interface

Macro Definition Documentation

◆ AMBIENT8_DEVICE_ADDRESS

#define AMBIENT8_DEVICE_ADDRESS   0x29

◆ LTR303ALS_DATA_STATUS

#define LTR303ALS_DATA_STATUS   0x04

◆ LTR303ALS_DATA_VALID

#define LTR303ALS_DATA_VALID   0x80

◆ LTR303ALS_GAIN

#define LTR303ALS_GAIN   1

◆ LTR303ALS_GAIN_1X

#define LTR303ALS_GAIN_1X   0x00

◆ LTR303ALS_GAIN_2X

#define LTR303ALS_GAIN_2X   0x04

◆ LTR303ALS_GAIN_48X

#define LTR303ALS_GAIN_48X   0x18

◆ LTR303ALS_GAIN_4X

#define LTR303ALS_GAIN_4X   0x08

◆ LTR303ALS_GAIN_8X

#define LTR303ALS_GAIN_8X   0x0C

◆ LTR303ALS_GAIN_96X

#define LTR303ALS_GAIN_96X   0x1C

◆ LTR303ALS_MANFID

#define LTR303ALS_MANFID   0x05

◆ LTR303ALS_MODE

#define LTR303ALS_MODE   LTR303ALS_MODE_ONE_SHOT

◆ LTR303ALS_MODE_ACTIVE

#define LTR303ALS_MODE_ACTIVE   0x01

◆ LTR303ALS_MODE_STANDBY

#define LTR303ALS_MODE_STANDBY   0x00

◆ LTR303ALS_PARTID

#define LTR303ALS_PARTID   0xA0

◆ LTR303ALS_SW_RESET

#define LTR303ALS_SW_RESET   0x02

◆ LTR303ALS_T_ACTIVE

#define LTR303ALS_T_ACTIVE   10 /* time [ms] before data after setting active mode */

◆ LTR303ALS_T_POWERUP

#define LTR303ALS_T_POWERUP   100 /* time [ms] before data after power-up */

◆ LTR303ALS_TINT

#define LTR303ALS_TINT   100

◆ LTR303ALS_TINT_100

#define LTR303ALS_TINT_100   0x00

◆ LTR303ALS_TINT_150

#define LTR303ALS_TINT_150   0x20

◆ LTR303ALS_TINT_200

#define LTR303ALS_TINT_200   0x10

◆ LTR303ALS_TINT_250

#define LTR303ALS_TINT_250   0x28

◆ LTR303ALS_TINT_300

#define LTR303ALS_TINT_300   0x30

◆ LTR303ALS_TINT_350

#define LTR303ALS_TINT_350   0x38

◆ LTR303ALS_TINT_400

#define LTR303ALS_TINT_400   0x18

◆ LTR303ALS_TINT_50

#define LTR303ALS_TINT_50   0x08

◆ LTR303ALS_TMEAS

#define LTR303ALS_TMEAS   200

◆ LTR303ALS_TMEAS_100

#define LTR303ALS_TMEAS_100   0x01

◆ LTR303ALS_TMEAS_1000

#define LTR303ALS_TMEAS_1000   0x04

◆ LTR303ALS_TMEAS_200

#define LTR303ALS_TMEAS_200   0x02

◆ LTR303ALS_TMEAS_2000

#define LTR303ALS_TMEAS_2000   0x05

◆ LTR303ALS_TMEAS_50

#define LTR303ALS_TMEAS_50   0x00

◆ LTR303ALS_TMEAS_500

#define LTR303ALS_TMEAS_500   0x03

Enumeration Type Documentation

◆ ambient8_status

Enumerator
AMBIENT8_ST_OK 
AMBIENT8_ST_FAIL 
AMBIENT8_ST_INVALID 

◆ ltr303als_mode

Enumerator
LTR303ALS_MODE_ONE_SHOT 
LTR303ALS_MODE_CONTINUOUS 

◆ sif_ltr303als_reg_address

Enumerator
LTR303ALS_REG_CONTROL 
LTR303ALS_REG_MEAS_RATE 
LTR303ALS_REG_PART_ID 
LTR303ALS_REG_MANUFAC_ID 
LTR303ALS_REG_DATA_CH1_0 
LTR303ALS_REG_DATA_CH1_1 
LTR303ALS_REG_DATA_CH0_0 
LTR303ALS_REG_DATA_CH0_1 
LTR303ALS_REG_STATUS 
LTR303ALS_REG_INTERRUPT 
LTR303ALS_REG_THRES_UP_0 
LTR303ALS_REG_THRES_UP_1 
LTR303ALS_REG_THRES_LOW_0 
LTR303ALS_REG_THRES_LOW_1 
LTR303ALS_REG_INT_PERS 
REG_LTR303ALS_CONTR 
REG_LTR303ALS_MEAS_RATE 
REG_LTR303ALS_PART_ID 
REG_LTR303ALS_MANUFAC_ID 
REG_LTR303ALS_DATA_CH1_0 
REG_LTR303ALS_DATA_CH1_1 
REG_LTR303ALS_DATA_CH0_0 
REG_LTR303ALS_DATA_CH0_1 
REG_LTR303ALS_STATUS 
REG_LTR303ALS_INTERRUPT 
REG_LTR303ALS_THRES_UP_0 
REG_LTR303ALS_THRES_UP_1 
REG_LTR303ALS_THRES_LOW_0 
REG_LTR303ALS_THRES_LOW_1 
REG_LTR303ALS_INT_PERS 

Function Documentation

◆ MIKROSDK_AMBIENT8_Acquire()

uint8_t MIKROSDK_AMBIENT8_Acquire ( uint32_t *  illuminance_ch0,
uint32_t *  illuminance_ch1,
uint32_t *  illuminance_ambient 
)

◆ MIKROSDK_AMBIENT8_Initialise()

uint8_t MIKROSDK_AMBIENT8_Initialise ( void  )

◆ MIKROSDK_AMBIENT8_Reconfigure()

uint8_t MIKROSDK_AMBIENT8_Reconfigure ( uint16_t  meastime,
uint16_t  inttime,
uint8_t  gain 
)

◆ MIKROSDK_AMBIENT8_Reinitialise()

uint8_t MIKROSDK_AMBIENT8_Reinitialise ( void  )