Sensor.java revision 462db220a2986f7d9fc3d7e3e6af6615570eaa0b 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17
18package android.hardware;
19
20/**
21 * Class representing a sensor. Use {@link SensorManager#getSensorList} to get
22 * the list of available Sensors.
23 *
24 * @see SensorManager
25 * @see SensorEventListener
26 * @see SensorEvent
27 *
28 */
29public class Sensor {
30
31    /**
32     * A constant describing an accelerometer sensor type. See
33     * {@link android.hardware.SensorEvent#values SensorEvent.values} for more
34     * details.
35     */
36    public static final int TYPE_ACCELEROMETER = 1;
37
38    /**
39     * A constant describing a magnetic field sensor type. See
40     * {@link android.hardware.SensorEvent#values SensorEvent.values} for more
41     * details.
42     */
43    public static final int TYPE_MAGNETIC_FIELD = 2;
44
45    /**
46     * A constant describing an orientation sensor type. See
47     * {@link android.hardware.SensorEvent#values SensorEvent.values} for more
48     * details.
49     *
50     * @deprecated use {@link android.hardware.SensorManager#getOrientation
51     *             SensorManager.getOrientation()} instead.
52     */
53    @Deprecated
54    public static final int TYPE_ORIENTATION = 3;
55
56    /** A constant describing a gyroscope sensor type */
57    public static final int TYPE_GYROSCOPE = 4;
58
59    /**
60     * A constant describing an light sensor type. See
61     * {@link android.hardware.SensorEvent#values SensorEvent.values} for more
62     * details.
63     */
64    public static final int TYPE_LIGHT = 5;
65
66    /** A constant describing a pressure sensor type */
67    public static final int TYPE_PRESSURE = 6;
68
69    /**
70     * A constant describing a temperature sensor type
71     *
72     * @deprecated use
73     *             {@link android.hardware.Sensor#TYPE_AMBIENT_TEMPERATURE
74     *             Sensor.TYPE_AMBIENT_TEMPERATURE} instead.
75     */
76    @Deprecated
77    public static final int TYPE_TEMPERATURE = 7;
78
79    /**
80     * A constant describing an proximity sensor type. See
81     * {@link android.hardware.SensorEvent#values SensorEvent.values} for more
82     * details.
83     */
84    public static final int TYPE_PROXIMITY = 8;
85
86    /**
87     * A constant describing a gravity sensor type.
88     * See {@link android.hardware.SensorEvent SensorEvent}
89     * for more details.
90     */
91    public static final int TYPE_GRAVITY = 9;
92
93    /**
94     * A constant describing a linear acceleration sensor type.
95     * See {@link android.hardware.SensorEvent SensorEvent}
96     * for more details.
97     */
98    public static final int TYPE_LINEAR_ACCELERATION = 10;
99
100    /**
101     * A constant describing a rotation vector sensor type.
102     * See {@link android.hardware.SensorEvent SensorEvent}
103     * for more details.
104     */
105    public static final int TYPE_ROTATION_VECTOR = 11;
106
107    /** A constant describing an ambient temperature sensor type */
108    public static final int TYPE_AMBIENT_TEMPERATURE = 13;
109
110    /**
111     * A constant describing all sensor types.
112     */
113    public static final int TYPE_ALL = -1;
114
115    /* Some of these fields are set only by the native bindings in
116     * SensorManager.
117     */
118    private String  mName;
119    private String  mVendor;
120    private int     mVersion;
121    private int     mHandle;
122    private int     mType;
123    private float   mMaxRange;
124    private float   mResolution;
125    private float   mPower;
126    private int     mMinDelay;
127    private int     mLegacyType;
128
129
130    Sensor() {
131    }
132
133    /**
134     * @return name string of the sensor.
135     */
136    public String getName() {
137        return mName;
138    }
139
140    /**
141     * @return vendor string of this sensor.
142     */
143    public String getVendor() {
144        return mVendor;
145    }
146
147    /**
148     * @return generic type of this sensor.
149     */
150    public int getType() {
151        return mType;
152    }
153
154    /**
155     * @return version of the sensor's module.
156     */
157    public int getVersion() {
158        return mVersion;
159    }
160
161    /**
162     * @return maximum range of the sensor in the sensor's unit.
163     */
164    public float getMaximumRange() {
165        return mMaxRange;
166    }
167
168    /**
169     * @return resolution of the sensor in the sensor's unit.
170     */
171    public float getResolution() {
172        return mResolution;
173    }
174
175    /**
176     * @return the power in mA used by this sensor while in use
177     */
178    public float getPower() {
179        return mPower;
180    }
181
182    /**
183     * @return the minimum delay allowed between two events in microsecond
184     * or zero if this sensor only returns a value when the data it's measuring
185     * changes.
186     */
187    public int getMinDelay() {
188        return mMinDelay;
189    }
190
191    int getHandle() {
192        return mHandle;
193    }
194
195    void setRange(float max, float res) {
196        mMaxRange = max;
197        mResolution = res;
198    }
199
200    void setLegacyType(int legacyType) {
201        mLegacyType = legacyType;
202    }
203
204    int getLegacyType() {
205        return mLegacyType;
206    }
207}
208