org.bluez.LEAdvertisement(5)

1ORG.BLUEZ.LEADVERTISEMENT(5L)inux System AdministratiOoRnG.BLUEZ.LEADVERTISEMENT(5)
2
3
4

NAME

6       org.bluez.LEAdvertisement  - BlueZ D-Bus LEAdvertisement API documenta‐
7       tion
8

DESCRIPTION

10       Advertising packets are structured data which is broadcast  on  the  LE
11       Advertising  channels  and available for all devices in range.  Because
12       of the limited space available in LE Advertising packets, each packet's
13       contents must be carefully controlled.
14
15       The  service daemon acts as a store for the Advertisement Data which is
16       meant to be sent. It constructs the correct Advertisement Data from the
17       structured  data  and  configured the kernel to send the correct adver‐
18       tisement.
19

INTERFACE

21       Specifies the Advertisement Data to be broadcast and  some  advertising
22       parameters.   Properties  which are not present will not be included in
23       the data.  Required advertisement data types will always  be  included.
24       All UUIDs are 128-bit versions in the API, and 16 or 32-bit versions of
25       the same UUID will be used in the advertising data as appropriate.
26
27       Service
28              org.bluez
29
30       Interface
31              org.bluez.LEAdvertisement1
32
33       Object path
34              freely definable
35
36   Methods
37   void Release() [noreply]
38          This method gets called when the service daemon removes  the  Adver‐
39          tisement.  A client can use it to do cleanup tasks. There is no need
40          to call UnregisterAdvertisement()  because  when  this  method  gets
41          called it has already been unregistered.
42
43   Properties
44   string Type [readonly]
45          Determines the type of advertising packet requested.
46
47          Possible values:
48
49          "broadcast"
50
51          "peripheral"
52
53   array{string} ServiceUUIDs
54          List  of  UUIDs to include in the "Service UUID" field of the Adver‐
55          tising Data.
56
57   dict ManufacturerData
58          Manufacturer Data fields to include in the Advertising  Data.   Keys
59          are the Manufacturer ID to associate with the data.
60
61   array{string} SolicitUUIDs
62          Array  of  UUIDs  to include in "Service Solicitation" Advertisement
63          Data.
64
65   dict ServiceData
66          Service Data elements to include. The keys are the UUID to associate
67          with the data.
68
69   dict Data [Experimental]
70          Advertising  Data  to include. Key is the advertising type and value
71          is the data as byte array.
72
73          Note: Types already handled by other properties shall not be used.
74
75          Possible values:
76
77          <type> <byte array>
78
79          Example:
80                 <Transport   Discovery>    <Organization    Flags...>    0x26
81                 0x01         0x01...
82
83   bool Discoverable [Experimental]
84          Advertise  as  general discoverable. When present this will override
85          adapter Discoverable property.
86
87          Note: This property shall not be set when Type  is  set  to  "broad‐
88          cast".
89
90   uint16 DiscoverableTimeout [Experimental]
91          The  discoverable timeout in seconds. A value of zero means that the
92          timeout is disabled and it will stay  in  discoverable/limited  mode
93          forever.
94
95          Note:  This  property  shall  not be set when Type is set to "broad‐
96          cast".
97
98   array{string} Includes
99          List of features to be included in the advertising packet.
100
101          Possible values:
102
103          See org.bluez.LEAdvertisingManager(5) SupportedIncludes property.
104
105   string LocalName
106          Local name to be used in the advertising report. If  the  string  is
107          too big to fit into the packet it will be truncated.
108
109          If  this property is available 'local-name' cannot be present in the
110          Includes.
111
112   uint16 Appearance
113          Appearance to be used in the advertising report.
114
115          Possible values: as found on GAP Service.
116
117   uint16_t Duration
118          Rotation duration of the advertisement  in  seconds.  If  there  are
119          other  applications  advertising no duration is set the default is 2
120          seconds.
121
122   uint16_t Timeout
123          Timeout of the advertisement in seconds. This defines  the  lifetime
124          of the advertisement.
125
126   string SecondaryChannel [Experimental]
127          Secondary  channel to be used. Primary channel is always set to "1M"
128          except when "Coded" is set.
129
130          Possible value:
131
132          "1M" (default)
133
134          "2M"
135
136          "Coded"
137
138   uint32 MinInterval [Experimental]
139          Minimum advertising interval to be used by the advertising  set,  in
140          milliseconds.  Acceptable  values  are in the range [20ms, 10,485s].
141          If the provided MinInterval is larger than the provided MaxInterval,
142          the registration will return failure.
143
144   uint32 MaxInterval [Experimental]
145          Maximum  advertising  interval to be used by the advertising set, in
146          milliseconds. Acceptable values are in the range [20ms, 10,485s]. If
147          the  provided  MinInterval  is larger than the provided MaxInterval,
148          the registration will return failure.
149
150   int16 TxPower [Experimental]
151          Requested transmission power of this advertising set.  The  provided
152          value  is used only if the "CanSetTxPower" feature is enabled on the
153          org.bluez.LEAdvertisingManager(5). The provided  value  must  be  in
154          range [-127 to +20], where units are in dBm.
155
156
157
158
159BlueZ                            October 2023     ORG.BLUEZ.LEADVERTISEMENT(5)