Package org.bluez
Interface LEAdvertisement1
- All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface LEAdvertisement1
extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: advertising-api.txt.
Service: org.bluez
Interface: org.bluez.LEAdvertisement1
Object path:
freely definable
Supported properties:
string Type
Determines the type of advertising packet requested.
Possible values: "broadcast" or "peripheral"
array{string} ServiceUUIDs
List of UUIDs to include in the "Service UUID" field of
the Advertising Data.
dict ManufacturerData
Manufactuer 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 [Experimental]
Advertising Type to include in the Advertising
Data. 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 [Experimental]
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 [Experimental]
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: as found on
LEAdvertisingManager.SupportedIncludes
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 [Experimental]
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 [Experimental]
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 [Experimental]
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 [Experimental]
Requested transmission power of this advertising set.
The provided value is used only if the "CanSetTxPower"
feature is enabled on the Advertising Manager. The
provided value must be in range [-127 to +20], where
units are in dBm.
Based on bluez Documentation: advertising-api.txt.
Service: org.bluez
Interface: org.bluez.LEAdvertisement1
Object path:
freely definable
Supported properties:
string Type
Determines the type of advertising packet requested.
Possible values: "broadcast" or "peripheral"
array{string} ServiceUUIDs
List of UUIDs to include in the "Service UUID" field of
the Advertising Data.
dict ManufacturerData
Manufactuer 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 [Experimental]
Advertising Type to include in the Advertising
Data. 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 [Experimental]
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 [Experimental]
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: as found on
LEAdvertisingManager.SupportedIncludes
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 [Experimental]
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 [Experimental]
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 [Experimental]
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 [Experimental]
Requested transmission power of this advertising set.
The provided value is used only if the "CanSetTxPower"
feature is enabled on the Advertising Manager. The
provided value must be in range [-127 to +20], where
units are in dBm.
-
Method Summary
Modifier and TypeMethodDescriptionvoidRelease()From bluez documentation:
This method gets called when the service daemon
removes the Advertisement.Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface
getObjectPath, isRemote
-
Method Details
-
Release
void Release()From bluez documentation:
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.
-