Contents

BluezQt::Adapter Class

class BluezQt::Adapter

Bluetooth adapter. More...

Header: #include <BluezQt/Adapter>
CMake: find_package(KF6 REQUIRED COMPONENTS BluezQt)
target_link_libraries(mytarget PRIVATE KF6::BluezQt)
Inherits: QObject

Properties

Public Functions

quint32 adapterClass() const
QString address() const
BluezQt::DevicePtr deviceForAddress(const QString &address) const
QList<BluezQt::DevicePtr> devices() const
quint32 discoverableTimeout() const
BluezQt::GattManagerPtr gattManager() const
BluezQt::PendingCall *getDiscoveryFilters()
bool isDiscoverable() const
bool isDiscovering()
bool isPairable() const
bool isPowered() const
BluezQt::LEAdvertisingManagerPtr leAdvertisingManager() const
BluezQt::MediaPtr media() const
QString modalias() const
QString name() const
quint32 pairableTimeout() const
BluezQt::PendingCall *removeDevice(BluezQt::DevicePtr device)
BluezQt::PendingCall *setDiscoverable(bool discoverable)
BluezQt::PendingCall *setDiscoverableTimeout(quint32 timeout)
BluezQt::PendingCall *setDiscoveryFilter(const QVariantMap &filter)
BluezQt::PendingCall *setName(const QString &name)
BluezQt::PendingCall *setPairable(bool pairable)
BluezQt::PendingCall *setPairableTimeout(quint32 timeout)
BluezQt::PendingCall *setPowered(bool powered)
BluezQt::PendingCall *startDiscovery()
BluezQt::PendingCall *stopDiscovery()
QString systemName() const
BluezQt::AdapterPtr toSharedPtr() const
QString ubi() const
QStringList uuids() const

Signals

void adapterChanged(BluezQt::AdapterPtr adapter)
void adapterClassChanged(quint32 adapterClass)
void adapterRemoved(BluezQt::AdapterPtr adapter)
void deviceAdded(BluezQt::DevicePtr device)
void deviceChanged(BluezQt::DevicePtr device)
void deviceRemoved(BluezQt::DevicePtr device)
void discoverableChanged(bool discoverable)
void discoverableTimeoutChanged(quint32 timeout)
void discoveringChanged(bool discovering)
void gattManagerChanged(BluezQt::GattManagerPtr gattManager)
void leAdvertisingManagerChanged(BluezQt::LEAdvertisingManagerPtr leAdvertisingManager)
void mediaChanged(BluezQt::MediaPtr media)
void modaliasChanged(const QString &modalias)
void nameChanged(const QString &name)
void pairableChanged(bool pairable)
void pairableTimeoutChanged(quint32 timeout)
void poweredChanged(bool powered)
void systemNameChanged(const QString &systemName)
void uuidsChanged(const QStringList &uuids)

Detailed Description

This class represents a Bluetooth adapter.

Property Documentation

[read-only] adapterClass : const quint32

Access functions:

quint32 adapterClass() const

Notifier signal:

void adapterClassChanged(quint32 adapterClass)

[read-only] address : const QString

Access functions:

QString address() const

[read-only] devices : const QList<DevicePtr>

Access functions:

QList<BluezQt::DevicePtr> devices() const

discoverable : bool

Access functions:

bool isDiscoverable() const
BluezQt::PendingCall *setDiscoverable(bool discoverable)

Notifier signal:

void discoverableChanged(bool discoverable)

discoverableTimeout : quint32

Access functions:

quint32 discoverableTimeout() const
BluezQt::PendingCall *setDiscoverableTimeout(quint32 timeout)

Notifier signal:

void discoverableTimeoutChanged(quint32 timeout)

[read-only] discovering : const bool

Access functions:

bool isDiscovering()

Notifier signal:

void discoveringChanged(bool discovering)

[read-only] leAdvertisingManager : const LEAdvertisingManagerPtr

Access functions:

BluezQt::LEAdvertisingManagerPtr leAdvertisingManager() const

Notifier signal:

void leAdvertisingManagerChanged(BluezQt::LEAdvertisingManagerPtr leAdvertisingManager)

[read-only] media : const MediaPtr

Access functions:

BluezQt::MediaPtr media() const

Notifier signal:

void mediaChanged(BluezQt::MediaPtr media)

[read-only] modalias : const QString

Access functions:

QString modalias() const

Notifier signal:

void modaliasChanged(const QString &modalias)

name : QString

Access functions:

QString name() const
BluezQt::PendingCall *setName(const QString &name)

Notifier signal:

void nameChanged(const QString &name)

pairable : bool

Access functions:

bool isPairable() const
BluezQt::PendingCall *setPairable(bool pairable)

Notifier signal:

void pairableChanged(bool pairable)

pairableTimeout : quint32

Access functions:

quint32 pairableTimeout() const
BluezQt::PendingCall *setPairableTimeout(quint32 timeout)

Notifier signal:

void pairableTimeoutChanged(quint32 timeout)

powered : bool

Access functions:

bool isPowered() const
BluezQt::PendingCall *setPowered(bool powered)

Notifier signal:

void poweredChanged(bool powered)

[read-only] systemName : const QString

Access functions:

QString systemName() const

Notifier signal:

void systemNameChanged(const QString &systemName)

[read-only] ubi : const QString

Access functions:

QString ubi() const

[read-only] uuids : const QStringList

Access functions:

QStringList uuids() const

Notifier signal:

void uuidsChanged(const QStringList &uuids)

Member Function Documentation

[signal] void Adapter::adapterChanged(BluezQt::AdapterPtr adapter)

Indicates that at least one of the adapter's properties have changed.

quint32 Adapter::adapterClass() const

Returns a class of the adapter.

Note: Getter function for property adapterClass.

[signal] void Adapter::adapterClassChanged(quint32 adapterClass)

Indicates that adapter's class has changed.

Note: Notifier signal for property adapterClass.

[signal] void Adapter::adapterRemoved(BluezQt::AdapterPtr adapter)

Indicates that the adapter was removed.

QString Adapter::address() const

Returns an address of the adapter.

Example address: "1C:E5:C3:BC:94:7E"

Note: Getter function for property address.

[signal] void Adapter::deviceAdded(BluezQt::DevicePtr device)

Indicates that a new device was added (e.g. found by discovery).

[signal] void Adapter::deviceChanged(BluezQt::DevicePtr device)

Indicates that at least one of the device's properties has changed.

BluezQt::DevicePtr Adapter::deviceForAddress(const QString &address) const

Returns a device with the specified address.

The address follows a scheme similar to "40:79:6A:0C:39:75".

Returns null if there is no device with the specified address.

[signal] void Adapter::deviceRemoved(BluezQt::DevicePtr device)

Indicates that a device was removed.

QList<BluezQt::DevicePtr> Adapter::devices() const

Returns list of devices known by the adapter.

Note: Getter function for property devices.

[signal] void Adapter::discoverableChanged(bool discoverable)

Indicates that adapter's discoverable state has changed.

Note: Notifier signal for property discoverable.

quint32 Adapter::discoverableTimeout() const

Returns the discoverable timeout in seconds of the adapter.

The discoverable timeout defines how long the adapter stays in discoverable state after calling setDiscoverable(true).

Timeout 0 means infinitely.

Note: Getter function for property discoverableTimeout.

See also setDiscoverableTimeout().

[signal] void Adapter::discoverableTimeoutChanged(quint32 timeout)

Indicates that adapter's discoverable timeout has changed.

Note: Notifier signal for property discoverableTimeout.

[signal] void Adapter::discoveringChanged(bool discovering)

Indicates that adapter's discovering state has changed.

Note: Notifier signal for property discovering.

BluezQt::GattManagerPtr Adapter::gattManager() const

Returns the GATT manager interface for the adapter.

Returns null if the adapter has no GATT manager.

[signal] void Adapter::gattManagerChanged(BluezQt::GattManagerPtr gattManager)

Indicates that adapter's GATT manager has changed.

BluezQt::PendingCall *Adapter::getDiscoveryFilters()

Gets the discovery filters for the caller.

This returns the available filters that can be given to setDiscoveryFilter.

For details and available filter options, see the Bluez documentation for Adapter object.

Possible errors:

Returns string list pending call.

bool Adapter::isDiscoverable() const

Returns whether the adapter is discoverable by other devices.

Note: Getter function for property discoverable.

bool Adapter::isDiscovering()

Returns whether the adapter is discovering for other devices.

Note: Getter function for property discovering.

bool Adapter::isPairable() const

Returns whether the adapter is pairable with other devices.

Note: Getter function for property pairable.

bool Adapter::isPowered() const

Returns whether the adapter is powered on.

Note: Getter function for property powered.

BluezQt::LEAdvertisingManagerPtr Adapter::leAdvertisingManager() const

Returns the LE advertising manager interface for the adapter.

Returns null if the adapter has no Bluetooth LE.

Note: Getter function for property leAdvertisingManager.

[signal] void Adapter::leAdvertisingManagerChanged(BluezQt::LEAdvertisingManagerPtr leAdvertisingManager)

Indicates that adapter's LE advertising manager has changed.

Note: Notifier signal for property leAdvertisingManager.

BluezQt::MediaPtr Adapter::media() const

Returns the media interface for the adapter.

Returns null if the adapter has no media.

Note: Getter function for property media.

[signal] void Adapter::mediaChanged(BluezQt::MediaPtr media)

Indicates that adapter's media has changed.

Note: Notifier signal for property media.

QString Adapter::modalias() const

Returns local device ID in modalias format.

Note: Getter function for property modalias.

[signal] void Adapter::modaliasChanged(const QString &modalias)

Indicates that adapter's modalias has changed.

Note: Notifier signal for property modalias.

QString Adapter::name() const

Returns the name of the adapter.

Note: Getter function for property name.

See also setName().

[signal] void Adapter::nameChanged(const QString &name)

Indicates that adapter's name has changed.

Note: Notifier signal for property name.

[signal] void Adapter::pairableChanged(bool pairable)

Indicates that adapter's pairable state has changed.

Note: Notifier signal for property pairable.

quint32 Adapter::pairableTimeout() const

Returns the pairable timeout in seconds of the adapter.

The pairable timeout defines how long the adapter stays in pairable state after calling setPairable(true).

Timeout 0 means infinitely.

Note: Getter function for property pairableTimeout.

See also setPairableTimeout().

[signal] void Adapter::pairableTimeoutChanged(quint32 timeout)

Indicates that adapter's pairable timeout has changed.

Note: Notifier signal for property pairableTimeout.

[signal] void Adapter::poweredChanged(bool powered)

Indicates that adapter's powered state has changed.

Note: Notifier signal for property powered.

BluezQt::PendingCall *Adapter::removeDevice(BluezQt::DevicePtr device)

Removes the specified device.

It will also remove the pairing information.

Possible errors:

Returns void pending call.

BluezQt::PendingCall *Adapter::setDiscoverable(bool discoverable)

Sets the discoverable state of the adapter.

Returns void pending call.

Note: Setter function for property discoverable.

See also isDiscoverable().

BluezQt::PendingCall *Adapter::setDiscoverableTimeout(quint32 timeout)

Sets the discoverable timeout of the adapter in seconds.

Returns void pending call.

Note: Setter function for property discoverableTimeout.

See also discoverableTimeout().

BluezQt::PendingCall *Adapter::setDiscoveryFilter(const QVariantMap &filter)

Sets the discovery filter for the caller.

When this method is called with no filter parameter, the filter is removed.

For details and available filter options, see the Bluez documentation for Adapter object.

Possible errors:

Returns void pending call.

BluezQt::PendingCall *Adapter::setName(const QString &name)

Sets the name of the adapter.

Returns void pending call.

Note: Setter function for property name.

See also name().

BluezQt::PendingCall *Adapter::setPairable(bool pairable)

Sets the pairable state of the adapter.

Returns void pending call.

Note: Setter function for property pairable.

See also isPairable().

BluezQt::PendingCall *Adapter::setPairableTimeout(quint32 timeout)

Sets the pairable timeout of the adapter in seconds.

Returns void pending call.

Note: Setter function for property pairableTimeout.

See also pairableTimeout().

BluezQt::PendingCall *Adapter::setPowered(bool powered)

Sets the powered state of the adapter.

Returns void pending call.

Note: Setter function for property powered.

See also isPowered().

BluezQt::PendingCall *Adapter::startDiscovery()

Starts device discovery.

Possible errors:

Returns void pending call.

See also discoverableTimeout() and const.

BluezQt::PendingCall *Adapter::stopDiscovery()

Stops device discovery.

Possible errors:

Returns void pending call.

QString Adapter::systemName() const

Returns a system name (hostname) of the adapter.

Note: Getter function for property systemName.

[signal] void Adapter::systemNameChanged(const QString &systemName)

Indicates that adapter's system name has changed.

Note: Notifier signal for property systemName.

BluezQt::AdapterPtr Adapter::toSharedPtr() const

Returns a shared pointer from this.

QString Adapter::ubi() const

Returns an UBI of the adapter.

Example UBI: "/org/bluez/hci0"

Note: Getter function for property ubi.

QStringList Adapter::uuids() const

Returns UUIDs of supported services by the adapter in uppercase.

Note: Getter function for property uuids.

[signal] void Adapter::uuidsChanged(const QStringList &uuids)

Indicates that adapter's UUIDs has changed.

Note: Notifier signal for property uuids.