summaryrefslogtreecommitdiff
path: root/doc/proximity-api.txt
blob: 0c60d47b5d3ed1419ba7e622da6bf3a9c4af08f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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".