Blob: org.bluez.LEAdvertisingManager.rst

Blob id: 464a2e5fb7264f6853ab93af315b83795b42e919

Size: 3.2 KB

  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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
==============================
org.bluez.LEAdvertisingManager
==============================

-------------------------------------------------
BlueZ D-Bus LEAvertisingManager API documentation
-------------------------------------------------

:Version: BlueZ
:Date: October 2023
:Manual section: 5
:Manual group: Linux System Administration

Interface
=========

The Advertising Manager allows external applications to register Advertisement
Data which should be broadcast to devices.  Advertisement Data elements must
follow the API for LE Advertisement Data described above.

:Service:	org.bluez
:Interface:	org.bluez.LEAdvertisingManager1
:Object path:	/org/bluez/{hci0,hci1,...}

Methods
-------

void RegisterAdvertisement(object advertisement, dict options)
``````````````````````````````````````````````````````````````

Registers an advertisement object to be sent over the LE Advertising channel.

The service must implement **org.bluez.LEAdvertisement(5)** interface.

Possible errors:

:org.bluez.Error.InvalidArguments:

	Indicates that the object has invalid or conflicting properties.

:org.bluez.Error.AlreadyExists:

	Indicates the object is already registered.

:org.bluez.Error.InvalidLength:

	Indicates that the data provided generates a data packet which is too
	long.

:org.bluez.Error.NotPermitted:

	Indicates the maximum number of advertisement instances has been
	reached.

void UnregisterAdvertisement(object advertisement)
``````````````````````````````````````````````````

Unregisters an advertisement that has been previously registered using
**RegisterAdvertisement()**.

The object path parameter must match the same value that has been used on
registration.

Possible errors:

:org.bluez.Error.InvalidArguments:
:org.bluez.Error.DoesNotExist:

Properties
----------

byte ActiveInstances [readonly]
```````````````````````````````

Number of active advertising instances.

byte SupportedInstances [readonly]
``````````````````````````````````

Number of available advertising instances.

array{string} SupportedIncludes [readonly]
``````````````````````````````````````````

List of supported system includes.

Possible values:

:"tx-power":
:"appearance":
:"local-name":
:"rsi":

array{string} SupportedSecondaryChannels [readonly]
```````````````````````````````````````````````````

List of supported Secondary channels. Secondary channels can be used to
advertise with the corresponding PHY.

Possible values:

:"1M":
:"2M":
:"Coded":

dict SupportedCapabilities [readonly]
`````````````````````````````````````

Enumerates Advertising-related controller capabilities useful to the client.

Possible Values:

:byte MaxAdvLen:

	Max advertising data length

:byte MaxScnRspLen:

	Max advertising scan response length

:int16 MinTxPower:

	Min advertising tx power (dBm)

:int16 MaxTxPower:

	Max advertising tx power (dBm)

array{string} SupportedFeatures [readonly,optional]
```````````````````````````````````````````````````

List of supported platform features. If no features are available on the
platform, the SupportedFeatures array will be empty.

Possible values:

:"CanSetTxPower":

	Indicates whether platform can specify tx power on each advertising
	instance.

:"HardwareOffload":

	Indicates whether multiple advertising will be offloaded to the
	controller.