summaryrefslogtreecommitdiffstats
path: root/core/java/android/hardware/Sensor.java
blob: f5fed4f9031dd820d7532445363ac72dfd8894c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package android.hardware;

/** 
 * Class representing a sensor. Use {@link SensorManager#getSensorList}
 * to get the list of available Sensors.
 */
public class Sensor {

    /** 
     * A constant describing an accelerometer sensor type.
     * See {@link android.hardware.SensorEvent SensorEvent}
     * for more details.
     */
    public static final int TYPE_ACCELEROMETER  = 1;

    /** 
     * A constant describing a magnetic field sensor type.
     * See {@link android.hardware.SensorEvent SensorEvent}
     * for more details.
     */
    public static final int TYPE_MAGNETIC_FIELD = 2;
    
    /** 
     * A constant describing an orientation sensor type.
     * See {@link android.hardware.SensorEvent SensorEvent}
     * for more details.
     */
    public static final int TYPE_ORIENTATION    = 3;

    /** A constant describing a gyroscope sensor type */
    public static final int TYPE_GYROSCOPE      = 4;
    /**
     * A constant describing an light sensor type.
     * See {@link android.hardware.SensorEvent SensorEvent}
     * for more details.
     */
    public static final int TYPE_LIGHT          = 5;
    /** A constant describing a pressure sensor type */
    public static final int TYPE_PRESSURE       = 6;
    /** A constant describing a temperature sensor type */
    public static final int TYPE_TEMPERATURE    = 7;
    /**
     * A constant describing an proximity sensor type.
     * See {@link android.hardware.SensorEvent SensorEvent}
     * for more details.
     */
    public static final int TYPE_PROXIMITY      = 8;

    
    /** 
     * A constant describing all sensor types.
     */
    public static final int TYPE_ALL             = -1;

    /* Some of these fields are set only by the native bindings in 
     * SensorManager.
     */
    private String  mName;
    private String  mVendor;
    private int     mVersion;
    private int     mHandle;
    private int     mType;
    private float   mMaxRange;
    private float   mResolution;
    private float   mPower;
    private int     mLegacyType;
    
    
    Sensor() {
    }

    /**
     * @return name string of the sensor.
     */
    public String getName() {
        return mName;
    }

    /**
     * @return vendor string of this sensor.
     */
    public String getVendor() {
        return mVendor;
    }
    
    /**
     * @return generic type of this sensor.
     */
    public int getType() {
        return mType;
    }
    
    /**
     * @return version of the sensor's module.
     */
    public int getVersion() {
        return mVersion;
    }
    
    /**
     * @return maximum range of the sensor in the sensor's unit.
     */
    public float getMaximumRange() {
        return mMaxRange;
    }
    
    /**
     * @return resolution of the sensor in the sensor's unit.
     */
    public float getResolution() {
        return mResolution;
    }
    
    /**
     * @return the power in mA used by this sensor while in use
     */
    public float getPower() {
        return mPower;
    }
    
    int getHandle() {
        return mHandle;
    }
    
    void setRange(float max, float res) {
        mMaxRange = max;
        mResolution = res;
    }
    
    void setLegacyType(int legacyType) {
        mLegacyType = legacyType;
    }

    int getLegacyType() {
        return mLegacyType;
    }
}