org.bluez.LEAdvertisement - Man Page
BlueZ D-Bus LEAdvertisement API documentation
Description
Advertising packets are structured data which is broadcast on the LE Advertising channels and available for all devices in range. Because of the limited space available in LE Advertising packets, each packet's contents must be carefully controlled.
The service daemon acts as a store for the Advertisement Data which is meant to be sent. It constructs the correct Advertisement Data from the structured data and configured the kernel to send the correct advertisement.
Interface
Specifies the Advertisement Data to be broadcast and some advertising parameters. Properties which are not present will not be included in the data. Required advertisement data types will always be included. All UUIDs are 128-bit versions in the API, and 16 or 32-bit versions of the same UUID will be used in the advertising data as appropriate.
- Service
org.bluez
- Interface
org.bluez.LEAdvertisement1
- Object path
freely definable
Methods
void Release() [noreply]
This method gets called when the service daemon removes the Advertisement. A client can use it to do cleanup tasks. There is no need to call UnregisterAdvertisement() because when this method gets called it has already been unregistered.
Properties
string Type [readonly]
Determines the type of advertising packet requested.
Possible values:
"broadcast"
"peripheral"
array{string} ServiceUUIDs
List of UUIDs to include in the "Service UUID" field of the Advertising Data.
dict ManufacturerData
Manufacturer Data fields to include in the Advertising Data. Keys are the Manufacturer ID to associate with the data.
array{string} SolicitUUIDs
Array of UUIDs to include in "Service Solicitation" Advertisement Data.
dict ServiceData
Service Data elements to include. The keys are the UUID to associate with the data.
dict Data
Advertising Data to include. Key is the advertising type and value is the data as byte array.
Note: Types already handled by other properties shall not be used.
Possible values:
- <type>
<byte array>
- Example:
<Transport Discovery> <Organization Flags...> 0x26 0x01 0x01...
bool Discoverable
Advertise as general discoverable. When present this will override adapter Discoverable property.
Note: This property shall not be set when Type is set to "broadcast".
uint16 DiscoverableTimeout
The discoverable timeout in seconds. A value of zero means that the timeout is disabled and it will stay in discoverable/limited mode forever.
Note: This property shall not be set when Type is set to "broadcast".
array{string} Includes
List of features to be included in the advertising packet.
Possible values:
See org.bluez.LEAdvertisingManager(5) SupportedIncludes property.
string LocalName
Local name to be used in the advertising report. If the string is too big to fit into the packet it will be truncated.
If this property is available 'local-name' cannot be present in the Includes.
uint16 Appearance
Appearance to be used in the advertising report.
Possible values: as found on GAP Service.
uint16_t Duration
Rotation duration of the advertisement in seconds. If there are other applications advertising no duration is set the default is 2 seconds.
uint16_t Timeout
Timeout of the advertisement in seconds. This defines the lifetime of the advertisement.
string SecondaryChannel
Secondary channel to be used. Primary channel is always set to "1M" except when "Coded" is set.
Possible value:
"1M" (default)
"2M"
"Coded"
uint32 MinInterval
Minimum advertising interval to be used by the advertising set, in milliseconds. Acceptable values are in the range [20ms, 10,485s]. If the provided MinInterval is larger than the provided MaxInterval, the registration will return failure.
uint32 MaxInterval
Maximum advertising interval to be used by the advertising set, in milliseconds. Acceptable values are in the range [20ms, 10,485s]. If the provided MinInterval is larger than the provided MaxInterval, the registration will return failure.
int16 TxPower
Requested transmission power of this advertising set. The provided value is used only if the "CanSetTxPower" feature is enabled on the org.bluez.LEAdvertisingManager(5). The provided value must be in range [-127 to +20], where units are in dBm.
Referenced By
org.bluez.LEAdvertisingManager(5).