[PATCH 07/14] thermometer: Reformat MeasurementReceived description
From: Andrzej Kaczmarek <hidden>
Date: 2012-09-25 14:52:36
Subsystem:
the rest · Maintainer:
Linus Torvalds
MeasurementReceived method description is reformatted to be more readable and consistent with other API documents. Special values for Exponent and Mantissa fields specify now only NaN value as this is only special value defined by HTS specification for measurement. --- doc/thermometer-api.txt | 67 +++++++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 30 deletions(-)
diff --git a/doc/thermometer-api.txt b/doc/thermometer-api.txt
index b0b0fe2..1665aa1 100644
--- a/doc/thermometer-api.txt
+++ b/doc/thermometer-api.txt@@ -96,33 +96,40 @@ Service unique name Interface org.bluez.ThermometerWatcher Object path freely definable -Methods void MeasurementReceived(dict measure) - - This callback gets called when a measure has been - scanned in the thermometer. The Time entry in the dict - will be only present if the device supports storing of - data. The time value is expressed in seconds since epoch. - The value represented is (mantissa) x (10**exponent) - See foot note for special values when treating with - health devices. The Type entry is only present if the - measurement type is known. Otherwise, it is undefined. - - Dict is defined as below: - { - "Exponent" : int8, - "Mantissa" : int32, - "Unit" : ("Celsius" or "Fahrenheit"), - "Time" : uint64, - "Type" : ("Armpit", "Body", "Ear", "Finger", - "Intestines", "Mouth", "Rectum", "Toe", - "Tympanum"), - "Measurement" : ("Final" or "Intermediate"), - } - - For special cases, the exponent shall always be zero and - the mantissa should be one of following values: - - NRes = -(2**23) - NaN = +(2**23-1) - INFINITY = (2**23-2) - -INFINITY = -(2**23-2) +Methods void MeasurementReceived(dict measurement) + + This callback gets called when a measurement has been + scanned in the thermometer. + + Measurement: + + int16 Exponent: + int32 Mantissa: + + Measurement value is calculated as + (Mantissa) x (10^Exponent) + + In case of invalid or missing data, + Exponent is set to 0 and Mantissa is + set to 2^23-1 (0x7FFFFF hexadecimal). + + string Unit: + + Possible values: "Celsius" or "Fahrenheit" + + uint64 Time (optional): + + Time of measurement, if supported by device. + Expressed in seconds since epoch. + + string Type (optional): + + Only present if measurement type is known. + + Possible values: "Armpit", "Body", "Ear", + "Finger", "Intestines", "Mouth", + "Rectum", "Toe", "Tympanum" + + string Measurement: + + Possible values: "Final" or "Intermediate"
--
1.7.11.3