BluezQt::GattCharacteristicRemote

Search for usage in LXR

BluezQt::GattCharacteristicRemote Class Reference

#include <BluezQt/GattCharacteristicRemote>

Inheritance diagram for BluezQt::GattCharacteristicRemote:

Properties

QList< GattDescriptorRemotePtrdescriptors
 
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

PendingCallconfirm ()
 
PendingCallreadValue (const QVariantMap &options)
 
PendingCallstartNotify ()
 
PendingCallstopNotify ()
 
PendingCallwriteValue (const QByteArray &value, const QVariantMap &options)
 

Public Member Functions

 ~GattCharacteristicRemote () override
 
QList< GattDescriptorRemotePtrdescriptors () const
 
QStringList flags () const
 
quint16 handle () const
 
bool isNotifyAcquired () const
 
bool isNotifying () const
 
bool isWriteAcquired () const
 
quint16 MTU () const
 
GattServiceRemotePtr service () const
 
PendingCallsetHandle (quint16 handle)
 
GattCharacteristicRemotePtr toSharedPtr () const
 
QString ubi () const
 
QString uuid () const
 
QByteArray value () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () 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.

Definition at line 31 of file gattcharacteristicremote.h.

Constructor & Destructor Documentation

◆ ~GattCharacteristicRemote()

BluezQt::GattCharacteristicRemote::~GattCharacteristicRemote ( )
override

Destroys a GattCharacteristic object.

Definition at line 23 of file gattcharacteristicremote.cpp.

Member Function Documentation

◆ characteristicChanged

void BluezQt::GattCharacteristicRemote::characteristicChanged ( GattCharacteristicRemotePtr  characteristic)
signal

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

◆ confirm

PendingCall * BluezQt::GattCharacteristicRemote::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

◆ descriptorsChanged

void BluezQt::GattCharacteristicRemote::descriptorsChanged ( QList< GattDescriptorRemotePtr descriptors)
signal

Indicates that characteristic descriptors list has changed.

◆ flags()

QStringList BluezQt::GattCharacteristicRemote::flags ( ) const

Returns flags the characteristic.

Returns
flags of characteristic

◆ flagsChanged

void BluezQt::GattCharacteristicRemote::flagsChanged ( QStringList  flags)
signal

Indicates that characteristic's flags have changed.

◆ gattDescriptorAdded

void BluezQt::GattCharacteristicRemote::gattDescriptorAdded ( GattDescriptorRemotePtr  descriptor)
signal

Indicates that a new descriptor was added (eg.

found by connection).

◆ gattDescriptorChanged

void BluezQt::GattCharacteristicRemote::gattDescriptorChanged ( GattDescriptorRemotePtr  descriptor)
signal

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

◆ gattDescriptorRemoved

void BluezQt::GattCharacteristicRemote::gattDescriptorRemoved ( GattDescriptorRemotePtr  descriptor)
signal

Indicates that a descriptor was removed.

◆ handle()

quint16 BluezQt::GattCharacteristicRemote::handle ( ) const

Returns characteristic handle.

Returns
qint16 characteristic handle

◆ handleChanged

void BluezQt::GattCharacteristicRemote::handleChanged ( quint16  handle)
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

◆ MTUChanged

void BluezQt::GattCharacteristicRemote::MTUChanged ( quint16  MTU)
signal

Indicates that characteristic's MTU have changed.

◆ notifyAcquiredChanged

void BluezQt::GattCharacteristicRemote::notifyAcquiredChanged ( bool  notifyAcquired)
signal

Indicates that characteristic's notifyAcquired state have changed.

◆ notifyingChanged

void BluezQt::GattCharacteristicRemote::notifyingChanged ( bool  notifying)
signal

Indicates that characteristic's notifying state have changed.

◆ readValue

PendingCall * BluezQt::GattCharacteristicRemote::readValue ( const QVariantMap &  options)
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

◆ setHandle()

PendingCall * BluezQt::GattCharacteristicRemote::setHandle ( quint16  handle)

Sets the characteristic handle.

Parameters
handlecharacteristic handle
Returns
void pending call

Definition at line 82 of file gattcharacteristicremote.cpp.

◆ startNotify

PendingCall * BluezQt::GattCharacteristicRemote::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

PendingCall * BluezQt::GattCharacteristicRemote::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

◆ uuid()

QString BluezQt::GattCharacteristicRemote::uuid ( ) const

Returns an uuid of the characteristic.

Returns
uuid of the characteristic

◆ uuidChanged

void BluezQt::GattCharacteristicRemote::uuidChanged ( const QString uuid)
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

◆ valueChanged

void BluezQt::GattCharacteristicRemote::valueChanged ( const QByteArray  value)
signal

Indicates that characteristic's value have changed.

◆ writeAcquiredChanged

void BluezQt::GattCharacteristicRemote::writeAcquiredChanged ( bool  writeAcquired)
signal

Indicates that characteristic's writeAcquired state have changed.

◆ writeValue

PendingCall * BluezQt::GattCharacteristicRemote::writeValue ( const QByteArray value,
const QVariantMap &  options 
)
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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Nov 27 2022 04:09:33 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.