QLowEnergyAdvertisingData#

The QLowEnergyAdvertisingData class represents the data to be broadcast during Bluetooth Low Energy advertising. More…

Synopsis#

Functions#

def discoverability ()
def includePowerLevel ()
def localName ()
def manufacturerData ()
def manufacturerId ()
def __ne__ (b)
def __eq__ (b)
def rawData ()
def services ()
def setDiscoverability (mode)
def setIncludePowerLevel (doInclude)
def setLocalName (name)
def setManufacturerData (id, data)
def setRawData (data)
def setServices (services)
def swap (other)

Static functions#

def invalidManufacturerId ()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

This data can include the device name, GATT services offered by the device, and so on. The data set via this class will be used when advertising is started by calling startAdvertising() . Objects of this class can represent an Advertising Data packet or a Scan Response packet.

Note

The actual data packets sent over the advertising channel cannot contain more than 31 bytes. If the variable-length data set via this class exceeds that limit, it will be left out of the packet or truncated, depending on the type. On Android, advertising will fail if advertising data is larger than 31 bytes. On Bluez DBus backend the advertising length limit and the behavior when it is exceeded is up to BlueZ; it may for example support extended advertising. For the most predictable behavior keep the advertising data short.

class PySide6.QtBluetooth.QLowEnergyAdvertisingData#

PySide6.QtBluetooth.QLowEnergyAdvertisingData(other)

Parameters:: other – PySide6.QtBluetooth.QLowEnergyAdvertisingData

Creates a new object of this class. All values are initialized to their defaults according to the Bluetooth Low Energy specification.

Constructs a new object of this class that is a copy of other.

PySide6.QtBluetooth.QLowEnergyAdvertisingData.Discoverability#

The discoverability of the advertising device as defined by the Generic Access Profile.

Constant

Description

QLowEnergyAdvertisingData.DiscoverabilityNone

The advertising device does not wish to be discoverable by scanning devices.

QLowEnergyAdvertisingData.DiscoverabilityLimited

The advertising device wishes to be discoverable with a high priority. Note that this mode is not compatible with using a white list. The value of filterPolicy() is always assumed to be IgnoreWhiteList when limited discoverability is used.

QLowEnergyAdvertisingData.DiscoverabilityGeneral

The advertising device wishes to be discoverable by scanning devices.

Constant	Description
QLowEnergyAdvertisingData.DiscoverabilityNone	The advertising device does not wish to be discoverable by scanning devices.
QLowEnergyAdvertisingData.DiscoverabilityLimited	The advertising device wishes to be discoverable with a high priority. Note that this mode is not compatible with using a white list. The value of `filterPolicy()` is always assumed to be `IgnoreWhiteList` when limited discoverability is used.
QLowEnergyAdvertisingData.DiscoverabilityGeneral	The advertising device wishes to be discoverable by scanning devices.

PySide6.QtBluetooth.QLowEnergyAdvertisingData.discoverability()#

Return type:: Discoverability

Returns the discoverability mode of the advertising device. The default is DiscoverabilityNone .

See also

setDiscoverability()

PySide6.QtBluetooth.QLowEnergyAdvertisingData.includePowerLevel()#

Return type:: bool

Returns whether to include the device’s transmit power level in the advertising data. The default is false.

See also

setIncludePowerLevel()

static PySide6.QtBluetooth.QLowEnergyAdvertisingData.invalidManufacturerId()#

Return type:: int

Returns an invalid manufacturer id. If this value is set as the manufacturer id (which it is by default), no manufacturer data will be present in the advertising data.

PySide6.QtBluetooth.QLowEnergyAdvertisingData.localName()#

Return type:: str

Returns the name of the local device that is to be advertised.

See also

setLocalName()

PySide6.QtBluetooth.QLowEnergyAdvertisingData.manufacturerData()#

Return type:: PySide6.QtCore.QByteArray

Returns the manufacturer data. The default is an empty byte array.

See also

setManufacturerData()

PySide6.QtBluetooth.QLowEnergyAdvertisingData.manufacturerId()#

Return type:: int

Returns the manufacturer id. The default is invalidManufacturerId() , which means the data will not be advertised.

PySide6.QtBluetooth.QLowEnergyAdvertisingData.__ne__(b)#

Parameters:: b – PySide6.QtBluetooth.QLowEnergyAdvertisingData
Return type:: bool

Returns true if data1 and data2 are not equal with respect to their public state, otherwise returns false.

PySide6.QtBluetooth.QLowEnergyAdvertisingData.__eq__(b)#

Parameters:: b – PySide6.QtBluetooth.QLowEnergyAdvertisingData
Return type:: bool

Returns true if data1 and data2 are equal with respect to their public state, otherwise returns false.

PySide6.QtBluetooth.QLowEnergyAdvertisingData.rawData()#

Return type:: PySide6.QtCore.QByteArray

Returns the user-supplied raw data to be advertised. The default is an empty byte array.

See also

setRawData()

PySide6.QtBluetooth.QLowEnergyAdvertisingData.services()#

Return type:: .list of QBluetoothUuid

Returns the list of service UUIDs to be advertised. By default, this list is empty.

See also

setServices()

PySide6.QtBluetooth.QLowEnergyAdvertisingData.setDiscoverability(mode)#

Parameters:: mode – Discoverability

Sets the discoverability type of the advertising device to mode.

Note

Discoverability information can only appear in an actual advertising data packet. If this object acts as scan response data, a call to this function will have no effect on the scan response sent.