The DataLoggerService class accesses the Data Logger service of Pokit devices. More...

Inheritance diagram for DataLoggerService:

Collaboration diagram for DataLoggerService:

Classes
struct	CharacteristicUuids
	Characteristics available via the `DataLogger` service. More...

struct	Metadata
	Attributes included in the `Metadata` characterstic. More...

struct	Settings
	Attributes included in the `Settings` characterstic. More...

Public Types
enum class	Command : quint8 { Start = 0 , Stop = 1 , Refresh = 2 }
	Values supported by the `Command` attribute of the `Settings` characteristic. More...

enum class	Mode : quint8 { Idle = 0 , DcVoltage = 1 , AcVoltage = 2 , DcCurrent = 3 , AcCurrent = 4 , Temperature = 5 }
	Values supported by the `Mode` attribute of the `Settings` and `Metadata` characteristics. More...

enum class	LoggerStatus : quint8 { Done = 0 , Sampling = 1 , BufferFull = 2 , Error = 255 }
	Values supported by the `Status` attribute of the `Metadata` characteristic. More...

typedef QVector< qint16 >	Samples
	Raw samples from the `Reading` characteristic.

Signals
void	settingsWritten ()
	This signal is emitted when the `Settings` characteristic has been written successfully.

void	metadataRead (const DataLoggerService::Metadata &meta)
	This signal is emitted when the `Metadata` characteristic has been read successfully.

void	samplesRead (const DataLoggerService::Samples &samples)
	This signal is emitted when the `Reading` characteristic has been notified.

Signals inherited from AbstractPokitService
void	serviceDetailsDiscovered ()
	This signal is emitted when the Pokit service details have been discovered.

void	serviceErrorOccurred (QLowEnergyService::ServiceError newError)
	This signal is emitted whenever an error occurs on the underlying QLowEnergyService.

Public Member Functions
QString	toString (const quint8 range, const Mode mode) const
	Returns range as a user-friendly string, or a null QString if mode has no ranges.

QVariant	maxValue (const quint8 range, const Mode mode) const
	Returns the maximum value for range, or the string "Auto".

	DataLoggerService (QLowEnergyController const pokitDevice, QObject parent=nullptr)
	Constructs a new Pokit service with parent.

	~DataLoggerService () override
	Destroys this DataLoggerService object.

bool	readCharacteristics () override
	Read all characteristics.

bool	readMetadataCharacteristic ()
	Reads the `DataLogger` service's `Metadata` characteristic.

bool	setSettings (const Settings &settings)
	Configures the Pokit device's data logger mode.

bool	startLogger (const Settings &settings)
	Start the data logger with settings.

bool	stopLogger ()
	Stop the data logger.

bool	fetchSamples ()
	Start the data logger.

Metadata	metadata () const
	Returns the most recent value of the `DataLogger` service's `Metadata` characteristic.

bool	enableMetadataNotifications ()
	Enables client-side notifications of Data Logger metadata changes.

bool	disableMetadataNotifications ()
	Disables client-side notifications of Data Logger metadata changes.

bool	enableReadingNotifications ()
	Enables client-side notifications of Data Logger readings.

bool	disableReadingNotifications ()
	Disables client-side notifications of Data Logger readings.

Public Member Functions inherited from AbstractPokitService
virtual	~AbstractPokitService ()
	Destroys this AbstractPokitService object.

virtual bool	readCharacteristics ()=0
	Read all characteristics.

bool	autoDiscover () const
	Returns `true` if autodiscovery of services and service details is enabled, `false` otherwise.

void	setAutoDiscover (const bool discover=true)
	If discover is `true`, autodiscovery will be attempted.

std::optional< PokitProduct >	pokitProduct () const
	Returns the Pokit product this service is attached to.

void	setPokitProduct (const PokitProduct product)
	Sets the current Pokit product.

QLowEnergyService *	service ()
	Returns a non-const pointer to the internal service object, if any.

const QLowEnergyService *	service () const
	Returns a const pointer to the internal service object, if any.

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 QString	toString (const Mode &mode)
	Returns mode as a user-friendly string.

static QString	toString (const PokitProduct product, const quint8 range, const Mode mode)
	Returns range as a user-friendly string, or a null QString if mode has no ranges.

static QVariant	maxValue (const PokitProduct product, const quint8 range, const Mode mode)
	Returns the maximum value for range, or the string "Auto".

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)

Static Public Attributes
static const QBluetoothUuid	serviceUuid { QStringLiteral("a5ff3566-1fd8-4e10-8362-590a578a4121") }
	UUID of the "DataLogger" service.

Friends
class	TestDataLoggerService

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

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)

Properties inherited from QObject
	objectName

Detailed Description

The DataLoggerService class accesses the Data Logger service of Pokit devices.

Member Typedef Documentation

◆ Samples

DataLoggerService::Samples

Raw samples from the Reading characteristic.

These raw samples are (supposedly) within the range -2048 to +2047, and need to be multiplied by the Metadata::scale value from the Metadata characteristc to get the true values.

Also supposedly, there should be no more than 10 samples at a time, according to Pokit's current API docs. There is not artificial limitation imposed by QtPokit, so devices may begin batching more samples in future. Specifically, the Pokit Pro seems to send 88 samples (in 176 bytes) at a time.

Member Enumeration Documentation

◆ Command

enum class DataLoggerService::Command : quint8

strong

Values supported by the Command attribute of the Settings characteristic.

Enumerator
Start	Start the Data Logger.
Stop	Stop the Data Logger.
Refresh	Refresh the Data Logger.

◆ LoggerStatus

enum class DataLoggerService::LoggerStatus : quint8

strong

Values supported by the Status attribute of the Metadata characteristic.

Enumerator
Done	Sampling has completed.
Sampling	Actively sampling.
BufferFull	Buffer is full.
Error	An error has occurred.

◆ Mode

enum class DataLoggerService::Mode : quint8

strong

Values supported by the Mode attribute of the Settings and Metadata characteristics.

Enumerator
Idle	Make device idle.
DcVoltage	Measure DC voltage.
AcVoltage	Measure AC voltage.
DcCurrent	Measure DC current.
AcCurrent	Measure AC current.
Temperature	Measure temperature.

Member Function Documentation

◆ disableMetadataNotifications()

bool DataLoggerService::disableMetadataNotifications ( )

Disables client-side notifications of Data Logger metadata changes.

Instantaneous reads can still be fetched by readMetadataCharacteristic().

Returns true is the request was successfully submited to the device queue, false otherwise.

◆ disableReadingNotifications()

bool DataLoggerService::disableReadingNotifications ( )

Disables client-side notifications of Data Logger readings.

Returns true is the request was successfully submited to the device queue, false otherwise.

◆ enableMetadataNotifications()

bool DataLoggerService::enableMetadataNotifications ( )

Enables client-side notifications of Data Logger metadata changes.

This is an alternative to manually requesting individual reads via readMetadataCharacteristic().

Returns true is the request was successfully submited to the device queue, false otherwise.

Successfully read values (if any) will be emitted via the metadataRead() signal.

◆ enableReadingNotifications()

bool DataLoggerService::enableReadingNotifications ( )

Enables client-side notifications of Data Logger readings.

Returns true is the request was successfully submited to the device queue, false otherwise.

Successfully read samples (if any) will be emitted via the samplesRead() signal.

◆ fetchSamples()

bool DataLoggerService::fetchSamples ( )

Start the data logger.

This is just a convenience function equivalent to calling setSettings() with the command set to DataLoggerService::Command::Refresh.

Once the Pokit device has processed this request succesffully, the device will begin notifying the Metadata and Reading characteristic, resulting in emits of metadataRead and samplesRead respectively.

Here is the call graph for this function:

◆ maxValue() [1/2]

QVariant DataLoggerService::maxValue	(	const PokitProduct	product,
		const quint8	range,
		const Mode	mode
	)

static

Returns the maximum value for range, or the string "Auto".

If range is not a known valid enumeration value for product's mode, then a null QVariant is returned.

Here is the caller graph for this function:

◆ maxValue() [2/2]

QVariant DataLoggerService::maxValue	(	const quint8	range,
		const Mode	mode
	)		const

Returns the maximum value for range, or the string "Auto".

If range is not a known valid enumeration value for the current product's mode, then a null QVariant is returned.

Here is the call graph for this function:

◆ metadata()

DataLoggerService::Metadata DataLoggerService::metadata ( ) const

Returns the most recent value of the DataLogger service's Metadata characteristic.

The returned value, if any, is from the underlying Bluetooth stack's cache. If no such value is currently available (ie the serviceDetailsDiscovered signal has not been emitted yet), then the returned DataLoggerService::Metadata::scale member will be a quiet NaN, which can be checked like:

const DataLoggerService::Metadata metadata = multimeterService->metadata();
if (qIsNaN(metadata.scale)) {
    // Handle failure.
}

Here is the call graph for this function:

◆ metadataRead

DataLoggerService::metadataRead ( const DataLoggerService::Metadata & meta )

signal

This signal is emitted when the Metadata characteristic has been read successfully.

See also: readMetadataCharacteristic

◆ readCharacteristics()

bool DataLoggerService::readCharacteristics ( )

overridevirtual

Read all characteristics.

This convenience function will queue refresh requests of all characteristics supported by this service.

Relevant *Service::*Read signals will be emitted by derived class objects as each characteristic is successfully read.

Implements AbstractPokitService.

Here is the call graph for this function:

◆ readMetadataCharacteristic()

bool DataLoggerService::readMetadataCharacteristic ( )

Reads the DataLogger service's Metadata characteristic.

Returns true is the read request is succesfully queued, false otherwise (ie if the underlying controller it not yet connected to the Pokit device, or the device's services have not yet been discovered).

Emits metadataRead() if/when the characteristic has been read successfully.

Here is the caller graph for this function:

◆ samplesRead

DataLoggerService::samplesRead ( const DataLoggerService::Samples & samples )

signal

This signal is emitted when the Reading characteristic has been notified.

See also: beginSampling; stopSampling

◆ setSettings()

bool DataLoggerService::setSettings ( const Settings & settings )

Configures the Pokit device's data logger mode.

Returns true if the write request was successfully queued, false otherwise.

Emits settingsWritten() if/when the settings have been writtem successfully.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settingsWritten

DataLoggerService::settingsWritten ( )

signal

This signal is emitted when the Settings characteristic has been written successfully.

See also: setSettings

◆ startLogger()

bool DataLoggerService::startLogger ( const Settings & settings )

Start the data logger with settings.

This is just a synonym for setSettings() except makes the caller's intention more explicit, and sanity-checks that the settings's command is DataLoggerService::Command::Start.

Here is the call graph for this function:

◆ stopLogger()

bool DataLoggerService::stopLogger ( )

Stop the data logger.

This is just a convenience function equivalent to calling setSettings() with the command set to DataLoggerService::Command::Stop.

Here is the call graph for this function:

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

Classes

Public Types

Signals

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Samples

Member Enumeration Documentation

◆ Command

◆ LoggerStatus

◆ Mode

Member Function Documentation

◆ disableMetadataNotifications()

◆ disableReadingNotifications()

◆ enableMetadataNotifications()

◆ enableReadingNotifications()

◆ fetchSamples()

◆ maxValue() [1/2]

◆ maxValue() [2/2]

◆ metadata()

◆ metadataRead

◆ readCharacteristics()

◆ readMetadataCharacteristic()

◆ samplesRead

◆ setSettings()

◆ settingsWritten

◆ startLogger()

◆ stopLogger()