The MultimeterService class accesses the Multimeter service of Pokit devices. More...

Inheritance diagram for MultimeterService:

Collaboration diagram for MultimeterService:

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

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

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

Public Types
enum class	Mode : quint8 { Idle = 0 , DcVoltage = 1 , AcVoltage = 2 , DcCurrent = 3 , AcCurrent = 4 , Resistance = 5 , Diode = 6 , Continuity = 7 , Temperature = 8 , Capacitance = 9 , ExternalTemperature = 10 }
	Values supported by the `Mode` attribute of the `Settings` and `Reading` characteristics. More...

enum class	MeterStatus : quint8 { AutoRangeOff = 0 , AutoRangeOn = 1 , NoContinuity = 0 , Continuity = 1 , Ok = 0 , Error = 255 }
	Values supported by the `Status` attribute of the `Settings` characteristic. More...

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

void	readingRead (const MultimeterService::Reading &reading)
	This signal is emitted when the `Reading` characteristic has been read successfully.

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".

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

bool	readCharacteristics () override
	Read all characteristics.

bool	readReadingCharacteristic ()
	Read the `Multimeter` service's `Reading` characteristic.

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

Reading	reading () const
	Returns the most recent value of the `Multimeter` service's `Reading` characteristic.

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

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

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

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("e7481d2f-5781-442e-bb9a-fd4e3441dadc") }
	UUID of the `Multimeter` service.

Protected Member Functions
	MultimeterService (MultimeterServicePrivate const d, QObject const parent)
	Constructs a new Pokit service with parent, and private implementation d.

Protected Member Functions inherited from AbstractPokitService
	AbstractPokitService (AbstractPokitServicePrivate const d, QObject const parent)
	Constructs a new Pokit service with parent, and private implementation d.

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	TestMultimeterService

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

Protected Attributes inherited from AbstractPokitService
AbstractPokitServicePrivate *	d_ptr
	Internal d-pointer.

Properties inherited from QObject
	objectName

Detailed Description

The MultimeterService class accesses the Multimeter service of Pokit devices.

Definition at line 22 of file multimeterservice.h.

Member Enumeration Documentation

◆ MeterStatus

enum class MultimeterService::MeterStatus : quint8

strong

Values supported by the Status attribute of the Settings characteristic.

Enumerator
AutoRangeOff	Auto-range is disabled (voltage, current and resistance modes only).
AutoRangeOn	Auto-range is enabled (voltage, current and resistance modes only).
NoContinuity	No continuity (continuity mode only).
Continuity	Continuity (continuity mode only).
Ok	Ok (temperature and diode modes only).
Error	Error (all modes).

Definition at line 68 of file multimeterservice.h.

                           : quint8 {
        AutoRangeOff = 0,  ///< Auto-range is disabled (voltage, current and resistance modes only).
        AutoRangeOn  = 1,  ///< Auto-range is enabled (voltage, current and resistance modes only).
        NoContinuity = 0,  ///< No continuity (continuity mode only).
        Continuity   = 1,  ///< Continuity (continuity mode only).
        Ok           = 0,  ///< Ok (temperature and diode modes only).
        Error        = 255 ///< Error (all modes).
    };

◆ Mode

enum class MultimeterService::Mode : quint8

strong

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

Pokit Bluetooth API errata

The following enumeration values are as-yet undocumented by Pokit Innovations. @pcolby reverse-engineered them as part of the dokit project.

Mode::Capacitance
Mode::ExternalTemperature

Enumerator
Idle	Make device idle.
DcVoltage	Measure DC voltage.
AcVoltage	Measure AC voltage.
DcCurrent	Measure DC current.
AcCurrent	Measure AC current.
Resistance	Measure resistance.
Diode	Measure diode.
Continuity	Measure continuity.
Temperature	Measure temperature.
Capacitance	Measure capacitance.
ExternalTemperature	Measure temperature via an external temperature probe.

Definition at line 40 of file multimeterservice.h.

                    : quint8 {
        Idle        = 0, ///< Make device idle.
        DcVoltage   = 1, ///< Measure DC voltage.
        AcVoltage   = 2, ///< Measure AC voltage.
        DcCurrent   = 3, ///< Measure DC current.
        AcCurrent   = 4, ///< Measure AC current.
        Resistance  = 5, ///< Measure resistance.
        Diode       = 6, ///< Measure diode.
        Continuity  = 7, ///< Measure continuity.
        Temperature = 8, ///< Measure temperature.
        Capacitance = 9, ///< Measure capacitance.
        ExternalTemperature = 10, ///< Measure temperature via an external temperature probe.
    };

Constructor & Destructor Documentation

◆ MultimeterService() [1/2]

MultimeterService::MultimeterService	(	QLowEnergyController *const	pokitDevice,
		QObject *	parent = nullptr )

Constructs a new Pokit service with parent.

Definition at line 129 of file multimeterservice.cpp.

    : AbstractPokitService(new MultimeterServicePrivate(controller, this), parent)
{
 
}

◆ MultimeterService() [2/2]

MultimeterService::MultimeterService	(	MultimeterServicePrivate *const	d,
		QObject *const	parent )

protected

Constructs a new Pokit service with parent, and private implementation d.

Definition at line 139 of file multimeterservice.cpp.

    : AbstractPokitService(d, parent)
{
 
}

Member Function Documentation

◆ disableReadingNotifications()

bool MultimeterService::disableReadingNotifications ( )

Disables client-side notifications of meter readings.

Instantaneous reads can still be fetched by readReadingCharacteristic().

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

Definition at line 237 of file multimeterservice.cpp.

{
    Q_D(MultimeterService);
    return d->disableCharacteristicNotificatons(CharacteristicUuids::reading);
}

References MultimeterService::CharacteristicUuids::reading.

◆ enableReadingNotifications()

bool MultimeterService::enableReadingNotifications ( )

Enables client-side notifications of meter readings.

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

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

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

Definition at line 224 of file multimeterservice.cpp.

{
    Q_D(MultimeterService);
    return d->enableCharacteristicNotificatons(CharacteristicUuids::reading);
}

References MultimeterService::CharacteristicUuids::reading.

Referenced by MeterCommand::settingsWritten().

Here is the caller graph for this function:

◆ maxValue() [1/2]

QVariant MultimeterService::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.

Definition at line 90 of file multimeterservice.cpp.

{
    switch (mode) {
    case Mode::Idle:
        break;
    case Mode::DcVoltage:
    case Mode::AcVoltage:
        return VoltageRange::maxValue(product, range);
    case Mode::DcCurrent:
    case Mode::AcCurrent:
        return CurrentRange::maxValue(product, range);
    case Mode::Resistance:
        return ResistanceRange::maxValue(product, range);
    case Mode::Diode:
    case Mode::Continuity:
    case Mode::Temperature:
        break;
    case Mode::Capacitance:
        return CapacitanceRange::maxValue(product, range);
    case Mode::ExternalTemperature:
        break;
    }
    return QVariant();
}

References AcCurrent, AcVoltage, Capacitance, Continuity, DcCurrent, DcVoltage, Diode, ExternalTemperature, Idle, CapacitanceRange::maxValue(), CurrentRange::maxValue(), ResistanceRange::maxValue(), VoltageRange::maxValue(), Resistance, and Temperature.

Referenced by maxValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxValue() [2/2]

QVariant MultimeterService::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.

Definition at line 121 of file multimeterservice.cpp.

{
    return maxValue(*pokitProduct(), range, mode);
}

References maxValue(), and AbstractPokitService::pokitProduct().

Here is the call graph for this function:

◆ readCharacteristics()

bool MultimeterService::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.

Definition at line 147 of file multimeterservice.cpp.

{
    return readReadingCharacteristic();
}

References readReadingCharacteristic().

Here is the call graph for this function:

◆ reading()

MultimeterService::Reading MultimeterService::reading ( ) const

Returns the most recent value of the Multimeter service's Reading 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 MultimeterService::Reading::value member will be a quiet NaN, which can be checked like:

const MultimeterService::Reading reading = multimeterService->reading();
if (qIsNaN(reading.value)) {
    // Handle failure.
}

Definition at line 206 of file multimeterservice.cpp.

{
    Q_D(const MultimeterService);
    const QLowEnergyCharacteristic characteristic =
        d->getCharacteristic(CharacteristicUuids::reading);
    return (characteristic.isValid()) ? MultimeterServicePrivate::parseReading(characteristic.value())
        : Reading{ MeterStatus::Error, std::numeric_limits<float>::quiet_NaN(), Mode::Idle, 0 };
}

References Error, Idle, QLowEnergyCharacteristic::isValid(), MultimeterServicePrivate::parseReading(), MultimeterService::CharacteristicUuids::reading, and QLowEnergyCharacteristic::value().

Here is the call graph for this function:

◆ readingRead

void MultimeterService::readingRead ( const MultimeterService::Reading & reading )

signal

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

See also: readReadingCharacteristic

Referenced by MeterCommand::settingsWritten().

Here is the caller graph for this function:

◆ readReadingCharacteristic()

bool MultimeterService::readReadingCharacteristic ( )

Read the Multimeter service's Reading 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 readingRead() if/when the characteristic has been read successfully.

Definition at line 161 of file multimeterservice.cpp.

{
    Q_D(MultimeterService);
    return d->readCharacteristic(CharacteristicUuids::reading);
}

References MultimeterService::CharacteristicUuids::reading.

Referenced by readCharacteristics().

Here is the caller graph for this function:

◆ setSettings()

bool MultimeterService::setSettings ( const Settings & settings )

Configures the Pokit device's multimeter mode.

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

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

Definition at line 174 of file multimeterservice.cpp.

{
    Q_D(const MultimeterService);
    const QLowEnergyCharacteristic characteristic =
        d->getCharacteristic(CharacteristicUuids::settings);
    if (!characteristic.isValid()) {
        return false;
    }
 
    const QByteArray value = MultimeterServicePrivate::encodeSettings(settings);
    if (value.isNull()) {
        return false;
    }
 
    d->service->writeCharacteristic(characteristic, value);
    return (d->service->error() != QLowEnergyService::ServiceError::CharacteristicWriteError);
}

References MultimeterServicePrivate::encodeSettings(), QByteArray::isNull(), QLowEnergyCharacteristic::isValid(), and MultimeterService::CharacteristicUuids::settings.

Referenced by MeterCommand::serviceDetailsDiscovered().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settingsWritten

void MultimeterService::settingsWritten ( )

signal

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

See also: setSettings

Referenced by MeterCommand::getService().

Here is the caller graph for this function:

◆ toString() [1/3]

QString MultimeterService::toString ( const Mode & mode )

static

Returns mode as a user-friendly string.

Definition at line 35 of file multimeterservice.cpp.

{
    switch (mode) {
    case Mode::Idle:        return tr("Idle");
    case Mode::DcVoltage:   return tr("DC voltage");
    case Mode::AcVoltage:   return tr("AC voltage");
    case Mode::DcCurrent:   return tr("DC current");
    case Mode::AcCurrent:   return tr("AC current");
    case Mode::Resistance:  return tr("Resistance");
    case Mode::Diode:       return tr("Diode");
    case Mode::Continuity:  return tr("Continuity");
    case Mode::Temperature: return tr("Temperature");
    case Mode::Capacitance: return tr("Capacitance");
    case Mode::ExternalTemperature: return tr("External temperature");
    }
    return QString();
}

References AcCurrent, AcVoltage, Capacitance, Continuity, DcCurrent, DcVoltage, Diode, ExternalTemperature, Idle, Resistance, Temperature, and QObject::tr().

Referenced by MeterCommand::outputReading(), MeterCommand::serviceDetailsDiscovered(), and toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString() [2/3]

QString MultimeterService::toString	(	const PokitProduct	product,
		const quint8	range,
		const Mode	mode )

static

Returns range as a user-friendly string, or a null QString if mode has no ranges.

Definition at line 54 of file multimeterservice.cpp.

{
    switch (mode) {
    case Mode::Idle:
        break;
    case Mode::DcVoltage:
    case Mode::AcVoltage:
        return VoltageRange::toString(product, range);
    case Mode::DcCurrent:
    case Mode::AcCurrent:
        return CurrentRange::toString(product, range);
    case Mode::Resistance:
        return ResistanceRange::toString(product, range);
    case Mode::Diode:
    case Mode::Continuity:
    case Mode::Temperature:
        break;
    case Mode::Capacitance:
        return CapacitanceRange::toString(product, range);
    case Mode::ExternalTemperature:
        break;
    }
    return QString();
}

References AcCurrent, AcVoltage, Capacitance, Continuity, DcCurrent, DcVoltage, Diode, ExternalTemperature, Idle, Resistance, Temperature, CapacitanceRange::toString(), CurrentRange::toString(), ResistanceRange::toString(), and VoltageRange::toString().

Here is the call graph for this function:

◆ toString() [3/3]

QString MultimeterService::toString	(	const quint8	range,
		const Mode	mode ) const

Returns range as a user-friendly string, or a null QString if mode has no ranges.

Definition at line 80 of file multimeterservice.cpp.

{
    return toString(*pokitProduct(), range, mode);
}

References AbstractPokitService::pokitProduct(), and toString().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ TestMultimeterService

friend class TestMultimeterService

friend

Definition at line 111 of file multimeterservice.h.

Member Data Documentation

◆ serviceUuid

const QBluetoothUuid MultimeterService::serviceUuid { QStringLiteral("e7481d2f-5781-442e-bb9a-fd4e3441dadc") }

inlinestatic

UUID of the Multimeter service.

Definition at line 28 of file multimeterservice.h.

28{ QStringLiteral("e7481d2f-5781-442e-bb9a-fd4e3441dadc") };

Referenced by PokitDevice::serviceToString().

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

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MeterStatus

◆ Mode

Constructor & Destructor Documentation

◆ MultimeterService() [1/2]

◆ MultimeterService() [2/2]

Member Function Documentation

◆ disableReadingNotifications()

◆ enableReadingNotifications()

◆ maxValue() [1/2]

◆ maxValue() [2/2]

◆ readCharacteristics()

◆ reading()

◆ readingRead

◆ readReadingCharacteristic()

◆ setSettings()

◆ settingsWritten

◆ toString() [1/3]

◆ toString() [2/3]

◆ toString() [3/3]

Friends And Related Symbol Documentation

◆ TestMultimeterService

Member Data Documentation

◆ serviceUuid