diff options
| author | Johan Hedberg <johan.hedberg@intel.com> | 2012-10-09 17:58:40 +0200 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@intel.com> | 2012-10-09 17:58:40 +0200 |
| commit | 230abac0270147c5b224715dd749e798b21962ec (patch) | |
| tree | 193b1ed0c4640c4b89b2c1e13fdd5591995f289d /doc/thermometer-api.txt | |
| parent | 9d1380fc9fb013f77fa58b712d831ed0d9ae91d4 (diff) | |
| download | bluez-230abac0270147c5b224715dd749e798b21962ec.tar.gz | |
doc: Reformat thermometer-api.txt to follow 80-character rule
Diffstat (limited to 'doc/thermometer-api.txt')
| -rw-r--r-- | doc/thermometer-api.txt | 57 |
1 files changed, 32 insertions, 25 deletions
diff --git a/doc/thermometer-api.txt b/doc/thermometer-api.txt index 5bbd4bfc2..7b99800a1 100644 --- a/doc/thermometer-api.txt +++ b/doc/thermometer-api.txt @@ -24,18 +24,18 @@ Methods RegisterWatcher(object agent) EnableIntermediateMeasurement(object agent) - Enables intermediate measurement notifications for this - agent. Intermediate measurements will be enabled only - for thermometers which support it. + Enables intermediate measurement notifications + for this agent. Intermediate measurements will + be enabled only for thermometers which support it. Possible Errors: org.bluez.Error.InvalidArguments DisableIntermediateMeasurement(object agent) - Disables intermediate measurement notifications for this - agent. It will disable notifications in thermometers - when the last agent removes the watcher for intermediate - measurements. + Disables intermediate measurement notifications + for this agent. It will disable notifications in + thermometers when the last agent removes the + watcher for intermediate measurements. Possible Errors: org.bluez.Error.InvalidArguments org.bluez.Error.NotFound @@ -68,16 +68,17 @@ Signals PropertyChanged(string name, variant value) Properties boolean Intermediate [readonly] - True if the thermometer supports intermediate measurement - notifications. + True if the thermometer supports intermediate + measurement notifications. uint16 Interval (optional) [readwrite] - The Measurement Interval defines the time (in seconds) - between measurements. This interval is not related to - the intermediate measurements and must be defined into - a valid range. Setting it to zero means that no periodic - measurements will be taken. + The Measurement Interval defines the time (in + seconds) between measurements. This interval is + not related to the intermediate measurements and + must be defined into a valid range. Setting it + to zero means that no periodic measurements will + be taken. uint16 Maximum (optional) [readonly] @@ -114,32 +115,38 @@ Methods void MeasurementReceived(dict measurement) Measurement value is calculated as (Mantissa) * (10^Exponent) - For special cases Exponent is set to 0 - and Mantissa is set to one of following - values: + For special cases Exponent is + set to 0 and Mantissa is set to + one of following values: - +(2^23 - 1) NaN (invalid or missing data) + +(2^23 - 1) NaN (invalid or + missing data) -(2^23) NRes +(2^23 - 2) +Infinity -(2^23 - 2) -Infinity string Unit: - Possible values: "celsius" or "fahrenheit" + Possible values: "celsius" or + "fahrenheit" uint64 Time (optional): - Time of measurement, if supported by device. + Time of measurement, if + supported by device. Expressed in seconds since epoch. string Type (optional): - Only present if measurement type is known. + Only present if measurement type + is known. - Possible values: "armpit", "body", "ear", - "finger", "intestines", "mouth", - "rectum", "toe", "tympanum" + Possible values: "armpit", "body", + "ear", "finger", "intestines", + "mouth", "rectum", "toe", + "tympanum" string Measurement: - Possible values: "final" or "intermediate" + Possible values: "final" or + "intermediate" |