BluezQt::GattCharacteristicRemote
#include <BluezQt/GattCharacteristicRemote>
Properties | |
QList< GattDescriptorRemotePtr > | descriptors |
QStringList | flags |
quint16 | handle |
quint16 | MTU |
bool | notifyAcquired |
bool | notifying |
GattServiceRemotePtr | service |
QString | ubi |
QString | uuid |
QByteArray | value |
bool | writeAcquired |
Properties inherited from QObject | |
objectName | |
Signals | |
void | characteristicChanged (GattCharacteristicRemotePtr characteristic) |
void | descriptorsChanged (QList< GattDescriptorRemotePtr > descriptors) |
void | flagsChanged (QStringList flags) |
void | gattDescriptorAdded (GattDescriptorRemotePtr descriptor) |
void | gattDescriptorChanged (GattDescriptorRemotePtr descriptor) |
void | gattDescriptorRemoved (GattDescriptorRemotePtr descriptor) |
void | handleChanged (quint16 handle) |
void | MTUChanged (quint16 MTU) |
void | notifyAcquiredChanged (bool notifyAcquired) |
void | notifyingChanged (bool notifying) |
void | uuidChanged (const QString &uuid) |
void | valueChanged (const QByteArray value) |
void | writeAcquiredChanged (bool writeAcquired) |
Public Slots | |
PendingCall * | confirm () |
PendingCall * | readValue (const QVariantMap &options) |
PendingCall * | startNotify () |
PendingCall * | stopNotify () |
PendingCall * | writeValue (const QByteArray &value, const QVariantMap &options) |
Public Member Functions | |
~GattCharacteristicRemote () override | |
QList< GattDescriptorRemotePtr > | descriptors () const |
QStringList | flags () const |
quint16 | handle () const |
bool | isNotifyAcquired () const |
bool | isNotifying () const |
bool | isWriteAcquired () const |
quint16 | MTU () const |
GattServiceRemotePtr | service () const |
PendingCall * | setHandle (quint16 handle) |
GattCharacteristicRemotePtr | toSharedPtr () const |
QString | ubi () const |
QString | uuid () const |
QByteArray | value () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Bluetooth LE GATT characteristic.
This class represents a Bluetooth LE GATT characteristic for the clients.
Property Documentation
◆ descriptors
|
read |
Definition at line 44 of file gattcharacteristicremote.h.
◆ flags
|
read |
Definition at line 40 of file gattcharacteristicremote.h.
◆ handle
|
read |
Definition at line 41 of file gattcharacteristicremote.h.
◆ MTU
|
read |
Definition at line 42 of file gattcharacteristicremote.h.
◆ notifyAcquired
|
read |
Definition at line 38 of file gattcharacteristicremote.h.
◆ notifying
|
read |
Definition at line 39 of file gattcharacteristicremote.h.
◆ service
|
read |
Definition at line 43 of file gattcharacteristicremote.h.
◆ ubi
|
read |
Definition at line 34 of file gattcharacteristicremote.h.
◆ uuid
|
read |
Definition at line 35 of file gattcharacteristicremote.h.
◆ value
|
read |
Definition at line 36 of file gattcharacteristicremote.h.
◆ writeAcquired
|
read |
Definition at line 37 of file gattcharacteristicremote.h.
Constructor & Destructor Documentation
◆ ~GattCharacteristicRemote()
|
override |
Destroys a GattCharacteristic object.
Definition at line 23 of file gattcharacteristicremote.cpp.
Member Function Documentation
◆ characteristicChanged
|
signal |
Indicates that at least one of the characteristic's properties have changed.
◆ confirm
|
slot |
Confirmation that value of the characteristic was received.
This method doesn't expect a reply so it is just a confirmation that value was received.
Possible errors: PendingCall::NotReady, PendingCall::Failed, PendingCall::InProgress, PendingCall::AlreadyConnected
- Returns
- void pending call
Definition at line 112 of file gattcharacteristicremote.cpp.
◆ descriptors()
QList< GattDescriptorRemotePtr > BluezQt::GattCharacteristicRemote::descriptors | ( | ) | const |
Returns object paths representing the included services of this service.
- Returns
- Object paths of included services
Definition at line 72 of file gattcharacteristicremote.cpp.
◆ descriptorsChanged
|
signal |
Indicates that characteristic descriptors list has changed.
◆ flags()
QStringList BluezQt::GattCharacteristicRemote::flags | ( | ) | const |
Returns flags the characteristic.
- Returns
- flags of characteristic
Definition at line 62 of file gattcharacteristicremote.cpp.
◆ flagsChanged
|
signal |
Indicates that characteristic's flags have changed.
◆ gattDescriptorAdded
|
signal |
Indicates that a new descriptor was added (eg.
found by connection).
◆ gattDescriptorChanged
|
signal |
Indicates that at least one of the descriptor's properties have changed.
◆ gattDescriptorRemoved
|
signal |
Indicates that a descriptor was removed.
◆ handle()
quint16 BluezQt::GattCharacteristicRemote::handle | ( | ) | const |
Returns characteristic handle.
- Returns
- qint16 characteristic handle
Definition at line 77 of file gattcharacteristicremote.cpp.
◆ handleChanged
|
signal |
Indicates that characteristic's handle have changed.
◆ isNotifyAcquired()
bool BluezQt::GattCharacteristicRemote::isNotifyAcquired | ( | ) | const |
Returns whether notifyAcquired for the characteristic.
- Returns
- true if notify is acquired
Definition at line 52 of file gattcharacteristicremote.cpp.
◆ isNotifying()
bool BluezQt::GattCharacteristicRemote::isNotifying | ( | ) | const |
Returns whether the characteristic is notifying.
- Returns
- true if notifying
Definition at line 57 of file gattcharacteristicremote.cpp.
◆ isWriteAcquired()
bool BluezQt::GattCharacteristicRemote::isWriteAcquired | ( | ) | const |
Returns whether writeAcquired for the characteristic.
- Returns
- true if write is acquired
Definition at line 47 of file gattcharacteristicremote.cpp.
◆ MTU()
quint16 BluezQt::GattCharacteristicRemote::MTU | ( | ) | const |
Returns characteristic MTU.
- Returns
- qint16 characteristic MTU
Definition at line 87 of file gattcharacteristicremote.cpp.
◆ MTUChanged
|
signal |
Indicates that characteristic's MTU have changed.
◆ notifyAcquiredChanged
|
signal |
Indicates that characteristic's notifyAcquired state have changed.
◆ notifyingChanged
|
signal |
Indicates that characteristic's notifying state have changed.
◆ readValue
|
slot |
Read the value of the GATT characteristic.
Issues a request to read the value of the characteristic and returns the value if the operation was successful.
Possible errors: PendingCall::NotReady, PendingCall::Failed, PendingCall::InProgress, PendingCall::AlreadyConnected
- Returns
- QByteArray pending call
Definition at line 92 of file gattcharacteristicremote.cpp.
◆ service()
GattServiceRemotePtr BluezQt::GattCharacteristicRemote::service | ( | ) | const |
Returns a service that owns that characteristic.
- Returns
- service of characteristic
Definition at line 67 of file gattcharacteristicremote.cpp.
◆ setHandle()
PendingCall * BluezQt::GattCharacteristicRemote::setHandle | ( | quint16 | handle | ) |
Sets the characteristic handle.
- Parameters
-
handle characteristic handle
- Returns
- void pending call
Definition at line 82 of file gattcharacteristicremote.cpp.
◆ startNotify
|
slot |
Start notifying the value of the GATT characteristic.
Starts a notification session from this characteristic if it supports value notifications or indications.
Possible errors: PendingCall::NotReady, PendingCall::Failed, PendingCall::InProgress, PendingCall::AlreadyConnected
- Returns
- void pending call
Definition at line 102 of file gattcharacteristicremote.cpp.
◆ stopNotify
|
slot |
Stop notifying the value of the GATT characteristic.
This method will cancel any previous StartNotify transaction. Note that notifications from a characteristic are shared between sessions thus calling StopNotify will release a single session.
Possible errors: PendingCall::NotReady, PendingCall::Failed, PendingCall::InProgress, PendingCall::AlreadyConnected
- Returns
- void pending call
Definition at line 107 of file gattcharacteristicremote.cpp.
◆ toSharedPtr()
GattCharacteristicRemotePtr BluezQt::GattCharacteristicRemote::toSharedPtr | ( | ) | const |
Returns a shared pointer from this.
- Returns
- DevicePtr
Definition at line 27 of file gattcharacteristicremote.cpp.
◆ ubi()
QString BluezQt::GattCharacteristicRemote::ubi | ( | ) | const |
Returns an UBI of the GATT characteristic.
Example UBI: "/org/bluez/hci0/dev_40_79_6A_0C_39_75"
- Returns
- UBI of device
Definition at line 32 of file gattcharacteristicremote.cpp.
◆ uuid()
QString BluezQt::GattCharacteristicRemote::uuid | ( | ) | const |
Returns an uuid of the characteristic.
- Returns
- uuid of the characteristic
Definition at line 37 of file gattcharacteristicremote.cpp.
◆ uuidChanged
|
signal |
Indicates that characteristic's uuid have changed.
◆ value()
QByteArray BluezQt::GattCharacteristicRemote::value | ( | ) | const |
Returns an value of the characteristic.
- Returns
- value of the characteristic
Definition at line 42 of file gattcharacteristicremote.cpp.
◆ valueChanged
|
signal |
Indicates that characteristic's value have changed.
◆ writeAcquiredChanged
|
signal |
Indicates that characteristic's writeAcquired state have changed.
◆ writeValue
|
slot |
Write the value of the GATT characteristic.
Issues a request to write the value of the characteristic.
Possible errors: PendingCall::NotReady, PendingCall::Failed, PendingCall::InProgress, PendingCall::AlreadyConnected
- Returns
- void pending call
Definition at line 97 of file gattcharacteristicremote.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:29:05 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.