The DsoCommand class implements the dso CLI command. More...

Inheritance diagram for DsoCommand:

Collaboration diagram for DsoCommand:

Public Slots
QStringList	processOptions (const QCommandLineParser &parser) override
	Processes the relevant options from the command line parser.
Public Slots inherited from DeviceCommand
bool	start () override
	Begins scanning for the Pokit device.
Public Slots inherited from AbstractCommand
virtual QStringList	processOptions (const QCommandLineParser &parser)
	Processes the relevant options from the command line parser.
virtual bool	start ()=0
	Begins the functionality of this command, and returns true if begun successfully, false otherwise.

Public Member Functions
	DsoCommand (QObject *const parent=nullptr)
	Construct a new DsoCommand object with parent.
QStringList	requiredOptions (const QCommandLineParser &parser) const override
	Returns a list of CLI option names required by this command.
QStringList	supportedOptions (const QCommandLineParser &parser) const override
	Returns a list of CLI option names supported by this command.
Public Member Functions inherited from DeviceCommand
	DeviceCommand (QObject *const parent=nullptr)
	Construct a new DeviceCommand object with parent.
Public Member Functions inherited from AbstractCommand
	AbstractCommand (QObject *const parent=nullptr)
	Constructs a new command with parent.
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

Protected Slots
void	serviceDetailsDiscovered () override
	Handles service detail discovery events.
Protected Slots inherited from DeviceCommand
virtual void	controllerError (const QLowEnergyController::Error error)
	Handles controller error events.
virtual void	deviceDisconnected ()
	Handles device disconnection events.
virtual void	serviceError (const QLowEnergyService::ServiceError error)
	Handles service error events.
virtual void	serviceDetailsDiscovered ()
	Handles service detail discovery events.
Protected Slots inherited from AbstractCommand
virtual void	deviceDiscovered (const QBluetoothDeviceInfo &info)=0
	Handles PokitDiscoveryAgent::pokitDeviceDiscovered signal.
virtual void	deviceDiscoveryFinished ()=0
	Handles PokitDiscoveryAgent::deviceDiscoveryFinished signal.

Protected Member Functions
AbstractPokitService *	getService () override
	Returns a Pokit service object for the derived command class.
Protected Member Functions inherited from DeviceCommand
void	disconnect (int exitCode=EXIT_SUCCESS)
	Disconnects the underlying Pokit device, and sets exitCode to be return to the OS once the disconnection has taken place.
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)

Static Protected Member Functions
static quint16	maxWindowSize (const PokitProduct product)
	Returns the product's maximum sampling window size.
static bool	configureWindow (const PokitProduct product, const quint32 sampleRate, DsoService::Settings &settings)
	Configures the settings.numberOfSamples and/or settings.samplingWindow, if not already set, according to the requested sampleRate.
Static Protected Member Functions inherited from DeviceCommand
template<typename T>
static T	minRange (const quint32 maxValue)
static quint8	minCapacitanceRange (const PokitProduct product, const quint32 maxValue)
	Returns the product's lowest capacitance range that can measure at least up to maxValue (nF), or AutoRange if no such range is available.
static quint8	minCurrentRange (const PokitProduct product, const quint32 maxValue)
	Returns the product's lowest current range that can measure at least up to maxValue (μA), or AutoRange if no such range is available.
static quint8	minResistanceRange (const PokitProduct product, const quint32 maxValue)
	Returns the product's lowest resistance range that can measure at least up to maxValue (Ω), or AutoRange if no such range is available.
static quint8	minVoltageRange (const PokitProduct product, const quint32 maxValue)
	Returns the product's lowest voltage range that can measure at least up to maxValue (mV), or AutoRange if no such range is available.
Static Protected Member Functions inherited from AbstractCommand
static	Q_LOGGING_CATEGORY (lc, "dokit.cli.command", QtInfoMsg)
	Logging category for UI commands.

Private Slots
void	settingsWritten ()
	Invoked when the DSO settings have been written.
void	metadataRead (const DsoService::Metadata &data)
	Invoked when metadata has been received from the DSO.
void	outputSamples (const DsoService::Samples &samples)
	Outputs DSO samples in the selected output format.

Private Attributes
quint8(*	minRangeFunc )(const PokitProduct product, const quint32 maxValue)
	Pointer to function for converting rangeOptionValue to a Pokit device's range enumerator.
quint32	rangeOptionValue { 0 }
	The parsed value of range option.
quint32	sampleRateValue { 0 }
	The parsed value of the sample-rate option.
quint32	samplesValue { 0 }
	The parsed value of the samples option.
DsoService *	service { nullptr }
	Bluetooth service this command interacts with.
DsoService::Settings	settings
	Settings for the Pokit device's DSO mode.
DsoService::Metadata	metadata
	Most recent DSO metadata.
qint32	samplesToGo { 0 }
	Number of samples we're expecting in the current window.
bool	showCsvHeader { true }
	Whether or not to show a header as the first line of CSV output.

Additional Inherited Members
Public Types inherited from AbstractCommand
enum class	OutputFormat { Csv , Json , Text }
	Supported output formats. More...
Static Public Member Functions inherited from AbstractCommand
static QString	appendSiPrefix (const double value, int precision=6)
	Returns a human-readable version of value, with up-to precision decimal digits, and SI unit prefix when appropiate.
static QString	escapeCsvField (const QString &field)
	Returns an RFC 4180 compliant version of field.
template<typename R, typename T = quint32>
static T	parseNumber (const QString &value, const QString &unit, const T sensibleMinimum=0)
	Returns value as an integer multiple of the ratio R, as number of type T.
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)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Attributes inherited from DeviceCommand
PokitDevice *	device { nullptr }
	Pokit Bluetooth device (if any) this command interacts with.
int	exitCodeOnDisconnect { EXIT_FAILURE }
	Exit code to return on device disconnection.
Protected Attributes inherited from AbstractCommand
QString	deviceToScanFor
	Device (if any) that were passed to processOptions().
PokitDiscoveryAgent *	discoveryAgent
	Agent for Pokit device discovery.
OutputFormat	format { OutputFormat::Text }
	Selected output format.
Properties inherited from QObject
	objectName

Detailed Description

The DsoCommand class implements the dso CLI command.

Definition at line 10 of file dsocommand.h.

Constructor & Destructor Documentation

◆ DsoCommand()

DsoCommand::DsoCommand ( QObject *const parent = nullptr )

explicit

Construct a new DsoCommand object with parent.

Definition at line 25 of file dsocommand.cpp.

                                             : DeviceCommand(parent)
{
 
}

References DeviceCommand::DeviceCommand(), QObject::parent(), and QObject::QObject().

Here is the call graph for this function:

Member Function Documentation

◆ configureWindow()

bool DsoCommand::configureWindow	(	const PokitProduct	product,
		const quint32	sampleRate,
		DsoService::Settings &	settings )

staticprotected

Configures the settings.numberOfSamples and/or settings.samplingWindow, if not already set, according to the requested sampleRate.

The chosen settings will be limited to product's capaibilities.

Returns true os settings were set (either by this function, or they were already set), or false if the settings could not be determined succesfully (eg, because sampleRate was too high for the product).

Definition at line 262 of file dsocommand.cpp.

{
    const quint32 maxSampleRate = 1'000'000; // Pokit Meter and Pokit Pro both sample up to 1MHz.
    const quint32 maxWindowSize = DsoCommand::maxWindowSize(product);
 
    if (sampleRate > maxSampleRate) {
        qCWarning(lc).noquote() <<
            tr("The requested sample rate (%1Hz) likely exceeds the connected device's limit (%2Hz)")
            .arg(sampleRate).arg(maxSampleRate);
    }
 
    if (settings.numberOfSamples > maxWindowSize) {
        qCWarning(lc).noquote() <<
            tr("Requested window size (%1 samples) likely exceeds the connected device's limit (%2) samples")
            .arg(settings.samplingWindow).arg(maxWindowSize);
    }
 
    if ((settings.numberOfSamples != 0) && (settings.samplingWindow != 0)) {
        qCDebug(lc).noquote() << "Both numberOfSamples and samplingWindow are set, so no need to derive either";
        if (sampleRate != 0) {
            const quint32 derivedRate = settings.numberOfSamples * 1'000'000ull / settings.samplingWindow;
            qCDebug(lc).noquote() << "derivedRate" << derivedRate << sampleRate;
            if (sampleRate != derivedRate) {
                qCWarning(lc).noquote() << tr("Ignoring sample-rate, as interval and window-size both provided");
            }
        }
        return true; // Nothing more to do.
    }
    Q_ASSERT_X(sampleRate > 0, "DsoCommand::configureWindow", "processOptions should have rejected already");
 
    // If both window parameters are unset, choose the best window size (we'll choose a window period later).
    if ((settings.numberOfSamples == 0) && (settings.samplingWindow == 0)) {
        qCDebug(lc).noquote() << tr("Choosing best number-of-samples for sample-rate %2Hz").arg(sampleRate);
        double smallestDifference = std::numeric_limits<double>::quiet_NaN();
        for (quint32 windowSize = maxWindowSize; windowSize > 0; --windowSize) {
            const quint32 period = windowSize * 1'000'000ull / sampleRate;
            const double effectiveRate = double(windowSize) * 1'000'000.0 / (double)period;
            if (effectiveRate > maxSampleRate) continue; // Skip sizes that would exceed the device's max sample rate.
            if (const quint32 effectivePeriod = windowSize * 1'000'000ull / sampleRate;
                effectivePeriod > 1'000'000) continue; // Skip sizes that would take longer than 1s to fetch.
            const double difference = qAbs(effectiveRate - sampleRate);
            // qCDebug(lc).noquote() << tr("%1 samples, %2us, %3Hz, %4Hz, ±%5Hz").arg(windowSize).arg(period)
            //     .arg(effectiveRate, 0, 'f').arg(sampleRate).arg(difference, 0, 'f');
            if ((settings.numberOfSamples == 0) || (difference < smallestDifference)) {
                settings.numberOfSamples = windowSize;
                smallestDifference = difference;
            }
        }
        qCDebug(lc).noquote() << tr("Chose %Ln sample/s, with error ±%2Hz", nullptr,
            settings.numberOfSamples).arg(smallestDifference, 0, 'f');
        if (settings.numberOfSamples == 0) {
            qCCritical(lc).noquote() << tr("Failed to select a compatible window size for sample rate %1Hz").arg(sampleRate);
            return false;
        }
    }
 
    if (settings.numberOfSamples == 0) {
        qCDebug(lc).noquote() << tr("Calculating number-of-samples for %1us window at %2Hz")
            .arg(settings.samplingWindow).arg(sampleRate);
        Q_ASSERT(settings.samplingWindow != 0);
        const auto numberOfSamples = sampleRate * settings.samplingWindow / 1'000'000ull;
        qCDebug(lc).noquote() << tr("Calculated %Ln sample/s", nullptr, numberOfSamples);
        if ((numberOfSamples == 0) || (numberOfSamples > maxWindowSize)) {
            qCCritical(lc).noquote() << tr("Failed to calculate a valid number of samples for a %L1us period at %2Hz")
                .arg(settings.samplingWindow).arg(sampleRate);
            return false;
        }
        settings.numberOfSamples = numberOfSamples; // Note the implicit uint64 to uint16 conversion.
        Q_ASSERT(settings.numberOfSamples * 1'000'000ull / settings.samplingWindow <= sampleRate); // Due to integer truncation.
    }
 
    if (settings.samplingWindow == 0) {
        qCDebug(lc).noquote() << tr("Calculating sampling-window for %Ln sample/s at %1Hz", nullptr,
            settings.numberOfSamples).arg(sampleRate);
        Q_ASSERT(settings.numberOfSamples != 0);
        settings.samplingWindow = settings.numberOfSamples * 1'000'000ull / sampleRate;
        qCDebug(lc).noquote() << tr("Calculated %1us").arg(settings.samplingWindow);
        if (settings.samplingWindow == 0) {
            qCCritical(lc).noquote() << tr("Failed to calculate a valid sampling window for a %L1 samples at %1Hz")
            .arg(settings.numberOfSamples).arg(sampleRate);
            return false;
        }
    }
    return true;
}

References QString::arg(), maxWindowSize(), settings, and QObject::tr().

Referenced by serviceDetailsDiscovered().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getService()

AbstractPokitService * DsoCommand::getService ( )

overrideprotectedvirtual

Returns a Pokit service object for the derived command class.

This override returns a pointer to a DsoService object.

Implements DeviceCommand.

Definition at line 224 of file dsocommand.cpp.

{
    Q_ASSERT(device);
    if (!service) {
        service = device->dso();
        Q_ASSERT(service);
        connect(service, &DsoService::metadataRead,    this, &DsoCommand::metadataRead);
        connect(service, &DsoService::samplesRead,     this, &DsoCommand::outputSamples);
        connect(service, &DsoService::settingsWritten, this, &DsoCommand::settingsWritten);
    }
    return service;
}

References QObject::connect(), DeviceCommand::device, metadataRead(), DsoService::metadataRead(), outputSamples(), DsoService::samplesRead(), service, settingsWritten(), and DsoService::settingsWritten().

Here is the call graph for this function:

◆ maxWindowSize()

quint16 DsoCommand::maxWindowSize ( const PokitProduct product )

staticprotected

Returns the product's maximum sampling window size.

Pokit Bluetooth API errata: Pokit's official documentation claim the maximum is 8,192. However, my Pokit Meter fails for window size greater than 8,191, while my Pokit Pro supports up to 16,384 samples per window.

Definition at line 243 of file dsocommand.cpp.

{
    switch (product) {
    case PokitProduct::PokitMeter:
        return 8'191;
    case PokitProduct::PokitPro:
        return 16'384;
    }
    Q_ASSERT_X(false, "DsoCommand::maxWindowSize", "Unknown PokitProduct enum value");
    return 0;
}

References PokitMeter, and PokitPro.

Referenced by configureWindow(), and processOptions().

Here is the caller graph for this function:

◆ metadataRead

void DsoCommand::metadataRead ( const DsoService::Metadata & data )

privateslot

Invoked when metadata has been received from the DSO.

Definition at line 410 of file dsocommand.cpp.

{
    qCDebug(lc) << "status:" << (int)(data.status);
    qCDebug(lc) << "scale:" << data.scale;
    qCDebug(lc) << "mode:" << DsoService::toString(data.mode);
    qCDebug(lc) << "range:" << service->toString(data.range, data.mode);
    qCDebug(lc) << "samplingWindow:" << data.samplingWindow;
    qCDebug(lc) << "numberOfSamples:" << data.numberOfSamples;
    qCDebug(lc) << "samplingRate:" << data.samplingRate << "Hz";
    this->metadata = data;
    this->samplesToGo = data.numberOfSamples;
}

References metadata, DsoService::Metadata::mode, DsoService::Metadata::numberOfSamples, DsoService::Metadata::range, samplesToGo, DsoService::Metadata::samplingRate, DsoService::Metadata::samplingWindow, DsoService::Metadata::scale, service, DsoService::Metadata::status, and DsoService::toString().

Referenced by getService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ outputSamples

void DsoCommand::outputSamples ( const DsoService::Samples & samples )

privateslot

Outputs DSO samples in the selected output format.

Definition at line 426 of file dsocommand.cpp.

{
    QString unit;
    switch (metadata.mode) {
    case DsoService::Mode::DcVoltage: unit = u"Vdc"_s; break;
    case DsoService::Mode::AcVoltage: unit = u"Vac"_s; break;
    case DsoService::Mode::DcCurrent: unit = u"Adc"_s; break;
    case DsoService::Mode::AcCurrent: unit = u"Aac"_s; break;
    default:
        qCDebug(lc).noquote() << tr(R"(No known unit for mode %1 "%2".)").arg((int)metadata.mode)
            .arg(DsoService::toString(metadata.mode));
    }
    const QString range = service->toString(metadata.range, metadata.mode);
 
    for (const qint16 &sample: samples) {
        static quint32 sampleNumber = 0; ++sampleNumber;
        const float value = sample * metadata.scale;
        switch (format) {
        case OutputFormat::Csv:
            for (; showCsvHeader; showCsvHeader = false) {
                std::cout << qUtf8Printable(tr("sample_number,value,unit,range\n"));
            }
            std::cout << qUtf8Printable(QString::fromLatin1("%1,%2,%3,%4\n")
                .arg(sampleNumber).arg(value).arg(unit, range));
            break;
        case OutputFormat::Json:
            std::cout << QJsonDocument(QJsonObject{
                    { u"value"_s,  value },
                    { u"unit"_s,   unit },
                    { u"range"_s,  range },
                    { u"mode"_s,   DsoService::toString(metadata.mode) },
                }).toJson().toStdString();
            break;
        case OutputFormat::Text:
            std::cout << qUtf8Printable(tr("%1 %2 %3\n").arg(sampleNumber).arg(value).arg(unit));
            break;
        }
        --samplesToGo;
 
        if ((sampleNumber > samplesValue) && (samplesValue != 0)) {
            qCInfo(lc).noquote() << tr("Finished fetching %Ln sample/s. Disconnecting.", nullptr, sampleNumber);
            if (device) disconnect(); // Will exit the application once disconnected.
            return;
        }
    }
 
    // If we've received all the data for the current window, begin fetching another.
    if (samplesToGo <= 0) {
        qCDebug(lc).noquote() << tr("Finished fetching %Ln window sample/s (with %L2 to remaining).",
            nullptr, metadata.numberOfSamples).arg(samplesToGo);
        if (settings.range != +PokitMeter::VoltageRange::AutoRange) service->setSettings(settings);
    }
}

References DsoService::AcCurrent, DsoService::AcVoltage, QString::arg(), PokitMeter::AutoRange, AbstractCommand::Csv, DsoService::DcCurrent, DsoService::DcVoltage, DeviceCommand::device, DeviceCommand::disconnect(), AbstractCommand::format, QString::fromLatin1(), AbstractCommand::Json, metadata, samplesToGo, samplesValue, service, settings, showCsvHeader, AbstractCommand::Text, DsoService::toString(), and QObject::tr().

Referenced by getService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processOptions

QStringList DsoCommand::processOptions ( const QCommandLineParser & parser )

overrideslot

Processes the relevant options from the command line parser.

This implementation extends DeviceCommand::processOptions to process additional CLI options supported (or required) by this command.

Definition at line 56 of file dsocommand.cpp.

{
    QStringList errors = DeviceCommand::processOptions(parser);
    if (!errors.isEmpty()) {
        return errors;
    }
 
    // Parse the (required) mode option.
    if (const QString mode = parser.value(u"mode"_s).trimmed().toLower();
        mode.startsWith(u"ac v"_s) || mode.startsWith(u"vac"_s)) {
        settings.mode = DsoService::Mode::AcVoltage;
    } else if (mode.startsWith(u"dc v"_s) || mode.startsWith(u"vdc"_s)) {
        settings.mode = DsoService::Mode::DcVoltage;
    } else if (mode.startsWith(u"ac c"_s) || mode.startsWith(u"aac"_s)) {
        settings.mode = DsoService::Mode::AcCurrent;
    } else if (mode.startsWith(u"dc c"_s) || mode.startsWith(u"adc"_s)) {
        settings.mode = DsoService::Mode::DcCurrent;
    } else {
        errors.append(tr("Unknown DSO mode: %1").arg(parser.value(u"mode"_s)));
        return errors;
    }
 
    // Parse the (required) range option.
    QString unit;
    {
        const QString value = parser.value(u"range"_s);
        quint32 sensibleMinimum = 0;
        switch (settings.mode) {
        case DsoService::Mode::Idle:
            Q_ASSERT(false); // Not possible, since the mode parsing above never allows Idle.
            break;
        case DsoService::Mode::DcVoltage:
        case DsoService::Mode::AcVoltage:
            minRangeFunc = minVoltageRange;
            unit = u"V"_s;
            sensibleMinimum = 50; // mV.
            break;
        case DsoService::Mode::DcCurrent:
        case DsoService::Mode::AcCurrent:
            minRangeFunc = minCurrentRange;
            unit = u"A"_s;
            sensibleMinimum = 5; // mA.
            break;
        }
        Q_ASSERT(!unit.isEmpty());
        rangeOptionValue = parseNumber<std::milli>(value, unit, sensibleMinimum);
        if (rangeOptionValue == 0) {
            errors.append(tr("Invalid range value: %1").arg(value));
        }
    }
 
    // Parse the trigger-level option.
    if (parser.isSet(u"trigger-level"_s)) {
        float sign = 1.0;
        const QString rawValue = parser.value(u"trigger-level"_s);
        QString absValue = rawValue;
        DOKIT_STRING_INDEX_TYPE nonSpacePos;
        for (nonSpacePos = 0; (nonSpacePos < rawValue.length()) && (rawValue.at(nonSpacePos) == u' '); ++nonSpacePos);
        if ((nonSpacePos < rawValue.length()) && (rawValue.at(nonSpacePos) == u'-')) {
            absValue = rawValue.mid(nonSpacePos+1);
            sign = -1.0;
        }
        const float level = parseNumber<std::ratio<1>,float>(absValue, unit, 0.f);
        qCDebug(lc) << "Trigger level" << rawValue << absValue << nonSpacePos << sign << level;
        if (qIsNaN(level)) {
            errors.append(tr("Invalid trigger-level value: %1").arg(rawValue));
        } else {
            settings.triggerLevel = sign * level;
            qCDebug(lc) << "Trigger level" << settings.triggerLevel;
            // Check the trigger level is within the Votage / Current range.
            if ((rangeOptionValue != 0) && (qAbs(settings.triggerLevel) > (rangeOptionValue/1000.0))) {
                errors.append(tr("Trigger-level %1%2 is outside range ±%3%2").arg(
                    appendSiPrefix(settings.triggerLevel), unit, appendSiPrefix(rangeOptionValue / 1000.0)));
            }
        }
    }
 
    // Parse the trigger-mode option.
    if (parser.isSet(u"trigger-mode"_s)) {
        const QString triggerMode = parser.value(u"trigger-mode"_s).trimmed().toLower();
        if (triggerMode.startsWith(u"free"_s)) {
            settings.command = DsoService::Command::FreeRunning;
        } else if (triggerMode.startsWith(u"ris"_s)) {
           settings.command = DsoService::Command::RisingEdgeTrigger;
        } else if (triggerMode.startsWith(u"fall"_s)) {
            settings.command = DsoService::Command::FallingEdgeTrigger;
        } else {
            errors.append(tr("Unknown trigger mode: %1").arg(parser.value(u"trigger-mode"_s)));
        }
    }
 
    // Ensure that if either trigger option is present, then both are.
    if (parser.isSet(u"trigger-level"_s) != parser.isSet(u"trigger-mode"_s)) {
        errors.append(tr("If either option is provided, then both must be: trigger-level, trigger-mode"));
    }
 
    // Parse the sample-rate option.
    if (parser.isSet(u"sample-rate"_s)) {
        const QString value = parser.value(u"sample-rate"_s);
        sampleRateValue = parseNumber<std::ratio<1,1>>(value, u"Hz"_s, (quint32)50'000);
        if (sampleRateValue == 0) {
            errors.append(tr("Invalid sample-rate value: %1").arg(value));
        } else if (sampleRateValue > 1'000'000) {
            qCWarning(lc).noquote() << tr("Pokit devices do not officially support sample rates greater than 1Mhz");
        }
    }
 
    // Parse the interval option.
    if (parser.isSet(u"interval"_s)) {
        const QString value = parser.value(u"interval"_s);
        const quint32 interval = parseNumber<std::micro>(value, u"s"_s, (quint32)500'000);
        if (interval == 0) {
            errors.append(tr("Invalid interval value: %1").arg(value));
        } else {
            settings.samplingWindow = interval;
        }
    }
 
    // Parse the window-size option.
    if (parser.isSet(u"window-size"_s)) {
        const QString value = parser.value(u"window-size"_s);
        const quint32 samples = parseNumber<std::ratio<1>>(value, u"S"_s);
        if (samples == 0) {
            errors.append(tr("Invalid window-size value: %1").arg(value));
        } else if (samples > std::numeric_limits<quint16>::max()) {
            errors.append(tr("Window size value (%1) must be no greater than %2")
                .arg(value).arg(std::numeric_limits<quint16>::max()));
        } else {
            settings.numberOfSamples = (quint16)samples;
            if (const auto maxSamples = maxWindowSize(PokitProduct::PokitPro); settings.numberOfSamples > maxSamples) {
                qCWarning(lc).noquote() <<
                    tr("No Pokit device officially supports windows greater than %L1 samples").arg(maxSamples);
            }
        }
    }
 
    // Ensure that we have at least: sample-rate, or both interval and window-size.
    if ((!parser.isSet(u"sample-rate"_s)) && !(parser.isSet(u"interval"_s) && parser.isSet(u"window-size"_s))) {
        errors.append(tr("Missing required option/s: either sample-rate, or both interval and window-size"));
    }
 
    // If we have all three sample-rate related options, ensure they agree.
    if ((sampleRateValue != 0) && (settings.numberOfSamples != 0) && (settings.samplingWindow != 0)) {
        const quint32 sampleRate = settings.numberOfSamples * 1'000'000ull / settings.samplingWindow;
        if (sampleRate != sampleRateValue) {
            errors.append(tr("Windows size (%1 samples) and interval (%2ns) yield a sample rate of %3Hz, which does "
                "not match the supplied sample-rate (%4Hz). Tip: leave one option unset to have dokit calculate the "
                "remaining option.").arg(settings.numberOfSamples).arg(settings.samplingWindow).arg(sampleRate)
                .arg(sampleRateValue));
        }
    }
 
    // Parse the samples option.
    if (parser.isSet(u"samples"_s)) {
        const QString value = parser.value(u"samples"_s);
        samplesValue = parseNumber<std::ratio<1>>(value, u"S"_s);
        if (samplesValue == 0) {
            errors.append(tr("Invalid samples value: %1").arg(value));
        }
    }
    return errors;
}

References DsoService::AcCurrent, DsoService::AcVoltage, QList::append(), AbstractCommand::appendSiPrefix(), QString::arg(), QString::at(), DsoService::DcCurrent, DsoService::DcVoltage, DOKIT_STRING_INDEX_TYPE, DsoService::FallingEdgeTrigger, DsoService::FreeRunning, DsoService::Idle, QList::isEmpty(), QString::isEmpty(), QCommandLineParser::isSet(), QString::length(), maxWindowSize(), QString::mid(), DeviceCommand::minCurrentRange(), minRangeFunc, DeviceCommand::minVoltageRange(), AbstractCommand::parseNumber(), PokitPro, AbstractCommand::processOptions(), rangeOptionValue, DsoService::RisingEdgeTrigger, sampleRateValue, samplesValue, settings, QString::startsWith(), QString::toLower(), QObject::tr(), QString::trimmed(), and QCommandLineParser::value().

Here is the call graph for this function:

◆ requiredOptions()

QStringList DsoCommand::requiredOptions ( const QCommandLineParser & parser ) const

overridevirtual

Returns a list of CLI option names required by this command.

The main console appication may use this list to output an error (and exit) if any of the returned names are not found in the parsed CLI options.

The (already parsed) parser may be used adjust the returned required options depending on the value of other options. For example, the logger command only requires the --mode option if the --command option is start.

This base implementation simply returns an empty list. Derived classes should override this function to include any required options.

Reimplemented from AbstractCommand.

Definition at line 30 of file dsocommand.cpp.

{
    return DeviceCommand::requiredOptions(parser) + QStringList{
        u"mode"_s,
        u"range"_s,
    };
}

References AbstractCommand::requiredOptions().

Here is the call graph for this function:

◆ serviceDetailsDiscovered

void DsoCommand::serviceDetailsDiscovered ( )

overrideprotectedslot

Handles service detail discovery events.

This override fetches the current device's status, and outputs it in the selected format.

Definition at line 353 of file dsocommand.cpp.

{
    DeviceCommand::serviceDetailsDiscovered(); // Just logs consistently.
    settings.range = (minRangeFunc == nullptr) ? 0 : minRangeFunc(*service->pokitProduct(), rangeOptionValue);
    if (!configureWindow(*service->pokitProduct(), sampleRateValue, settings)) {
        disconnect(EXIT_FAILURE);
        return;
    }
    if (samplesValue == 0) samplesValue = settings.numberOfSamples;
    const QString range = service->toString(settings.range, settings.mode);
    const QString triggerInfo = (settings.command == DsoService::Command::FreeRunning) ? QString() :
        tr(", and a %1 at %2%3%4 (%5Hz)").arg(DsoService::toString(settings.command).toLower(),
            (settings.triggerLevel < 0.) ? u"-"_s : u""_s, appendSiPrefix(qAbs(settings.triggerLevel)),
            range.at(range.size()-1));
    qCInfo(lc).noquote() << tr("Sampling %1, with range %2, at %L3Hz (%Ln sample/s over %L4us)%5", nullptr, settings.numberOfSamples)
        .arg(DsoService::toString(settings.mode), (range.isNull()) ? QString::fromLatin1("N/A") : range)
        .arg(settings.numberOfSamples * 1'000'000ull / settings.samplingWindow).arg(settings.samplingWindow)
        .arg(triggerInfo);
    if (!service->enableMetadataNotifications()) {
        qCCritical(lc).noquote() << tr("Failed to enable metadata notifications");
        disconnect(EXIT_FAILURE);
        return;
    }
    if (!service->enableReadingNotifications()) {
        qCCritical(lc).noquote() << tr("Failed to enable reading notifications");
        disconnect(EXIT_FAILURE);
        return;
    }
    service->setSettings(settings);
}

References AbstractCommand::appendSiPrefix(), QString::arg(), QString::at(), configureWindow(), DeviceCommand::disconnect(), DsoService::FreeRunning, QString::fromLatin1(), QString::isNull(), minRangeFunc, rangeOptionValue, sampleRateValue, samplesValue, service, DeviceCommand::serviceDetailsDiscovered(), settings, QString::size(), DsoService::toString(), and QObject::tr().

Here is the call graph for this function:

◆ settingsWritten

void DsoCommand::settingsWritten ( )

privateslot

Invoked when the DSO settings have been written.

Definition at line 401 of file dsocommand.cpp.

{
    Q_ASSERT(service);
    qCDebug(lc).noquote() << tr("Settings written; DSO has started.");
}

References service, and QObject::tr().

Referenced by getService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportedOptions()

QStringList DsoCommand::supportedOptions ( const QCommandLineParser & parser ) const

overridevirtual

Returns a list of CLI option names supported by this command.

The main console appication may use this list to output a warning for any parsed CLI options not included in the returned list.

The (already parsed) parser may be used adjust the returned supported options depending on the value of other options. For example, the logger command only supported the --timestamp option if the --command option is start.

This base implementation simply returns requiredOptions(). Derived classes should override this function to include optional options, such as:

QStringList Derived::supportedOptions(const QCommandLineParser &parser) const
{
    const QStringList list = AbstractCommand::supportedOptions(parser) + QStringList{ ... };
    list.sort();
    list.removeDuplicates(); // Optional, recommended.
    return list;
}

Reimplemented from AbstractCommand.

Definition at line 38 of file dsocommand.cpp.

{
    return DeviceCommand::supportedOptions(parser) + QStringList{
        u"interval"_s,
        u"samples"_s,
        u"sample-rate"_s,
        u"trigger-level"_s,
        u"trigger-mode"_s,
        u"window-size"_s,
    };
}

References AbstractCommand::supportedOptions().

Here is the call graph for this function:

Member Data Documentation

◆ metadata

DsoService::Metadata DsoCommand::metadata

private

Most recent DSO metadata.

Definition at line 41 of file dsocommand.h.

Referenced by metadataRead(), and outputSamples().

◆ minRangeFunc

quint8(* DsoCommand::minRangeFunc) (const PokitProduct product, const quint32 maxValue)

inlineprivate

Pointer to function for converting rangeOptionValue to a Pokit device's range enumerator.

This function pointer is assigned during the command line parsing, but is not invoked until after the device's services are discovered, because prior to that discovery, we don't know which product (Meter vs Pro vs Clamp, etc) we're talking to and thus which enumerator list to be using.

If the current mode does not support ranges (eg diode, and continuity modes), then this member will be nullptr.

See also: processOptions; serviceDetailsDiscovered

Definition at line 32 of file dsocommand.h.

32{ nullptr };

Referenced by processOptions(), and serviceDetailsDiscovered().

◆ rangeOptionValue

quint32 DsoCommand::rangeOptionValue { 0 }

private

The parsed value of range option.

Definition at line 33 of file dsocommand.h.

33{ 0 }; ///< The parsed value of range option.

Referenced by processOptions(), and serviceDetailsDiscovered().

◆ sampleRateValue

quint32 DsoCommand::sampleRateValue { 0 }

private

The parsed value of the sample-rate option.

Definition at line 34 of file dsocommand.h.

34{ 0 }; ///< The parsed value of the sample-rate option.

Referenced by processOptions(), and serviceDetailsDiscovered().

◆ samplesToGo

qint32 DsoCommand::samplesToGo { 0 }

private

Number of samples we're expecting in the current window.

Definition at line 42 of file dsocommand.h.

42{ 0 }; ///< Number of samples we're expecting in the current window.

Referenced by metadataRead(), and outputSamples().

◆ samplesValue

quint32 DsoCommand::samplesValue { 0 }

private

The parsed value of the samples option.

Definition at line 35 of file dsocommand.h.

35{ 0 }; ///< The parsed value of the samples option.

Referenced by outputSamples(), processOptions(), and serviceDetailsDiscovered().

◆ service

DsoService* DsoCommand::service { nullptr }

private

Bluetooth service this command interacts with.

Definition at line 36 of file dsocommand.h.

36{ nullptr }; ///< Bluetooth service this command interacts with.

Referenced by getService(), metadataRead(), outputSamples(), serviceDetailsDiscovered(), and settingsWritten().

◆ settings

DsoService::Settings DsoCommand::settings

private

Initial value:

{
        DsoService::Command::FreeRunning, 0.0f, DsoService::Mode::DcVoltage,
        +PokitMeter::VoltageRange::AutoRange, 0, 0
    }

Settings for the Pokit device's DSO mode.

Definition at line 37 of file dsocommand.h.

                                {   ///< Settings for the Pokit device's DSO mode.
        DsoService::Command::FreeRunning, 0.0f, DsoService::Mode::DcVoltage,
        +PokitMeter::VoltageRange::AutoRange, 0, 0
    };

Referenced by configureWindow(), outputSamples(), processOptions(), and serviceDetailsDiscovered().

◆ showCsvHeader

bool DsoCommand::showCsvHeader { true }

private

Whether or not to show a header as the first line of CSV output.

Definition at line 43 of file dsocommand.h.

43{ true }; ///< Whether or not to show a header as the first line of CSV output.

Referenced by outputSamples().

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

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Static Protected Member Functions

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DsoCommand()

Member Function Documentation

◆ configureWindow()

◆ getService()

◆ maxWindowSize()

◆ metadataRead

◆ outputSamples

◆ processOptions

◆ requiredOptions()

◆ serviceDetailsDiscovered

◆ settingsWritten

◆ supportedOptions()

Member Data Documentation

◆ metadata

◆ minRangeFunc

◆ rangeOptionValue

◆ sampleRateValue

◆ samplesToGo

◆ samplesValue

◆ service

◆ settings

◆ showCsvHeader