diff options
| author | Andrzej Kaczmarek <andrzej.kaczmarek@tieto.com> | 2012-10-09 13:19:48 +0200 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@intel.com> | 2012-10-09 17:53:03 +0200 |
| commit | 7251c328399f86e95f8882f81f86e5f3bfa8b0fe (patch) | |
| tree | e971e05e10b4fcf1aadeea72191f3493b665882f | |
| parent | 3c10778c4025639c0370f3026d0db997ef0d5022 (diff) | |
thermometer: Update API document
This patch updates Thermometer API document to reflect changes in
Thermometer interface and introduction of ThermometerManager
interface and fixes minor formatiing inconsistencies.
| -rw-r--r-- | doc/thermometer-api.txt | 60 |
1 files changed, 31 insertions, 29 deletions
diff --git a/doc/thermometer-api.txt b/doc/thermometer-api.txt index 22712709..18288116 100644 --- a/doc/thermometer-api.txt +++ b/doc/thermometer-api.txt @@ -1,30 +1,16 @@ BlueZ D-Bus Thermometer API description -**************************************** +*************************************** Santiago Carot-Nemesio <sancane@gmail.com> -Health Thermometer Profile hierarchy -===================================== +Health Thermometer Manager hierarchy +==================================== Service org.bluez -Interface org.bluez.Thermometer -Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX - - -Methods void SetProperty(string name, variant value) - - Changes the value of the specified property. Only - read-write properties can be changed. On success - this will emit a PropertyChanged signal. +Interface org.bluez.ThermometerManager +Object path [variable prefix]/{hci0,hci1,...} - Possible Errors: org.bluez.Error.InvalidArguments - - dict GetProperties() - - Returns all properties for the interface. See the - Properties section for the available properties. - - RegisterWatcher(object agent) +Methods RegisterWatcher(object agent) Registers a watcher to monitor scanned measurements. This agent will be notified about final temperature @@ -36,30 +22,45 @@ Methods void SetProperty(string name, variant value) Unregisters a watcher. - Final and intermediate temperatures won't be notified to - this agent any more. - - Possible Errors: org.bluez.Error.InvalidArguments - org.bluez.Error.NotFound - EnableIntermediateMeasurement(object agent) Enables intermediate measurement notifications for this - agent if the thermometer supports it. + agent. Intermediate measurements will be enabled only + for thermometers which support it. Possible Errors: org.bluez.Error.InvalidArguments - org.bluez.Error.NotSupported DisableIntermediateMeasurement(object agent) Disables intermediate measurement notifications for this - agent. It will disable notifications in the thermometer + 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 +Health Thermometer Profile hierarchy +==================================== + +Service org.bluez +Interface org.bluez.Thermometer +Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX + + +Methods void SetProperty(string name, variant value) + + Changes the value of the specified property. Only + read-write properties can be changed. On success + this will emit a PropertyChanged signal. + + Possible Errors: org.bluez.Error.InvalidArguments + + dict GetProperties() + + Returns all properties for the interface. See the + Properties section for the available properties. + Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given @@ -91,6 +92,7 @@ Properties boolean Intermediate [readonly] Health Thermometer Watcher hierarchy ==================================== + Service unique name Interface org.bluez.ThermometerWatcher Object path freely definable |