Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

BluezQt::GattDescriptorRemote Class

Bluetooth LE GATT descriptor. More...

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

List of all members, including inherited members

#Properties

• [read-only] characteristic : const GattCharacteristicRemotePtr
• [read-only] flags : QStringList
• [read-only] handle : quint16
• [read-only] ubi : const QString
• [read-only] uuid : QString
• [read-only] value : QByteArray

#Public Functions

• BluezQt::GattCharacteristicRemotePtr characteristic() const
• QStringList flags() const
• quint16 handle() const
• BluezQt::PendingCall *setHandle(quint16 handle)
• BluezQt::GattDescriptorRemotePtr toSharedPtr() const
• QString ubi() const
• QString uuid() const
• QByteArray value() const

#Public Slots

• BluezQt::PendingCall *readValue(const QVariantMap &options)
• BluezQt::PendingCall *writeValue(const QByteArray &value, const QVariantMap &options)

#Signals

• void descriptorChanged(BluezQt::GattDescriptorRemotePtr descriptor)
• void flagsChanged(QStringList flags)
• void handleChanged(quint16 handle)
• void uuidChanged(const QString &uuid)
• void valueChanged(const QByteArray value)

#Detailed Description

This class represents a Bluetooth LE GATT descriptor for the clients.

#Property Documentation

#[read-only] characteristic : const GattCharacteristicRemotePtr

Access functions:

• BluezQt::GattCharacteristicRemotePtr characteristic() const

#[read-only] flags : QStringList

Access functions:

• QStringList flags() const

Notifier signal:

• void flagsChanged(QStringList flags)

#[read-only] handle : quint16

Access functions:

• quint16 handle() const

Notifier signal:

• void handleChanged(quint16 handle)

#[read-only] ubi : const QString

Access functions:

• QString ubi() const

#[read-only] uuid : QString

Access functions:

• QString uuid() const

Notifier signal:

• void uuidChanged(const QString &uuid)

#[read-only] value : QByteArray

Access functions:

• QByteArray value() const

Notifier signal:

• void valueChanged(const QByteArray value)

#Member Function Documentation

#BluezQt::GattCharacteristicRemotePtr GattDescriptorRemote::characteristic() const

Returns the characteristic that owns that descriptor.

Note: Getter function for property characteristic.

#[signal] void GattDescriptorRemote::descriptorChanged(BluezQt::GattDescriptorRemotePtr descriptor)

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

#QStringList GattDescriptorRemote::flags() const

Returns flags the descriptor.

Note: Getter function for property flags.

#[signal] void GattDescriptorRemote::flagsChanged(QStringList flags)

Indicates that descriptor's flags have changed.

Note: Notifier signal for property flags.

#quint16 GattDescriptorRemote::handle() const

Returns descriptor handle.

Note: Getter function for property handle.

See also setHandle()

#[signal] void GattDescriptorRemote::handleChanged(quint16 handle)

Indicates that descriptor's handle has changed.

Note: Notifier signal for property handle.

#[slot] BluezQt::PendingCall *GattDescriptorRemote::readValue(const QVariantMap &options)

Read the value of the GATT descriptor.

Issues a request to read the value of the descriptor and returns the value if the operation was successful.

Possible errors:

• PendingCall::NotReady
• PendingCall::Failed
• PendingCall::InProgress
• PendingCall::AlreadyConnected

Returns QByteArray pending call.

#BluezQt::PendingCall *GattDescriptorRemote::setHandle(quint16 handle)

Sets the descriptor handle.

Returns void pending call.

See also handle()

#BluezQt::GattDescriptorRemotePtr GattDescriptorRemote::toSharedPtr() const

Returns a shared pointer from this.

#QString GattDescriptorRemote::ubi() const

Returns the UBI of the GATT descriptor.

Example UBI: "/org/bluez/hci0/dev_40_79_6A_0C_39_75"

Note: Getter function for property ubi.

#QString GattDescriptorRemote::uuid() const

Returns the uuid of the descriptor.

Note: Getter function for property uuid.

#[signal] void GattDescriptorRemote::uuidChanged(const QString &uuid)

Indicates that descriptor's uuid has changed.

Note: Notifier signal for property uuid.

#QByteArray GattDescriptorRemote::value() const

Returns the value of the descriptor.

Note: Getter function for property value.

#[signal] void GattDescriptorRemote::valueChanged(const QByteArray value)

Indicates that descriptor's value has changed.

Note: Notifier signal for property value.

#[slot] BluezQt::PendingCall *GattDescriptorRemote::writeValue(const QByteArray &value, const QVariantMap &options)

Write the value of the GATT descriptor.

Issues a request to write the value of the descriptor.

Possible errors:

• PendingCall::NotReady
• PendingCall::Failed
• PendingCall::InProgress
• PendingCall::AlreadyConnected

Returns void pending call.