summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMathias Agopian <mathias@google.com>2010-08-25 16:03:58 -0700
committerAndroid (Google) Code Review <android-gerrit@google.com>2010-08-25 16:03:58 -0700
commit94e939e8794727f4f74839de23c5ac5f0d9f84b3 (patch)
tree9aa0c0dc38d72c4a8e36c8196df6a6d9ae3ac383
parent8ac0983edafa064126c4480dd31047d1bb4ce111 (diff)
parent43c87e44fc0d7d7b37e039752c0dec093e227381 (diff)
downloadframeworks_base-94e939e8794727f4f74839de23c5ac5f0d9f84b3.zip
frameworks_base-94e939e8794727f4f74839de23c5ac5f0d9f84b3.tar.gz
frameworks_base-94e939e8794727f4f74839de23c5ac5f0d9f84b3.tar.bz2
Merge "Improve Sensors documentation a bit" into gingerbread
-rw-r--r--core/java/android/hardware/SensorManager.java19
1 files changed, 18 insertions, 1 deletions
diff --git a/core/java/android/hardware/SensorManager.java b/core/java/android/hardware/SensorManager.java
index 97921fe..0068724 100644
--- a/core/java/android/hardware/SensorManager.java
+++ b/core/java/android/hardware/SensorManager.java
@@ -34,11 +34,19 @@ import java.util.HashMap;
import java.util.List;
/**
+ * <p>
* SensorManager lets you access the device's {@link android.hardware.Sensor
* sensors}. Get an instance of this class by calling
* {@link android.content.Context#getSystemService(java.lang.String)
* Context.getSystemService()} with the argument
* {@link android.content.Context#SENSOR_SERVICE}.
+ * </p>
+ * <p>
+ * Always make sure to disable sensors you don't need, especially when your
+ * activity is paused. Failing to do so can drain the battery in just a few
+ * hours. Note that the system will <i>not</i> disable sensors automatically when
+ * the screen turns off.
+ * </p>
*
* <pre class="prettyprint">
* public class SensorActivity extends Activity, implements SensorEventListener {
@@ -48,13 +56,22 @@ import java.util.List;
* public SensorActivity() {
* mSensorManager = (SensorManager)getSystemService(SENSOR_SERVICE);
* mAccelerometer = mSensorManager.getDefaultSensor(Sensor.TYPE_ACCELEROMETER);
+ * }
+ *
+ * protected void onResume() {
+ * super.onResume();
* mSensorManager.registerListener(this, mAccelerometer, SensorManager.SENSOR_DELAY_NORMAL);
* }
*
+ * protected void onPause() {
+ * super.onPause();
+ * mSensorManager.unregisterListener(this);
+ * }
+ *
* public void onAccuracyChanged(Sensor sensor, int accuracy) {
* }
*
- * public abstract void onSensorChanged(SensorEvent event) {
+ * public void onSensorChanged(SensorEvent event) {
* }
* }
* </pre>