Lightsensor.h

Go to the documentation of this file.

 
/*
 *  Copyright (C) 2010-2022 CrossControl AB - All rights reserved
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This source code is licensed under the proprietary CrossControl software
 * license v 1.0.Please refer to the software license text for details or
 * contact info@crosscontrol.com for more info.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */
/*
 *  File description:
 *  Light Sensor access.
 *  The lightsensor suported by this implementation is a TAOS TSL2550 for
 *  platforms other than VC.
 *  On the VC platform, the sensor is the Intersil ISL29035.
 *
 *  Note that reading the light sensor using average calculation at the
 *  same time as running the automatic backlight control is not supported.
 *  Also note that Lux values mentioned below (and in the Backlight class)
 *  are not necessarily true lux values. The values received are lower than
 *  true lux values, due to the light guide in the front panel, where some
 *  light is lost. It is still a measurement of the illuminance (in Lux).
 *
 *  Use the function GetLightsensor() to get a handle to pass on to the other functions.
 *  Use the method Lightsensor_release(LIGHTSENSORHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include lightsensor_example.cpp
 *
 ************************************************/
#ifndef CC_LIGHTSENSOR_H
#define CC_LIGHTSENSOR_H
 
#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *LIGHTSENSORHANDLE;
 
EXTERN_C
CCAUXDLL_API
LIGHTSENSORHANDLE
CCAUXDLL_CALLING_CONV
GetLightsensor(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Lightsensor_release(LIGHTSENSORHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_getIlluminance(LIGHTSENSORHANDLE, uint16_t *value);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_getIlluminance2(LIGHTSENSORHANDLE, uint16_t *value, uint8_t *ch0, uint8_t *ch1);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_getAverageIlluminance(LIGHTSENSORHANDLE, uint16_t *value);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_startAverageCalc(LIGHTSENSORHANDLE, uint32_t averageWndSize,
                                                        uint32_t rejectWndSize, uint32_t rejectDeltaInLux,
                                                        LightSensorSamplingMode mode);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_stopAverageCalc(LIGHTSENSORHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_getOperatingRange(LIGHTSENSORHANDLE, LightSensorOperationRange *range);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_setOperatingRange(LIGHTSENSORHANDLE, LightSensorOperationRange range);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_setActive(LIGHTSENSORHANDLE, ComponentLocation location);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Lightsensor_getActive(LIGHTSENSORHANDLE, ComponentLocation *location);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_LIGHTSENSOR_H */