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

Data Structures

struct  LightSensor_Handle_S
 structure to represent corresponding light sensor handle More...
 
struct  LightSensor_InterruptCallback_S
 structure to represent corresponding light sensor interrupt callback More...
 
struct  LightSensor_SensorInfo_S
 

Typedefs

typedef void(* deferredInterruptCallback )(void *, uint32_t)
 
typedef void(* interruptCallback )(void)
 
typedef enum
LightSensor_ConfigBrightness_E 
LightSensor_ConfigBrightness_T
 
typedef enum
LightSensor_ConfigBrightness_E
LightSensor_ConfigBrightnessPtr_T
 
typedef enum
LightSensor_ConfigInterrupt_E 
LightSensor_ConfigInterrupt_T
 
typedef enum
LightSensor_ConfigInterrupt_E
LightSensor_ConfigInterruptPtr_T
 
typedef enum
LightSensor_ConfigMode_E 
LightSensor_ConfigMode_T
 
typedef enum
LightSensor_ConfigMode_E
LightSensor_ConfigModePtr_T
 
typedef struct LightSensor_Handle_S LightSensor_Handle_T
 
typedef struct
LightSensor_Handle_S
LightSensor_HandlePtr_T
 
typedef enum
LightSensor_IntegrationTime_E 
LightSensor_IntegrationTime_T
 
typedef enum
LightSensor_IntegrationTime_E
LightSensor_IntegrationTimePtr_T
 
typedef struct
LightSensor_InterruptCallback_S 
LightSensor_InterruptCallback_T
 
typedef enum LightSensor_SensorID_E LightSensor_SensorID_T
 
typedef struct
LightSensor_SensorInfo_S 
LightSensor_SensorInfo_T
 
typedef struct
LightSensor_SensorInfo_S
LightSensor_SensorInfoPtr_T
 

Enumerations

enum  LightSensor_ConfigBrightness_E
 
enum  LightSensor_ConfigInterrupt_E
 
enum  LightSensor_ConfigMode_E
 
enum  LightSensor_IntegrationTime_E
 
enum  LightSensor_SensorID_E
 

Functions

Retcode_T LightSensor_configureThresholdInterrupt (LightSensor_HandlePtr_T handle, uint32_t upperThreshold, uint32_t lowerThreshold, uint32_t thresholdTimer)
 function responsible to set interrupt conditions, that means, threshold boundaries and threshold timer for lightsensor interrupt. Interrupt will be fired if the light intensity is crossed threshold boundaries for a window period defined in threshold timer.User must register the callback before calling configuring interrupt More...
 
Retcode_T LightSensor_deInit (LightSensor_HandlePtr_T handle)
 DeInitializes the light sensor referenced by the passed handle. More...
 
Retcode_T LightSensor_disableInterrupt (LightSensor_HandlePtr_T handle)
 Disable Interrupt type on the handle. More...
 
Retcode_T LightSensor_getInterruptStatus (LightSensor_HandlePtr_T handle, LightSensor_ConfigInterruptPtr_T interruptStatus)
 function to read light sensor interrupt status register More...
 
Retcode_T LightSensor_init (LightSensor_HandlePtr_T handle)
 Initializes the LightSensor referenced by the passed handle. More...
 
Retcode_T LightSensor_readLuxData (LightSensor_HandlePtr_T handle, uint32_t *luxData)
 function to read sensor data in milli lux. More...
 
Retcode_T LightSensor_readRawData (LightSensor_HandlePtr_T handle, uint16_t *luxData)
 Reads raw sensor data from light sensor referenced by the passed handle. More...
 
Retcode_T LightSensor_registerDeferredCallback (LightSensor_HandlePtr_T handle, deferredInterruptCallback deferredCallback)
 function responsible to register deferred interrupt handler for light sensor. When user registers deferred callback their callback will be executed in timer daemon context, where there is no restriction of using delay functions and/or APIs related to bus access. More...
 
Retcode_T LightSensor_registerRealTimeCallback (LightSensor_HandlePtr_T handle, interruptCallback realTimeCallback)
 function responsible to register real time interrupt handler for light sensor. When user registers real time callback their callback will be executed in ISR context. User must not use any delay functions or bus access in ISR context. More...
 
Retcode_T LightSensor_setBrightness (LightSensor_HandlePtr_T handle, LightSensor_ConfigBrightness_T brightness)
 function to set brightness to low or high for light sensor More...
 
Retcode_T LightSensor_setContinuousMode (LightSensor_HandlePtr_T handle, LightSensor_ConfigMode_T continuousMode)
 Function to enable/disable the Continuous mode for the light sensor referenced by the passed handle. More...
 
Retcode_T LightSensor_setIntegrationTime (LightSensor_HandlePtr_T handle, LightSensor_IntegrationTime_T integrationTime)
 function to configure integration time of light sensor. More...
 
Retcode_T LightSensor_setManualMode (LightSensor_HandlePtr_T handle, LightSensor_ConfigMode_T manualMode)
 Function to enable/disable the Manual mode for the light sensor referenced by the passed handle. More...
 

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:48 by doxygen 1.8.8