1ORG.BLUEZ.LEADVERTISINGMANALGiEnRu(x5)System AdminisOtRrGa.tBiLoUnEZ.LEADVERTISINGMANAGER(5)
2
3
4

NAME

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

INTERFACE

10       The Advertising Manager allows external applications to register Adver‐
11       tisement Data which should be broadcast to devices.  Advertisement Data
12       elements must follow the API for LE Advertisement Data described above.
13
14       Service
15              org.bluez
16
17       Interface
18              org.bluez.LEAdvertisingManager1
19
20       Object path
21              /org/bluez/{hci0,hci1,...}
22
23   Methods
24   void RegisterAdvertisement(object advertisement, dict options)
25          Registers an advertisement object to be sent over the LE Advertising
26          channel.   The  service  must implement org.bluez.LEAdvertisement(5)
27          interface.
28
29          Possible errors:
30
31          org.bluez.Error.InvalidArguments
32                 Indicates that the object has invalid or conflicting  proper‐
33                 ties.
34
35          org.bluez.Error.AlreadyExists
36                 Indicates the object is already registered.
37
38          org.bluez.Error.InvalidLength
39                 Indicates  that  the  data  provided  generates a data packet
40                 which is too long
41
42          org.bluez.Error.NotPermitted
43                 Indicates the maximum number of advertisement  instances  has
44                 been reached.
45
46   void UnregisterAdvertisement(object advertisement)
47          Unregisters an advertisement that has been previously registered us‐
48          ing RegisterAdvertisement().  The object path parameter  must  match
49          the same value that has been used on registration.
50
51          Possible errors:
52
53          org.bluez.Error.InvalidArguments
54
55          org.bluez.Error.DoesNotExist
56
57   Properties
58   byte ActiveInstances [readonly]
59          Number of active advertising instances.
60
61   byte SupportedInstances [readonly]
62          Number of available advertising instances.
63
64   array{string} SupportedIncludes [readonly]
65          List of supported system includes.
66
67          Possible values:
68
69          "tx-power"
70
71          "appearance"
72
73          "local-name"
74
75          "rsi"
76
77   array{string} SupportedSecondaryChannels [readonly, Experimental]
78          List of supported Secondary channels. Secondary channels can be used
79          to advertise with the corresponding PHY.
80
81          Possible values:
82
83          "1M"
84
85          "2M"
86
87          "Coded"
88
89   dict SupportedCapabilities [readonly, Experimental]
90          Enumerates Advertising-related controller capabilities useful to the
91          client.
92
93          Possible Values:
94
95          byte MaxAdvLen
96                 Max advertising data length
97
98          byte MaxScnRspLen
99                 Max advertising scan response length
100
101          ;int16 MinTxPower:
102              Min advertising tx power (dBm)
103
104          int16 MaxTxPower
105                 Max advertising tx power (dBm)
106
107   array{string} SupportedFeatures [readonly,optional,Experimental]
108          List of supported platform features. If no features are available on
109          the platform, the SupportedFeatures array will be empty.
110
111          Possible values:
112
113          "CanSetTxPower"
114                 Indicates whether platform can specify tx power on  each  ad‐
115                 vertising instance.
116
117          "HardwareOffload"
118                 Indicates  whether  multiple advertising will be offloaded to
119                 the controller.
120
121
122
123
124BlueZ                            October 2023ORG.BLUEZ.LEADVERTISINGMANAGER(5)
Impressum