summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBogdan Davidoaia <bogdan.davidoaia@linaro.org>2017-01-12 15:28:25 +0200
committerAnas Nashif <nashif@linux.intel.com>2017-01-15 01:09:33 +0000
commit30162aedf103479817faaf26fd7ddb56b6fc60b3 (patch)
treee66eeaa817e0f9209492ebe6f9a9c118ca7fa64a /doc
parent662a2d64761ae51d094344d48e1f193ded53ef82 (diff)
sensor: remove sensor value type
Remove the type field from the sensor value structure. All values will have the type previously defined by SENSOR_VALUE_TYPE_INT_PLUS_MICRO. This simplifies the interface, as apps will know what value type to expect. Apps that prefer to use double values can optain them using the sensor_value_to_double function. Change-Id: I3588d74258030eb16c3f89d8eead13cca4606b18 Signed-off-by: Bogdan Davidoaia <bogdan.davidoaia@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/subsystems/sensor.rst12
1 files changed, 4 insertions, 8 deletions
diff --git a/doc/subsystems/sensor.rst b/doc/subsystems/sensor.rst
index cc3a2cc35..82cec4c3e 100644
--- a/doc/subsystems/sensor.rst
+++ b/doc/subsystems/sensor.rst
@@ -31,15 +31,11 @@ Values
======
Sensor devices return results as :c:type:`struct sensor_value`. This
-representation avoids use of floating point operations on setups where they
-are not supported or desired.
+representation avoids use of floating point values as they may not be
+supported on certain setups.
-Most sensor values have a type of :c:macro:`SENSOR_TYPE_INT_PLUS_MICRO`.
-Other possible representations are listed below. Applications are
-responsible for correctly interpreting the :c:data:`type` field of a
-returned value.
-
-.. doxygenenum:: sensor_value_type
+.. doxygenstruct:: sensor_value
+ :members:
Fetching Values
===============