Files | Data Structures | Typedefs | Enumerations | Functions

MAX44009 Sensor Library. More...

+ Collaboration diagram for MAX44009:

Files

file  BCDS_Max44009.h
 

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...
 

Detailed Description

Driver MAX44009 Light sensor module.


Data Structure Documentation

struct MAX44009_Init_S

structure to hold the initialization parameters of the sensor

Data Fields

MAX44009_delayFunc delayFunc
 
uint8_t dev_add
 
MAX44009_readReg readFunc
 
MAX44009_writeReg writeFunc
 

Field Documentation

MAX44009_delayFunc delayFunc

Delay function

uint8_t dev_add

I2c slave address

MAX44009_readReg readFunc

I2C bus read function

MAX44009_writeReg writeFunc

I2C bus write function

struct MAX44009_ManualModeConfig_S

structure to hold the configuration parameters for manual mode

Data Fields

MAX44009_ConfigBrightness_T brightness
 
MAX44009_IntegrationTime_T time
 

Field Documentation

Typedef Documentation

typedef void(* MAX44009_delayFunc)(uint32_t timeInMs)
Parameters
[in]timeInMstime in milliseconds
typedef int8_t(* MAX44009_readReg)(uint8_t dev_addr, uint8_t reg_addr, uint8_t *data_p, uint8_t r_len)
Parameters
[in]dev_addrdevice address
[in]reg_addrregister address
[in]data_pdata
[in]wr_lenlength of the data
Returns
int8_t 0 Success -1 Fail
typedef int8_t(* MAX44009_writeReg)(uint8_t dev_addr, uint8_t reg_addr, uint8_t *data_p, uint8_t wr_len)
Parameters
[in]dev_addrdevice address
[in]reg_addrregister address
[in]data_pdata
[in]wr_lenlength of the data
Returns
int8_t 0 Success -1 Fail

Enumeration Type Documentation

enum values to represent the Manual , continuous interrupt configuration modes and represents the interrupt status

Enumerator
MAX44009_DISABLE_MANUAL_MODE 

Manual mode disable

MAX44009_ENABLE_MANUAL_MODE 

Manual mode enable

MAX44009_DISABLE_CONTINOUS_MODE 

Continous mode disable

MAX44009_ENABLE_CONTINOUS_MODE 

Continous mode enable

MAX44009_DISABLE_INTERRUPT 

interrupt disable

MAX44009_ENABLE_INTERRUPT 

enable interrupt

MAX44009_NO_INTR_TRIGGER_EVENT 

no interrupt triggered

MAX44009_INTR_TRIGGER_EVENT 

interrupt triggered

enum to represent Ambient light sensor supported brightness configurations

Enumerator
MAX44009_NORMAL_BRIGHTNESS 

normal brightness

MAX44009_HIGH_BRIGHTNESS 

high brightness

MAX44009_OUT_OF_BRIGHTNESS 

Unsupported Brightness Range

enum to represent enabled or disabled of Sensor get or read operations

Enumerator
MAX44009_DISABLE 

indicates the disabled state

MAX44009_ENABLE 

indicates the enabled state

enum values to represent the supported integration time values by the ambient light sensor

Enumerator
MAX44009_800MS 

800 ms integration time(time taken for capturing lux intensity)

MAX44009_400MS 

400 ms integration time

MAX44009_200MS 

200 ms integration time

MAX44009_100MS 

100 ms integration time

MAX44009_50MS 

50 ms integration time

MAX44009_25MS 

25 ms integration time

MAX44009_12P5MS 

12.5 ms integration time

MAX44009_6P5MS 

6.5 ms integration time

MAX4409_OUT_OF_TIME 

Out of Integration Time Supported Range

enum values to represent the interrupt status

Enumerator
MAX44009_NO_INTR_EVENT_DETECTED 

no interrupt event triggered

MAX44009_INTR_EVENT_DETECTED 

interrupt event detected

enum to represent MAX44009 supported register address

Enumerator
MAX44009_INTERRUPT_STATUS_REG 

interrupt status register

MAX44009_INTERRUPT_ENABLE_REG 

interrupt enable register

MAX44009_CONFIGURATION_REG 

configuration register

MAX44009_LUX_HIGH_BYTE_REG 

lux high byte register

MAX44009_LUX_LOW_BYTE_REG 

lux low byte register

MAX44009_UPPER_THRESHOLD_REG 

upper threshold high byte register

MAX44009_LOWER_THRESHOLD_REG 

lower threshold high byte register

MAX44009_THRESHOLD_TIMER_REG 

threshold timer register

MAX44009_THRESHOLD_UNSUPPORTED 

Threshold Unsupported Range

Function Documentation

BCDS_DEPRECATED ( Retcode_T   MAX44009_initMAX44009_InitPtr_T configParams)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_Init
Parameters
[in]configParamsconfiguration parameters
Returns
RETCODE_OK MAX44009 Light sensor initialization success.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_setCdrMAX44009_ConfigBrightness_T cdr)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetCdr
Parameters
[in]cdrCDR value(from the provided enum value)
Returns
RETCODE_OK Setting cdr for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid CDR value.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
reflects the configured value only if Manual mode is enabled
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getCdruint8_t *cdr)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetCdr
Parameters
[out]cdrconfigured cdr value
Returns
RETCODE_OK Getting cdr for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid CDR value.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getConfigurationReguint8_t *configuredVal)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetConfigurationReg
Parameters
[out]configuredValthe read configuration register value.
Returns
RETCODE_OK Getting the configuration register value for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_setIntegrationTimeMAX44009_IntegrationTime_T time)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetIntegrationTime
Parameters
[in]timeintegration time
Returns
RETCODE_OK Configuration of integration time for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
reflects the configured value only if Manual mode is enabled
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getIntegrationTimeuint8_t *time)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetIntegrationTime
Parameters
[out]timeconfigured time
Returns
RETCODE_OK Getting of integration time for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getSensorDatauint16_t *sensorData)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetSensorData
Parameters
[out]sensorDataraw sensor data represented in the 16 bit output format [0 0 0 0 E3 E2 E1 E0 M7 M6 M5 M4 M3 M2 M1 M0] from [bit 15 to bit 0]. M7-M0:Mantissa and E3-E0:Exponent
Returns
RETCODE_OK Getting the MAX44009 Light sensor value successful.
RETCODE_INVALID_PARAM Invalid sensor data.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( uint32_t   MAX44009_getDataInMilliLuxuint16_t sensorData)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetDataInMilliLux
Parameters
[in]sensorDataraw sensor value
[out]sensorDatasensor value in milli lux
Returns
RETCODE_OK Converting the raw MAX44009 Light sensor value to Milli Lux successful.
BCDS_DEPRECATED ( Retcode_T   MAX44009_setUpperThresholduint8_t thresholdVal)

Function to set the lower threshold level of the sensor.

Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetUpperThreshold
Parameters
[in]thresholdValThreshold value that to be configured
Returns
RETCODE_OK Setting the Upper threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetLowerThreshold
Parameters
[in]thresholdValthreshold value that to be configured
Returns
RETCODE_OK Setting the lower threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getUpperThresholduint8_t *thresholdVal)

Function to get the Lower threshold value.

Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetUpperThreshold
Parameters
[out]thresholdValthe upper threshold value
Returns
RETCODE_OK Getting the upper threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetLowerThreshold
Parameters
[out]thresholdValthe Lower threshold value
Returns
RETCODE_OK Getting the lower threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_setThresholdTimeruint8_t thresholdTimerVal)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetThresholdTimer
Parameters
[in]thresholdTimerValthreshold timer value(100ms) that to be configured.
Returns
RETCODE_OK Setting the threshold timer for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getThresholdTimeruint8_t *thresholdTimerVal)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetThresholdTimer
Parameters
[out]thresholdTimerValthreshold timer value in 100ms.
Returns
RETCODE_OK Getting the threshold timer for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_setContinousModeRegMAX44009_ConfigMode_T configParam)

The function to configure interrupt.

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.

Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetContinousModeReg
Parameters
[in]configParamvalue of the continuous mode.
Returns
RETCODE_OK Setting the Continuous mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetManualModeReg
Parameters
[in]configParamvalue of the manual mode.
Returns
RETCODE_OK Setting the manual mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetIntrptReg
Parameters
[in]configParaminterrupt configured value.
Returns
RETCODE_OK Configuring the interrupt status for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getContinousModeReguint8_t *configParams)

The function to get Manual mode.

Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetContinousModeReg
Parameters
[out]configParamsgets the continuous mode value.
Returns
RETCODE_OK Getting the Continuous mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetManualModeReg
Parameters
[out]configParamsvalue of the manual mode.
Returns
RETCODE_OK Getting the manual mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getInterptStatusuint8_t *status)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetInterptStatus
Parameters
[out]statusthe interrupt triggered event status.
Returns
RETCODE_OK Getting the interrupt status for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getIntrptRegMAX44009_ConfigModePtr_T configParam)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetIntrptReg
Parameters
[out]configParamconfigured value.
Returns
RETCODE_OK Getting the interrupt status for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_getRegisterMAX44009_Registers_T regAddress, uint8_t *value)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_GetRegister
Parameters
[in]regAddressregister address that to be read
[out]valueconfigured value.
Returns
RETCODE_OK Getting the register value for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( Retcode_T   MAX44009_setRegisterMAX44009_Registers_T regAddress, uint8_t value)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_SetRegister
Parameters
[in]regAddressregister address that to be write
[in]valuethe value that to be configured
Returns
RETCODE_OK Setting the register value for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
BCDS_DEPRECATED ( void   MAX44009_deInitvoid)
Deprecated:
since version vxx.xx.xx, replaced by MAX44009_DeInit
void MAX44009_DeInit ( void  )

+ Here is the caller graph for this function:

Retcode_T MAX44009_GetCdr ( uint8_t *  cdr)
Parameters
[out]cdrconfigured cdr value
Returns
RETCODE_OK Getting cdr for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid CDR value.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetConfigurationReg ( uint8_t *  configuredVal)
Parameters
[out]configuredValthe read configuration register value.
Returns
RETCODE_OK Getting the configuration register value for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetContinousModeReg ( uint8_t *  configParams)
Parameters
[out]configParamsgets the continuous mode value.
Returns
RETCODE_OK Getting the Continuous mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
uint32_t MAX44009_GetDataInMilliLux ( uint16_t  sensorData)
Parameters
[in]sensorDataraw sensor value
[out]sensorDatasensor value in milli lux
Returns
RETCODE_OK Converting the raw MAX44009 Light sensor value to Milli Lux successful.

+ Here is the caller graph for this function:

Retcode_T MAX44009_GetIntegrationTime ( uint8_t *  time)
Parameters
[out]timeconfigured time
Returns
RETCODE_OK Getting of integration time for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetInterptStatus ( uint8_t *  status)
Parameters
[out]statusthe interrupt triggered event status.
Returns
RETCODE_OK Getting the interrupt status for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_GetIntrptReg ( MAX44009_ConfigModePtr_T  configParam)
Parameters
[out]configParamconfigured value.
Returns
RETCODE_OK Getting the interrupt status for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetLowerThreshold ( uint8_t *  thresholdVal)
Parameters
[out]thresholdValthe Lower threshold value
Returns
RETCODE_OK Getting the lower threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetManualModeReg ( uint8_t *  configParams)
Parameters
[out]configParamsvalue of the manual mode.
Returns
RETCODE_OK Getting the manual mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetRegister ( MAX44009_Registers_T  regAddress,
uint8_t *  value 
)
Parameters
[in]regAddressregister address that to be read
[out]valueconfigured value.
Returns
RETCODE_OK Getting the register value for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetSensorData ( uint16_t *  sensorData)
Parameters
[out]sensorDataraw sensor data represented in the 16 bit output format [0 0 0 0 E3 E2 E1 E0 M7 M6 M5 M4 M3 M2 M1 M0] from [bit 15 to bit 0]. M7-M0:Mantissa and E3-E0:Exponent
Returns
RETCODE_OK Getting the MAX44009 Light sensor value successful.
RETCODE_INVALID_PARAM Invalid sensor data.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_GetThresholdTimer ( uint8_t *  thresholdTimerVal)
Parameters
[out]thresholdTimerValthreshold timer value in 100ms.
Returns
RETCODE_OK Getting the threshold timer for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_GetUpperThreshold ( uint8_t *  thresholdVal)
Parameters
[out]thresholdValthe upper threshold value
Returns
RETCODE_OK Getting the upper threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_Init ( MAX44009_InitPtr_T  configParams)
Parameters
[in]configParamsconfiguration parameters
Returns
RETCODE_OK MAX44009 Light sensor initialization success.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetCdr ( MAX44009_ConfigBrightness_T  cdr)
Parameters
[in]cdrCDR value(from the provided enum value)
Returns
RETCODE_OK Setting cdr for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid CDR value.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
reflects the configured value only if Manual mode is enabled
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetContinousModeReg ( MAX44009_ConfigMode_T  configParam)
Parameters
[in]configParamvalue of the continuous mode.
Returns
RETCODE_OK Setting the Continuous mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetIntegrationTime ( MAX44009_IntegrationTime_T  time)
Parameters
[in]timeintegration time
Returns
RETCODE_OK Configuration of integration time for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
reflects the configured value only if Manual mode is enabled
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetIntrptReg ( MAX44009_ConfigMode_T  configParam)
Parameters
[in]configParaminterrupt configured value.
Returns
RETCODE_OK Configuring the interrupt status for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetLowerThreshold ( uint8_t  thresholdVal)
Parameters
[in]thresholdValthreshold value that to be configured
Returns
RETCODE_OK Setting the lower threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetManualModeReg ( MAX44009_ConfigMode_T  configParam)
Parameters
[in]configParamvalue of the manual mode.
Returns
RETCODE_OK Setting the manual mode for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
In case of any other error refer MAX44009_GetConfigurationReg error codes.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetRegister ( MAX44009_Registers_T  regAddress,
uint8_t  value 
)
Parameters
[in]regAddressregister address that to be write
[in]valuethe value that to be configured
Returns
RETCODE_OK Setting the register value for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).
Retcode_T MAX44009_SetThresholdTimer ( uint8_t  thresholdTimerVal)
Parameters
[in]thresholdTimerValthreshold timer value(100ms) that to be configured.
Returns
RETCODE_OK Setting the threshold timer for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:

Retcode_T MAX44009_SetUpperThreshold ( uint8_t  thresholdVal)
Parameters
[in]thresholdValThreshold value that to be configured
Returns
RETCODE_OK Setting the Upper threshold level for MAX44009 Light sensor successful.
RETCODE_INVALID_PARAM Invalid configuration parameter.
Note
The return value consist of (First 1 MSByte represents Package ID, Next byte represents Severity and Last 2 LSBytes represents error code).

+ Here is the caller graph for this function:


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