epoc32/include/sensrvilluminationsensor.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Channel data types definitions
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef SENSRVILLUMINATIONSENSOR_H
williamr@2
    21
#define SENSRVILLUMINATIONSENSOR_H
williamr@2
    22
williamr@2
    23
//  INCLUDES
williamr@2
    24
#include <e32base.h>
williamr@2
    25
#include <sensrvtypes.h> 
williamr@2
    26
williamr@2
    27
williamr@2
    28
// ILLUMINATION RELATED CHANNELS
williamr@2
    29
williamr@2
    30
/**
williamr@2
    31
* - Name:          Ambient light event channel type
williamr@2
    32
* - Type:          Event
williamr@2
    33
* - Datatype:      TSensrvAmbientLightData
williamr@2
    34
* - Description:   Ambient light events
williamr@2
    35
*/
williamr@2
    36
const TSensrvChannelTypeId KSensrvChannelTypeIdAmbientLightData = 0x2000BF16;
williamr@2
    37
williamr@2
    38
williamr@2
    39
// ILLUMINATION RELATED DATATYPES
williamr@2
    40
williamr@2
    41
class TSensrvAmbientLightData
williamr@2
    42
    {
williamr@2
    43
public:
williamr@2
    44
williamr@2
    45
    /**
williamr@2
    46
    * Brighness constants for ambien light sensor data channel.
williamr@2
    47
    */
williamr@2
    48
    static const TUint8 KAmbientLightVeryDark 	= 0;
williamr@2
    49
    static const TUint8 KAmbientLightDark 	    = 20;
williamr@2
    50
    static const TUint8 KAmbientLightTwilight 	= 40;
williamr@2
    51
    static const TUint8 KAmbientLightLight      = 60;
williamr@2
    52
    static const TUint8 KAmbientLightBright     = 80;
williamr@2
    53
    static const TUint8 KAmbientLightSunny      = 100;
williamr@2
    54
williamr@2
    55
    /**
williamr@2
    56
    * Channel data type Id number
williamr@2
    57
    */
williamr@2
    58
    static const TSensrvChannelDataTypeId KDataTypeId = 0x2000BF16;
williamr@2
    59
williamr@2
    60
	/**
williamr@2
    61
    * Channel data type index numbers
williamr@2
    62
    */
williamr@2
    63
	enum TSensrvAmbientLightDataIndexes
williamr@2
    64
        {
williamr@2
    65
        ETimeStamp = 0,
williamr@2
    66
        EAmbientLight
williamr@2
    67
        };
williamr@2
    68
williamr@2
    69
public:
williamr@2
    70
williamr@2
    71
    /**
williamr@2
    72
    * - Item name:   Sampling time
williamr@2
    73
    * - Item Index:  0
williamr@2
    74
    * - Description: Timestamp for a sample
williamr@2
    75
    */
williamr@2
    76
    TTime iTimeStamp;
williamr@2
    77
williamr@2
    78
    /**
williamr@2
    79
    * - Item name:   Ambient light
williamr@2
    80
    * - Item Index:  1
williamr@2
    81
    * - Description: Percentage value (0..100) of Ambient light sensor's brightness.
williamr@2
    82
    */
williamr@2
    83
    TUint8 iAmbientLight;
williamr@2
    84
    };
williamr@2
    85
williamr@2
    86
williamr@2
    87
#endif //SENSRVILLUMINATIONSENSOR_H
williamr@2
    88
williamr@2
    89
// End of File