bluez/doc/proximity-api.txt
Claudio Takahasi f78ed180ee proximity-api: Add Link Loss Alert for Proximity Reporter API
PropertyChanged signal for LinkLossAlertLevel property is emitted when a
given remote device writes a new value for the Alert Level
characteristic in the local Link Loss service. Each platform is free to
define the actions for the detected signal.
2012-01-23 12:59:47 +02:00

91 lines
2.6 KiB
Plaintext

BlueZ D-Bus Proximity API description
***********************************
Copyright (C) 2011 Claudio Takahasi <claudio.takahasi@openbossa.org>
Proximity Monitor hierarchy
===========================
Service org.bluez
Interface org.bluez.ProximityMonitor
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.
void SetProperty(string name, variant value)
Changes the value of the specified property. Only
properties that are listed a read-write are changeable.
On success this will emit a PropertyChanged signal.
Possible Errors: org.bluez.Error.InvalidArguments
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of a given
property.
Properties
string SignalLevel[readonly]
Alert indicating that a threshold has been reached.
Possible values: "unknown", "good", "regular", "weak"
string LinkLossAlertLevel [readwrite]
Persistent property. Sets the alert level in the
proximity reporter for link loss scenario. Values:
"none", "mild", "high".
string ImmediateAlertLevel [readwrite]
Alert level to be written in the Immediate Alert Level.
Property shared between Path Loss and Find Me.
Values: "none", "mild", "high". Default value is
"none". Applications can disable the alert setting
the value to "none". If the "Target" is not found,
"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".
string LinkLossAlertLevel [readonly]
This property indicates that Alert Level characteristic
in the local Link Loss Service was changed by the
remote device. Values: "none", "mild", "high".