diff options
| author | Claudio Takahasi <claudio.takahasi@openbossa.org> | 2012-01-19 15:36:59 -0300 |
|---|---|---|
| committer | Johan Hedberg <johan.hedberg@intel.com> | 2012-01-23 12:59:31 +0200 |
| commit | 5261599a9dafbb8f61964db8523640ab3f89aeb8 (patch) | |
| tree | d47f0b49c7bb479271e1fc3801b0708b74f11b3a /doc/proximity-api.txt | |
| parent | e9a6ba3c56700a4c86d812f1c1364ba0388bde2a (diff) | |
proximity-api: Add Proximity Reporter API
Adds API for Immediate Alert Service(IAS) abstraction. IAS is used
by Proximity Monitors and Find Me Locators to notify the user that
reporter/target has been found. This new interface combines Proximity
Reporter and Find Me Target in the same API providing the flexibility
to implement external applications to control alerts(including per
device alerts).
This abstraction allows the development of platform specific
applications to control Immediate Alert coming from Proximity Monitor
and Find Me Locator. This provides flexibility to define different level
and tone for each device. Use case: watch finding a mobile phone.
Diffstat (limited to 'doc/proximity-api.txt')
| -rw-r--r-- | doc/proximity-api.txt | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/doc/proximity-api.txt b/doc/proximity-api.txt index cf64bbfb..3e49149f 100644 --- a/doc/proximity-api.txt +++ b/doc/proximity-api.txt @@ -4,8 +4,8 @@ BlueZ D-Bus Proximity API description Copyright (C) 2011 Claudio Takahasi <claudio.takahasi@openbossa.org> -Proximity hierarchy -================= +Proximity Monitor hierarchy +=========================== Service org.bluez Interface org.bluez.ProximityMonitor @@ -52,3 +52,33 @@ Properties "none" will be emitted after the configured timeout. When changing the level, signal is the confirmation that the value was written in the remote. + +Proximity Reporter hierarchy +=========================== + +Shared service used by Proximity Path Loss and Find Me. Allows per device +alert level handling. + +Service org.bluez +Interface org.bluez.ProximityReporter +Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX + +Methods dict GetProperties() + + Returns all properties for the interface. See the + properties section for available properties. + +Signals PropertyChanged(string name, variant value) + + This signal indicates a changed value of a given + property. + +Properties + + string ImmediateAlertLevel [readonly] + + This property indicates that Immediate Alert Level + characteristic in the local Immediate Alert Service + was changed by the remote device. Property shared + between Path Loss and Find Me. Values: "none", "mild", + "high". |