Sensor.java revision 0f791a799dc81d93935fd2597297cf7ac2c0a044
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.hardware; 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2074cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian/** 2174cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * Class representing a sensor. Use {@link SensorManager#getSensorList} to get 2274cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * the list of available Sensors. 230f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * 240f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * @see SensorManager 250f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * @see SensorEventListener 260f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * @see SensorEvent 270f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class Sensor { 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3174cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian /** 3274cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * A constant describing an accelerometer sensor type. See 330f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * {@link android.hardware.SensorEvent#values SensorEvent.values} for more 340f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * details. 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3674cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_ACCELEROMETER = 1; 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3874cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian /** 3974cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * A constant describing a magnetic field sensor type. See 400f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * {@link android.hardware.SensorEvent#values SensorEvent.values} for more 410f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * details. 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int TYPE_MAGNETIC_FIELD = 2; 4474cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 4574cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian /** 4674cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * A constant describing an orientation sensor type. See 470f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * {@link android.hardware.SensorEvent#values SensorEvent.values} for more 480f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * details. 4974cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * 5061a449393cf29f3960b4e03ec3fad652dac51b88Mathias Agopian * @deprecated use {@link android.hardware.SensorManager#getOrientation 5174cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * SensorManager.getOrientation()} instead. 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5361a449393cf29f3960b4e03ec3fad652dac51b88Mathias Agopian @Deprecated 5474cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_ORIENTATION = 3; 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** A constant describing a gyroscope sensor type */ 5774cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_GYROSCOPE = 4; 5874cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 594115c518753052add46b017bb3044da6f6169a7bMike Lockwood /** 6074cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * A constant describing an light sensor type. See 610f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * {@link android.hardware.SensorEvent#values SensorEvent.values} for more 620f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * details. 634115c518753052add46b017bb3044da6f6169a7bMike Lockwood */ 6474cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_LIGHT = 5; 65210fc914db37b3cf77ebb3bf75b0b509a1ecb07cMathias Agopian 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** A constant describing a pressure sensor type */ 6774cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_PRESSURE = 6; 68210fc914db37b3cf77ebb3bf75b0b509a1ecb07cMathias Agopian 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** A constant describing a temperature sensor type */ 7074cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_TEMPERATURE = 7; 71210fc914db37b3cf77ebb3bf75b0b509a1ecb07cMathias Agopian 724115c518753052add46b017bb3044da6f6169a7bMike Lockwood /** 7374cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian * A constant describing an proximity sensor type. See 740f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * {@link android.hardware.SensorEvent#values SensorEvent.values} for more 750f791a799dc81d93935fd2597297cf7ac2c0a044Mathias Agopian * details. 764115c518753052add46b017bb3044da6f6169a7bMike Lockwood */ 7774cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_PROXIMITY = 8; 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7974cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian /** 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A constant describing all sensor types. 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8274cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian public static final int TYPE_ALL = -1; 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8474cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian /* Some of these fields are set only by the native bindings in 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SensorManager. 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String mName; 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String mVendor; 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mVersion; 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mHandle; 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mType; 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private float mMaxRange; 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private float mResolution; 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private float mPower; 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mLegacyType; 9674cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 9774cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Sensor() { 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return name string of the sensor. 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String getName() { 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mName; 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return vendor string of this sensor. 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String getVendor() { 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mVendor; 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11474cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return generic type of this sensor. 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getType() { 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mType; 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12174cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return version of the sensor's module. 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getVersion() { 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mVersion; 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12874cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return maximum range of the sensor in the sensor's unit. 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getMaximumRange() { 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMaxRange; 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13574cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return resolution of the sensor in the sensor's unit. 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getResolution() { 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mResolution; 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14274cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the power in mA used by this sensor while in use 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public float getPower() { 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPower; 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14974cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int getHandle() { 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mHandle; 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15374cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void setRange(float max, float res) { 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMaxRange = max; 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mResolution = res; 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15874cde2cee9e53006a710f4e80700cd560c2d0e4dMathias Agopian 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void setLegacyType(int legacyType) { 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLegacyType = legacyType; 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int getLegacyType() { 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLegacyType; 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 167