korg/bluez
0
0
Fork 0
mirror of https://git.kernel.org/pub/scm/bluetooth/bluez.git synced 2024-11-26 05:34:23 +08:00
Code Issues Packages Projects Releases Wiki Activity
bb4d0e4fe7
bluez/doc/proximity-api.txt

57 lines
1.8 KiB
Plaintext
Raw Normal View History

Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
BlueZ D-Bus Proximity API description
***********************************
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.
2012-01-20 02:36:59 +08:00
Proximity Monitor hierarchy
===========================
Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
Service org.bluez
proximity: Append version to Proximity interfaces
2012-12-14 17:13:04 +08:00
Interface org.bluez.ProximityMonitor1
Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
doc: Update proximity API document
2012-11-09 20:33:20 +08:00
Properties string SignalLevel [readonly]
Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
Proximity API simplification Delegates the Immediate Alert Level control to the caller(client). Immediate Alert Service is shared between Path Loss and Find Me. Three signal level states are defined: "good", "regular" and "weak". Meaning that at least two thresholds are necessary to implement a proper state transition. "unknown" will be returned if the link is not active. For Path Loss, the logic to trigger the writting operation of the Immediate Alert Level characteristic needs to be implemented in the client. SignalLevel can be only one of the inputs to define when and which value to write in the characteristic.
2011-07-20 06:36:30 +08:00
Alert indicating that a threshold has been reached.
Possible values: "unknown", "good", "regular", "weak"
Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
string LinkLossAlertLevel [readwrite]
Persistent property. Sets the alert level in the
proximity reporter for link loss scenario. Values:
"none", "mild", "high".
Proximity API simplification Delegates the Immediate Alert Level control to the caller(client). Immediate Alert Service is shared between Path Loss and Find Me. Three signal level states are defined: "good", "regular" and "weak". Meaning that at least two thresholds are necessary to implement a proper state transition. "unknown" will be returned if the link is not active. For Path Loss, the logic to trigger the writting operation of the Immediate Alert Level characteristic needs to be implemented in the client. SignalLevel can be only one of the inputs to define when and which value to write in the characteristic.
2011-07-20 06:36:30 +08:00
string ImmediateAlertLevel [readwrite]
Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
Proximity API simplification Delegates the Immediate Alert Level control to the caller(client). Immediate Alert Service is shared between Path Loss and Find Me. Three signal level states are defined: "good", "regular" and "weak". Meaning that at least two thresholds are necessary to implement a proper state transition. "unknown" will be returned if the link is not active. For Path Loss, the logic to trigger the writting operation of the Immediate Alert Level characteristic needs to be implemented in the client. SignalLevel can be only one of the inputs to define when and which value to write in the characteristic.
2011-07-20 06:36:30 +08:00
Alert level to be written in the Immediate Alert Level.
Property shared between Path Loss and Find Me.
Add Proximity API Covers the Proximity Monitor for Link Loss, Tx Power and Immediate Alert services. This first proposal considers that the connections will be managed by the bluetoothd core based on the registered connection callbacks. Only one instance of Immediate Alert service is allowed, "Alert Level" characteristic of this service is used by Find Me and Path Loss. Note that "Alert Level" for Path Loss is a LOCAL property written in the Immediate Alert service when the threshold is reached. For Find Me the user/application needs to actively enable the alert in the Immediate Alert service. Link Loss has it's own instance of Alert Level characteristic.
2011-07-07 04:02:26 +08:00
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-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.
2012-01-20 02:36:59 +08:00
Proximity Reporter hierarchy
===========================
Shared service used by Proximity Path Loss and Find Me. Allows per device
alert level handling.
Service org.bluez
proximity: Append version to Proximity interfaces
2012-12-14 17:13:04 +08:00
Interface org.bluez.ProximityReporter1
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.
2012-01-20 02:36:59 +08:00
Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
doc: Update proximity API document
2012-11-09 20:33:20 +08:00
Properties string ImmediateAlertLevel [readonly]
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.
2012-01-20 02:36:59 +08:00
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".
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-20 02:38:22 +08:00
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".
Reference in New Issue Copy Permalink