The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 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 | |
| 18 | package android.hardware; |
| 19 | |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 20 | /** |
| 21 | * Class representing a sensor. Use {@link SensorManager#getSensorList} to get |
| 22 | * the list of available Sensors. |
Mathias Agopian | 0f791a7 | 2010-06-22 21:55:01 -0700 | [diff] [blame] | 23 | * |
| 24 | * @see SensorManager |
| 25 | * @see SensorEventListener |
| 26 | * @see SensorEvent |
| 27 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 28 | */ |
| 29 | public class Sensor { |
| 30 | |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 31 | /** |
| 32 | * A constant describing an accelerometer sensor type. See |
Mathias Agopian | 0f791a7 | 2010-06-22 21:55:01 -0700 | [diff] [blame] | 33 | * {@link android.hardware.SensorEvent#values SensorEvent.values} for more |
| 34 | * details. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 35 | */ |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 36 | public static final int TYPE_ACCELEROMETER = 1; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 37 | |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 38 | /** |
| 39 | * A constant describing a magnetic field sensor type. See |
Mathias Agopian | 0f791a7 | 2010-06-22 21:55:01 -0700 | [diff] [blame] | 40 | * {@link android.hardware.SensorEvent#values SensorEvent.values} for more |
| 41 | * details. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 42 | */ |
| 43 | public static final int TYPE_MAGNETIC_FIELD = 2; |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * A constant describing an orientation sensor type. See |
Mathias Agopian | 0f791a7 | 2010-06-22 21:55:01 -0700 | [diff] [blame] | 47 | * {@link android.hardware.SensorEvent#values SensorEvent.values} for more |
| 48 | * details. |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 49 | * |
Mathias Agopian | 61a4493 | 2010-02-26 18:06:26 -0800 | [diff] [blame] | 50 | * @deprecated use {@link android.hardware.SensorManager#getOrientation |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 51 | * SensorManager.getOrientation()} instead. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 52 | */ |
Mathias Agopian | 61a4493 | 2010-02-26 18:06:26 -0800 | [diff] [blame] | 53 | @Deprecated |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 54 | public static final int TYPE_ORIENTATION = 3; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 55 | |
| 56 | /** A constant describing a gyroscope sensor type */ |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 57 | public static final int TYPE_GYROSCOPE = 4; |
| 58 | |
Mike Lockwood | 4115c51 | 2009-11-03 10:35:43 -0500 | [diff] [blame] | 59 | /** |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 60 | * A constant describing an light sensor type. See |
Mathias Agopian | 0f791a7 | 2010-06-22 21:55:01 -0700 | [diff] [blame] | 61 | * {@link android.hardware.SensorEvent#values SensorEvent.values} for more |
| 62 | * details. |
Mike Lockwood | 4115c51 | 2009-11-03 10:35:43 -0500 | [diff] [blame] | 63 | */ |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 64 | public static final int TYPE_LIGHT = 5; |
Mathias Agopian | 210fc91 | 2010-02-26 13:51:39 -0800 | [diff] [blame] | 65 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 66 | /** A constant describing a pressure sensor type */ |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 67 | public static final int TYPE_PRESSURE = 6; |
Mathias Agopian | 210fc91 | 2010-02-26 13:51:39 -0800 | [diff] [blame] | 68 | |
Mathias Agopian | 462db22 | 2011-03-22 18:44:26 -0700 | [diff] [blame] | 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 |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 77 | public static final int TYPE_TEMPERATURE = 7; |
Mathias Agopian | 210fc91 | 2010-02-26 13:51:39 -0800 | [diff] [blame] | 78 | |
Mike Lockwood | 4115c51 | 2009-11-03 10:35:43 -0500 | [diff] [blame] | 79 | /** |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 80 | * A constant describing an proximity sensor type. See |
Mathias Agopian | 0f791a7 | 2010-06-22 21:55:01 -0700 | [diff] [blame] | 81 | * {@link android.hardware.SensorEvent#values SensorEvent.values} for more |
| 82 | * details. |
Mike Lockwood | 4115c51 | 2009-11-03 10:35:43 -0500 | [diff] [blame] | 83 | */ |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 84 | public static final int TYPE_PROXIMITY = 8; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 85 | |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 86 | /** |
Kevin Powell | f35fd95 | 2010-07-19 19:10:40 -0700 | [diff] [blame] | 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 | |
Mathias Agopian | 462db22 | 2011-03-22 18:44:26 -0700 | [diff] [blame] | 107 | /** A constant describing an ambient temperature sensor type */ |
| 108 | public static final int TYPE_AMBIENT_TEMPERATURE = 13; |
| 109 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 110 | /** |
| 111 | * A constant describing all sensor types. |
| 112 | */ |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 113 | public static final int TYPE_ALL = -1; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 114 | |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 115 | /* Some of these fields are set only by the native bindings in |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 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; |
Mathias Agopian | 050b562 | 2010-07-29 16:51:38 -0700 | [diff] [blame] | 126 | private int mMinDelay; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 127 | private int mLegacyType; |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 128 | |
| 129 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 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 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 146 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 147 | /** |
| 148 | * @return generic type of this sensor. |
| 149 | */ |
| 150 | public int getType() { |
| 151 | return mType; |
| 152 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 153 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 154 | /** |
| 155 | * @return version of the sensor's module. |
| 156 | */ |
| 157 | public int getVersion() { |
| 158 | return mVersion; |
| 159 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 160 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 161 | /** |
| 162 | * @return maximum range of the sensor in the sensor's unit. |
| 163 | */ |
| 164 | public float getMaximumRange() { |
| 165 | return mMaxRange; |
| 166 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 167 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 168 | /** |
| 169 | * @return resolution of the sensor in the sensor's unit. |
| 170 | */ |
| 171 | public float getResolution() { |
| 172 | return mResolution; |
| 173 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 174 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 175 | /** |
| 176 | * @return the power in mA used by this sensor while in use |
| 177 | */ |
| 178 | public float getPower() { |
| 179 | return mPower; |
| 180 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 181 | |
Mathias Agopian | 050b562 | 2010-07-29 16:51:38 -0700 | [diff] [blame] | 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 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 191 | int getHandle() { |
| 192 | return mHandle; |
| 193 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 194 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 195 | void setRange(float max, float res) { |
| 196 | mMaxRange = max; |
| 197 | mResolution = res; |
| 198 | } |
Mathias Agopian | 74cde2c | 2010-06-16 18:55:46 -0700 | [diff] [blame] | 199 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 200 | void setLegacyType(int legacyType) { |
| 201 | mLegacyType = legacyType; |
| 202 | } |
| 203 | |
| 204 | int getLegacyType() { |
| 205 | return mLegacyType; |
| 206 | } |
| 207 | } |