GenericAccessServicePrivate Class Reference

The GenericAccessServicePrivate class provides private implementation for GenericAccessService. More...

Inheritance diagram for GenericAccessServicePrivate:

Collaboration diagram for GenericAccessServicePrivate:

Public Member Functions
	GenericAccessServicePrivate (QLowEnergyController *controller, GenericAccessService *const q)
Public Member Functions inherited from AbstractPokitServicePrivate
	AbstractPokitServicePrivate (const QBluetoothUuid &serviceUuid, QLowEnergyController *controller, AbstractPokitService *const q)
bool	createServiceObject ()
	Creates an internal service object from the internal controller.
QLowEnergyCharacteristic	getCharacteristic (const QBluetoothUuid &uuid) const
	Get uuid characteristc from the underlying service.
bool	readCharacteristic (const QBluetoothUuid &uuid)
	Read the uuid characteristic.
bool	enableCharacteristicNotificatons (const QBluetoothUuid &uuid)
	Enables client (Pokit device) side notification for characteristic uuid.
bool	disableCharacteristicNotificatons (const QBluetoothUuid &uuid)
	Disables client (Pokit device) side notification for characteristic uuid.
Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const
	QObject (QObject *parent)
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
QString	objectName () const const
void	setObjectName (const QString &name)
bool	isWidgetType () const const
bool	isWindowType () const const
bool	signalsBlocked () const const
bool	blockSignals (bool block)
QThread *	thread () const const
void	moveToThread (QThread *targetThread)
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
void	killTimer (int id)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (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
const QObjectList &	children () const const
void	setParent (QObject *parent)
void	installEventFilter (QObject *filterObj)
void	removeEventFilter (QObject *obj)
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectTree ()
void	dumpObjectInfo ()
void	dumpObjectTree () const const
void	dumpObjectInfo () const const
bool	setProperty (const char *name, const QVariant &value)
QVariant	property (const char *name) const const
QList< QByteArray >	dynamicPropertyNames () const const
void	destroyed (QObject *obj)
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
bool	inherits (const char *className) const const
void	deleteLater ()
	Q_DISABLE_COPY (Class)
	Q_DISABLE_MOVE (Class)
	Q_DISABLE_COPY_MOVE (Class)
T	qobject_cast (QObject *object)
T	qobject_cast (const QObject *object)
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
	Q_CLASSINFO (Name, Value)
	Q_INTERFACES (...)
	Q_PROPERTY (...)
	Q_ENUMS (...)
	Q_FLAGS (...)
	Q_ENUM (...)
	Q_FLAG (...)
	Q_ENUM_NS (...)
	Q_FLAG_NS (...)
	Q_OBJECT Q_OBJECT
	Q_GADGET Q_GADGET
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_SIGNALS Q_SIGNALS
	Q_SIGNAL Q_SIGNAL
	Q_SLOTS Q_SLOTS
	Q_SLOT Q_SLOT
	Q_EMIT Q_EMIT
	Q_INVOKABLE Q_INVOKABLE
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Static Public Member Functions
static quint16	parseAppearance (const QByteArray &value)
	Parses the Appearance value.
Static Public Member Functions inherited from AbstractPokitServicePrivate
static	Q_LOGGING_CATEGORY (lc, "pokit.ble.service", QtInfoMsg)
	Logging category.
static bool	checkSize (const QString &label, const QByteArray &data, const int minSize, const int maxSize=-1, const bool failOnMax=false)
	Returns false if data is smaller than minSize, otherwise returns failOnMax if data is bigger than maxSize, otherwise returns true.
static QString	toHexString (const QByteArray &data, const int maxSize=20)
	Returns up to maxSize bytes of data as a human readable hexadecimal string.
Static Public Member Functions inherited from QObject
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
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 QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)

Protected Member Functions
void	characteristicRead (const QLowEnergyCharacteristic &characteristic, const QByteArray &value) override
	Implements AbstractPokitServicePrivate::characteristicRead to parse value, then emit a specialised signal, for each supported characteristic.
void	characteristicWritten (const QLowEnergyCharacteristic &characteristic, const QByteArray &newValue) override
	Implements AbstractPokitServicePrivate::characteristicWritten to parse newValue, then emit a specialised signal, for each supported characteristic.
Protected Member Functions inherited from QObject
QObject *	sender () const const
int	senderSignalIndex () const const
int	receivers (const char *signal) const const
bool	isSignalConnected (const QMetaMethod &signal) const const
virtual void	timerEvent (QTimerEvent *event)
virtual void	childEvent (QChildEvent *event)
virtual void	customEvent (QEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)

Friends
class	TestGenericAccessService

Additional Inherited Members
Public Attributes inherited from AbstractPokitServicePrivate
bool	autoDiscover { true }
	Whether autodiscovery is enabled or not.
QLowEnergyController *	controller { nullptr }
	BLE controller to fetch the service from.
std::optional< PokitProduct >	pokitProduct
	The Pokit product controller is connected to.
QLowEnergyService *	service { nullptr }
	BLE service to read/write characteristics.
QBluetoothUuid	serviceUuid
	UUIDs for service.
Public Attributes inherited from QObject
typedef	QObjectList
Protected Slots inherited from AbstractPokitServicePrivate
void	connected ()
	Handles QLowEnergyController::connected events.
void	discoveryFinished ()
	Handles QLowEnergyController::discoveryFinished events.
void	errorOccurred (const QLowEnergyService::ServiceError newError)
	Handles QLowEnergyController::errorOccurred events.
virtual void	serviceDiscovered (const QBluetoothUuid &newService)
	Handles QLowEnergyController::serviceDiscovered events.
void	stateChanged (QLowEnergyService::ServiceState newState)
	Handles QLowEnergyController::stateChanged events.
virtual void	characteristicChanged (const QLowEnergyCharacteristic &characteristic, const QByteArray &newValue)
	Handles QLowEnergyService::characteristicChanged events.
Protected Attributes inherited from AbstractPokitServicePrivate
AbstractPokitService *	q_ptr
	Internal q-pointer.
Properties inherited from QObject
	objectName

Detailed Description

The GenericAccessServicePrivate class provides private implementation for GenericAccessService.

Definition at line 18 of file genericaccessservice_p.h.

Constructor & Destructor Documentation

GenericAccessServicePrivate()

GenericAccessServicePrivate::GenericAccessServicePrivate ( QLowEnergyController * controller, GenericAccessService *const q )

explicit

Constructs a new GenericAccessServicePrivate object with public implementation q.

Definition at line 191 of file genericaccessservice.cpp.

    : AbstractPokitServicePrivate(GenericAccessService::serviceUuid, controller, q)
{
 
}

Member Function Documentation

characteristicRead()

void GenericAccessServicePrivate::characteristicRead ( const QLowEnergyCharacteristic & characteristic, const QByteArray & value )

overrideprotectedvirtual

Implements AbstractPokitServicePrivate::characteristicRead to parse value, then emit a specialised signal, for each supported characteristic.

Reimplemented from AbstractPokitServicePrivate.

Definition at line 215 of file genericaccessservice.cpp.

{
    AbstractPokitServicePrivate::characteristicRead(characteristic, value);
 
    Q_Q(GenericAccessService);
    if (characteristic.uuid() == GenericAccessService::CharacteristicUuids::appearance) {
        Q_EMIT q->appearanceRead(parseAppearance(value));
        return;
    }
 
    if (characteristic.uuid() == GenericAccessService::CharacteristicUuids::deviceName) {
        const QString deviceName = QString::fromUtf8(value);
        qCDebug(lc).noquote() << tr(R"(Device name: "%1")").arg(deviceName);
        Q_EMIT q->deviceNameRead(deviceName);
        return;
    }
 
    qCWarning(lc).noquote() << tr("Unknown characteristic read for Generic Access service")
        << serviceUuid << characteristic.name() << characteristic.uuid();
}

References GenericAccessService::CharacteristicUuids::appearance, QString::arg(), AbstractPokitServicePrivate::characteristicRead(), GenericAccessService::CharacteristicUuids::deviceName, QString::fromUtf8(), QLowEnergyCharacteristic::name(), parseAppearance(), QObject::Q_EMIT(), AbstractPokitServicePrivate::serviceUuid, QObject::tr(), and QLowEnergyCharacteristic::uuid().

Here is the call graph for this function:

characteristicWritten()

void GenericAccessServicePrivate::characteristicWritten ( const QLowEnergyCharacteristic & characteristic, const QByteArray & newValue )

overrideprotectedvirtual

Implements AbstractPokitServicePrivate::characteristicWritten to parse newValue, then emit a specialised signal, for each supported characteristic.

Reimplemented from AbstractPokitServicePrivate.

Definition at line 241 of file genericaccessservice.cpp.

{
    AbstractPokitServicePrivate::characteristicWritten(characteristic, newValue);
 
    Q_Q(GenericAccessService);
    if (characteristic.uuid() == GenericAccessService::CharacteristicUuids::appearance) {
        qCWarning(lc).noquote() << tr("Appearance haracteristic is read-only, but somehow written")
            << serviceUuid << characteristic.name() << characteristic.uuid();
        return;
    }
 
    if (characteristic.uuid() == GenericAccessService::CharacteristicUuids::deviceName) {
        Q_EMIT q->deviceNameWritten();
        return;
    }
 
    qCWarning(lc).noquote() << tr("Unknown characteristic written for Generic Access service")
        << serviceUuid << characteristic.name() << characteristic.uuid();
}

References GenericAccessService::CharacteristicUuids::appearance, AbstractPokitServicePrivate::characteristicWritten(), GenericAccessService::CharacteristicUuids::deviceName, QLowEnergyCharacteristic::name(), QObject::Q_EMIT(), AbstractPokitServicePrivate::serviceUuid, QObject::tr(), and QLowEnergyCharacteristic::uuid().

Here is the call graph for this function:

parseAppearance()

quint16 GenericAccessServicePrivate::parseAppearance ( const QByteArray & value )

static

Parses the Appearance value.

Returns 0xFFFF if not valid.

Definition at line 201 of file genericaccessservice.cpp.

{
    if (!checkSize(QLatin1String("Appearance"), value, 2, 2)) {
        return std::numeric_limits<quint16>::max();
    }
    const quint16 appearance = qFromLittleEndian<quint16>(value.constData());
    qCDebug(lc).noquote() << tr("Appearance: %1.").arg(appearance);
    return appearance;
}

References QString::arg(), AbstractPokitServicePrivate::checkSize(), QByteArray::constData(), and QObject::tr().

Referenced by GenericAccessService::appearance(), and characteristicRead().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

TestGenericAccessService

friend class TestGenericAccessService

friend

Definition at line 37 of file genericaccessservice_p.h.

---

The documentation for this class was generated from the following files:

• genericaccessservice_p.h
• genericaccessservice.cpp