1ORG.BLUEZ.ADVERTISEMENTMONILTiOnRu(x5)System AdminisOtRrGa.tBiLoUnEZ.ADVERTISEMENTMONITOR(5)
2
3
4

NAME

6       org.bluez.AdvertisementMonitor  -  BlueZ D-Bus AdvertisementMonitor API
7       documentation
8

DESCRIPTION

10       This API allows an client to specify a job of monitoring advertisements
11       by  registering  the  root of hierarchy and then exposing advertisement
12       monitors under the root with filtering conditions, thresholds  of  RSSI
13       and timers of RSSI thresholds.
14
15       Once a monitoring job is activated by bluetoothd(8), the client can ex‐
16       pect to get notified on the targeted advertisements no matter if  there
17       is    an   ongoing   discovery   session   (see   StartDiscovery()   in
18       org.bluez.Adapter(5)).
19

INTERFACE

21       Service
22              org.bluez
23
24       Interface
25              org.bluez.AdvertisementMonitor1 [experimental]
26
27       Object path
28              freely definable
29
30   Methods
31   void Release() [noreply]
32          This gets called as a signal for a client to perform clean-up when:
33
34          • Monitor cannot be activated after it was exposed
35
36          • Monitor has been deactivated.
37
38   void Activate() [noreply]
39          After a monitor was exposed, this gets called as a signal for client
40          to get acknowledged when a monitor has been activated, so the client
41          can expect to receive calls on DeviceFound() or DeviceLost().
42
43   void DeviceFound(object device) [noreply]
44          This gets called to notify the client of finding  the  targeted  de‐
45          vice.   Once  receiving the call, the client should start to monitor
46          the corresponding device to retrieve the changes on RSSI and  adver‐
47          tisement content.
48
49   void DeviceLost(object device) [noreply]
50          This gets called to notify the client of losing the targeted device.
51          Once receiving this call, the client should stop monitoring the cor‐
52          responding device.
53
54   Properties
55   string Type [read-only]
56          The  type of the monitor. See SupportedMonitorTypes in org.bluez.Ad‐
57          vertisementMonitorManager(5) for the available options.
58
59   int16 RSSILowThreshold [read-only, optional]
60          Used in conjunction with RSSILowTimeout to determine whether  a  de‐
61          vice  becomes  out-of-range.  Valid range is -127 to 20 (dBm), while
62          127 indicates unset.
63
64   int16 RSSIHighThreshold [read-only, optional]
65          Used in conjunction with RSSIHighTimeout to determine whether a  de‐
66          vice  becomes  in-range.  Valid range is -127 to 20 (dBm), while 127
67          indicates unset.
68
69   uint16 RSSILowTimeout [read-only, optional]
70          The time it takes to consider a device as out-of-range. If this many
71          seconds  elapses  without receiving any signal at least as strong as
72          RSSILowThreshold, a currently in-range device will be considered  as
73          out-of-range  (lost). Valid range is 1 to 300 (seconds), while 0 in‐
74          dicates unset.
75
76   uint16 RSSIHighTimeout [read-only, optional]
77          The time it takes to consider a device as  in-range.  If  this  many
78          seconds  elapses  while  we  continuouslyreceive signals at least as
79          strong as RSSIHighThreshold, a currently out-of-range device will be
80          considered  as  in-range (found). Valid range is 1 to 300 (seconds),
81          while 0 indicates unset.
82
83   uint16 RSSISamplingPeriod [read-only, optional]
84          Grouping rules on how to propagate the received advertisement  pack‐
85          ets to the client.
86
87          Possible values:
88
89          0      All  advertisement  packets  from  in-range  devices would be
90                 propagated.
91
92          255    Only the first advertisement packet of in-range devices would
93                 be  propagated.  If  the  device becomes lost, then the first
94                 packet when it is found again will also be propagated.
95
96          1 to 254
97                 Advertisement packets would be grouped into 100ms  *  N  time
98                 period. Packets in the same group will only be reported once,
99                 with the RSSI value being averaged out.
100
101          Currently this is unimplemented in user space, so the value is  only
102          used to be forwarded to the kernel.
103
104   array{(uint8, uint8, array{byte})} Patterns [read-only, optional]
105          If  the  Type  property  is set to "or_patterns", then this property
106          must exist and have at least one entry in the array.
107
108          The structure of a pattern contains the following:
109
110          uint8 start_position
111                 The index in an AD data field where the search  hould  start.
112                 The beginning of an AD data field is index 0.
113
114          uint8 AD_data_type
115                 See
116                 https://www.bluetooth.com/specifications/assigned-numbers/
117                 generic-access-profile/ for the possible allowed value.
118
119          array{byte} content_of_pattern
120                 This  is  the value of the pattern. The maximum length of the
121                 bytes is 31.
122
123
124
125
126BlueZ                            October 2023ORG.BLUEZ.ADVERTISEMENTMONITOR(5)
Impressum