summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorMathias Agopian <mathias@google.com>2011-05-02 19:10:31 -0700
committerMathias Agopian <mathias@google.com>2011-05-02 19:10:31 -0700
commitd93ff971bd507e92ac81c149079906d2123795af (patch)
tree62bae011444e8850666c17519d08a8653c7a2143 /include
parent03dd9c671d03cd8645df44cea1f1fd297191def0 (diff)
downloadhardware_libhardware-d93ff971bd507e92ac81c149079906d2123795af.zip
hardware_libhardware-d93ff971bd507e92ac81c149079906d2123795af.tar.gz
hardware_libhardware-d93ff971bd507e92ac81c149079906d2123795af.tar.bz2
Improve ROTATION_VECTOR sensor documentation
Change-Id: Iebc978beadf365d63c60c04d54ce7331605348b3
Diffstat (limited to 'include')
-rw-r--r--include/hardware/sensors.h12
1 files changed, 12 insertions, 0 deletions
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)