Data Structures | Typedefs | Enumerations | Functions
BCDS_Max44009.h File Reference
#include "BCDS_Retcode.h"
+ Include dependency graph for BCDS_Max44009.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  MAX44009_Init_S
 
struct  MAX44009_ManualModeConfig_S
 

Typedefs

typedef enum MAX44009_IntrpStatus_E MAX09_IntrpStatus_T
 
typedef enum
MAX44009_ConfigBrightness_E 
MAX44009_ConfigBrightness_T
 
typedef enum
MAX44009_ConfigBrightness_E
MAX44009_ConfigBrightnessPtr_T
 
typedef enum MAX09_ConfigMode_E MAX44009_ConfigMode_T
 
typedef enum MAX09_ConfigMode_EMAX44009_ConfigModePtr_T
 
typedef enum
MAX44009_ConfigStatus_E 
MAX44009_ConfigStatus_T
 
typedef void(* MAX44009_delayFunc )(uint32_t timeInMs)
 Delay function prototype. More...
 
typedef struct MAX44009_Init_S MAX44009_Init_T
 
typedef struct MAX44009_Init_SMAX44009_InitPtr_T
 
typedef enum
MAX44009_IntegrationTime_E 
MAX44009_IntegrationTime_T
 
typedef enum
MAX44009_IntegrationTime_E
MAX44009_IntegrationTimePtr_T
 
typedef struct
MAX44009_ManualModeConfig_S 
MAX44009_ManualModeConfig_T
 
typedef int8_t(* MAX44009_readReg )(uint8_t dev_addr, uint8_t reg_addr, uint8_t *data_p, uint8_t r_len)
 Sensor register Read function prototype. More...
 
typedef enum MAX44009_Registers_E MAX44009_Registers_T
 
typedef int8_t(* MAX44009_writeReg )(uint8_t dev_addr, uint8_t reg_addr, uint8_t *data_p, uint8_t wr_len)
 Sensor register write function prototype. More...
 

Enumerations

enum  MAX09_ConfigMode_E
 
enum  MAX44009_ConfigBrightness_E
 
enum  MAX44009_ConfigStatus_E
 
enum  MAX44009_IntegrationTime_E
 
enum  MAX44009_IntrpStatus_E
 
enum  MAX44009_Registers_E
 

Functions

 BCDS_DEPRECATED (Retcode_T MAX44009_init(MAX44009_InitPtr_T configParams))
 The function to initialize the ambient light sensor. It initializes and preserves the i2c address and i2c bus read , write functions for further communication between the sensor and the controller. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_setCdr(MAX44009_ConfigBrightness_T cdr))
 The function to set the CDR value of the Configuration register Api to configure the desired photodiode current that goes to ADC. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getCdr(uint8_t *cdr))
 The function to get the configured CDR value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getConfigurationReg(uint8_t *configuredVal))
 The function to get the configuration register value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_setIntegrationTime(MAX44009_IntegrationTime_T time))
 The function to set the integration time of the sensor. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getIntegrationTime(uint8_t *time))
 The function to get the configured integration time value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getSensorData(uint16_t *sensorData))
 The function to get the light sensor values in LUX. More...
 
 BCDS_DEPRECATED (uint32_t MAX44009_getDataInMilliLux(uint16_t sensorData))
 The function to convert the Raw sensor value to Milli Lux. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_setUpperThreshold(uint8_t thresholdVal))
 Function used to set the upper threshold level of the sensor. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getUpperThreshold(uint8_t *thresholdVal))
 Function to get the upper threshold value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_setThresholdTimer(uint8_t thresholdTimerVal))
 Function used to set the threshold timer. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getThresholdTimer(uint8_t *thresholdTimerVal))
 Function to get the threshold timer register value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_setContinousModeReg(MAX44009_ConfigMode_T configParam))
 The function to set Continuous mode MAX44009_DISABLE_CONTINOUS_MOD(default mode): the IC measures lux intensity only once every 800ms regardless of integration time MAX44009_ENABLE_CONTINOUS_MODE : The IC continuously measures lux intensity. That is, as soon as one reading is finished, a new one begins. If integration time is 6.25ms, readings are taken every 6.25ms If integration time is 800ms,readings are taken every 800ms. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getContinousModeReg(uint8_t *configParams))
 The function to get the Continuous mode. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getInterptStatus(uint8_t *status))
 The function to get the interrupt status. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getIntrptReg(MAX44009_ConfigModePtr_T configParam))
 The function to get interrupt register value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_getRegister(MAX44009_Registers_T regAddress, uint8_t *value))
 The function to get a register value. More...
 
 BCDS_DEPRECATED (Retcode_T MAX44009_setRegister(MAX44009_Registers_T regAddress, uint8_t value))
 The function to set a register value. More...
 
 BCDS_DEPRECATED (void MAX44009_deInit(void))
 The function to deinitialize the sensor. More...
 
void MAX44009_DeInit (void)
 The function to deinitialize the sensor. More...
 
Retcode_T MAX44009_GetCdr (uint8_t *cdr)
 The function to get the configured CDR value. More...
 
Retcode_T MAX44009_GetConfigurationReg (uint8_t *configuredVal)
 The function to get the configuration register value. More...
 
Retcode_T MAX44009_GetContinousModeReg (uint8_t *configParams)
 The function to get the Continuous mode. More...
 
uint32_t MAX44009_GetDataInMilliLux (uint16_t sensorData)
 The function to convert the Raw sensor value to Milli Lux. More...
 
Retcode_T MAX44009_GetIntegrationTime (uint8_t *time)
 The function to get the configured integration time value. More...
 
Retcode_T MAX44009_GetInterptStatus (uint8_t *status)
 The function to get the interrupt status. More...
 
Retcode_T MAX44009_GetIntrptReg (MAX44009_ConfigModePtr_T configParam)
 The function to get interrupt register value. More...
 
Retcode_T MAX44009_GetLowerThreshold (uint8_t *thresholdVal)
 Function to get the Lower threshold value. More...
 
Retcode_T MAX44009_GetManualModeReg (uint8_t *configParams)
 The function to get Manual mode. More...
 
Retcode_T MAX44009_GetRegister (MAX44009_Registers_T regAddress, uint8_t *value)
 The function to get a register value. More...
 
Retcode_T MAX44009_GetSensorData (uint16_t *sensorData)
 The function to get the light sensor values in LUX. More...
 
Retcode_T MAX44009_GetThresholdTimer (uint8_t *thresholdTimerVal)
 Function to get the threshold timer register value. More...
 
Retcode_T MAX44009_GetUpperThreshold (uint8_t *thresholdVal)
 Function to get the upper threshold value. More...
 
Retcode_T MAX44009_Init (MAX44009_InitPtr_T configParams)
 The function to initialize the ambient light sensor. It initializes and preserves the i2c address and i2c bus read , write functions for further communication between the sensor and the controller. More...
 
Retcode_T MAX44009_SetCdr (MAX44009_ConfigBrightness_T cdr)
 The function to set the CDR value of the Configuration register Api to configure the desired photodiode current that goes to ADC. More...
 
Retcode_T MAX44009_SetContinousModeReg (MAX44009_ConfigMode_T configParam)
 The function to set Continuous mode MAX44009_DISABLE_CONTINOUS_MOD(default mode): the IC measures lux intensity only once every 800ms regardless of integration time MAX44009_ENABLE_CONTINOUS_MODE : The IC continuously measures lux intensity. That is, as soon as one reading is finished, a new one begins. If integration time is 6.25ms, readings are taken every 6.25ms If integration time is 800ms,readings are taken every 800ms. More...
 
Retcode_T MAX44009_SetIntegrationTime (MAX44009_IntegrationTime_T time)
 The function to set the integration time of the sensor. More...
 
Retcode_T MAX44009_SetIntrptReg (MAX44009_ConfigMode_T configParam)
 The function to configure interrupt. More...
 
Retcode_T MAX44009_SetLowerThreshold (uint8_t thresholdVal)
 Function to set the lower threshold level of the sensor. More...
 
Retcode_T MAX44009_SetManualModeReg (MAX44009_ConfigMode_T configParam)
 The function to set Manual mode MAX44009_ENABLE_MANUAL_MODE : CDR, and TIM[2:0] bits can be programmed, MAX44009_DISABLE_MANUAL_MODE((default mode)) : CDR, TIM[2:0] bits are automatically determined by the internal autoranging circuitry of the IC. More...
 
Retcode_T MAX44009_SetRegister (MAX44009_Registers_T regAddress, uint8_t value)
 The function to set a register value. More...
 
Retcode_T MAX44009_SetThresholdTimer (uint8_t thresholdTimerVal)
 Function used to set the threshold timer. More...
 
Retcode_T MAX44009_SetUpperThreshold (uint8_t thresholdVal)
 Function used to set the upper threshold level of the sensor. More...
 

This documentation file has been automatically generated on Fri Oct 4 2019 03:47:26 by doxygen 1.8.8