From: Mathias Agopian <mathias@google.com>
Date: Tue, 3 May 2011 02:10:31 +0000 (-0700)
Subject: Improve ROTATION_VECTOR sensor documentation
X-Git-Tag: android-x86-4.4-r1~382^2
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=d93ff971bd507e92ac81c149079906d2123795af;p=android-x86%2Fhardware-libhardware.git

Improve ROTATION_VECTOR sensor documentation

Change-Id: Iebc978beadf365d63c60c04d54ce7331605348b3
---

diff --git a/include/hardware/sensors.h b/include/hardware/sensors.h
index fb83c3f..9c2aa2a 100644
--- a/include/hardware/sensors.h
+++ b/include/hardware/sensors.h
@@ -268,6 +268,18 @@ __BEGIN_DECLS
  * Elements of the rotation vector are unitless.  The x, y, and z axis are defined
  * in the same was as for the acceleration sensor.
  *
+ * The reference coordinate system is defined as a direct orthonormal basis,
+ * where:
+ *
+ * - X is defined as the vector product Y.Z (It is tangential to
+ * the ground at the device's current location and roughly points East).
+ *
+ * - Y is tangential to the ground at the device's current location and
+ * points towards the magnetic North Pole.
+ *
+ * - Z points towards the sky and is perpendicular to the ground.
+ *
+ *
  * The rotation-vector is stored as:
  *
  *   sensors_event_t.data[0] = x*sin(theta/2)