metercommand.cpp

// SPDX-FileCopyrightText: 2022-2024 Paul Colby <git@colby.id.au>
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#include "metercommand.h"
 
#include <qtpokit/pokitdevice.h>
 
#include <QJsonDocument>
#include <QJsonObject>
 
#include <iostream>
 
/*!
 * \class MeterCommand
 *
 * The MeterCommand class implements the `meter` CLI command.
 */
 
/*!
 * Construct a new MeterCommand object with \a parent.
 */
MeterCommand::MeterCommand(QObject * const parent) : DeviceCommand(parent)
{
 
}
 
QStringList MeterCommand::requiredOptions(const QCommandLineParser &parser) const
{
    return DeviceCommand::requiredOptions(parser) + QStringList{
        QLatin1String("mode"),
    };
}
 
QStringList MeterCommand::supportedOptions(const QCommandLineParser &parser) const
{
    return DeviceCommand::supportedOptions(parser) + QStringList{
        QLatin1String("interval"),
        QLatin1String("range"),
        QLatin1String("samples"),
    };
}
 
/*!
 * \copybrief DeviceCommand::processOptions
 *
 * This implementation extends DeviceCommand::processOptions to process additional CLI options
 * supported (or required) by this command.
 */
QStringList MeterCommand::processOptions(const QCommandLineParser &parser)
{
    QStringList errors = DeviceCommand::processOptions(parser);
    if (!errors.isEmpty()) {
        return errors;
    }
 
    // Parse the (required) mode option.
    if (const QString mode = parser.value(QLatin1String("mode")).trimmed().toLower();
        mode.startsWith(QLatin1String("ac v")) || mode.startsWith(QLatin1String("vac"))) {
        settings.mode = MultimeterService::Mode::AcVoltage;
        minRangeFunc = minVoltageRange;
    } else if (mode.startsWith(QLatin1String("dc v")) || mode.startsWith(QLatin1String("vdc"))) {
        settings.mode = MultimeterService::Mode::DcVoltage;
        minRangeFunc = minVoltageRange;
    } else if (mode.startsWith(QLatin1String("ac c")) || mode.startsWith(QLatin1String("aac"))) {
        settings.mode = MultimeterService::Mode::AcCurrent;
        minRangeFunc = minCurrentRange;
    } else if (mode.startsWith(QLatin1String("dc c")) || mode.startsWith(QLatin1String("adc"))) {
        settings.mode = MultimeterService::Mode::DcCurrent;
        minRangeFunc = minCurrentRange;
    } else if (mode.startsWith(QLatin1String("res"))) {
        settings.mode = MultimeterService::Mode::Resistance;
        minRangeFunc = minResistanceRange;
    } else if (mode.startsWith(QLatin1String("dio"))) {
        settings.mode = MultimeterService::Mode::Diode;
        minRangeFunc = nullptr;
    } else if (mode.startsWith(QLatin1String("cont"))) {
        settings.mode = MultimeterService::Mode::Continuity;
        minRangeFunc = nullptr;
    } else if (mode.startsWith(QLatin1String("temp"))) {
        settings.mode = MultimeterService::Mode::Temperature;
        minRangeFunc = nullptr;
    } else if (mode.startsWith(QLatin1String("cap"))) {
        settings.mode = MultimeterService::Mode::Capacitance;
        minRangeFunc = minCapacitanceRange;
    } else {
        errors.append(tr("Unknown meter mode: %1").arg(parser.value(QLatin1String("mode"))));
        return errors;
    }
 
    // Parse the interval option.
    if (parser.isSet(QLatin1String("interval"))) {
        const QString value = parser.value(QLatin1String("interval"));
        const quint32 interval = parseNumber<std::milli>(value, QLatin1String("s"), 500);
        if (interval == 0) {
            errors.append(tr("Invalid interval value: %1").arg(value));
        } else {
            settings.updateInterval = interval;
        }
    }
 
    // Parse the range option.
    rangeOptionValue = 0; // Default to auto.
    if (parser.isSet(QLatin1String("range"))) {
        const QString value = parser.value(QLatin1String("range"));
        if (value.trimmed().compare(QLatin1String("auto"), Qt::CaseInsensitive) != 0) {
            switch (settings.mode) {
            case MultimeterService::Mode::DcVoltage:
            case MultimeterService::Mode::AcVoltage:
                rangeOptionValue =  parseNumber<std::milli>(value, QLatin1String("V"), 50); // mV.
                break;
            case MultimeterService::Mode::DcCurrent:
            case MultimeterService::Mode::AcCurrent:
                rangeOptionValue = parseNumber<std::milli>(value, QLatin1String("A"), 5); // mA.
                break;
            case MultimeterService::Mode::Resistance:
                rangeOptionValue = parseNumber<std::ratio<1>>(value, QLatin1String("ohms"));
                break;
            case MultimeterService::Mode::Capacitance:
                rangeOptionValue = parseNumber<std::nano>(value, QLatin1String("F"), 500); // pF.
                break;
            default:
                qCInfo(lc).noquote() << tr("Ignoring range value: %1").arg(value);
            }
            if ((minRangeFunc != nullptr) && (rangeOptionValue == 0)) {
                errors.append(tr("Invalid range value: %1").arg(value));
            }
        }
    }
 
    // Parse the samples option.
    if (parser.isSet(QLatin1String("samples"))) {
        const QString value = parser.value(QLatin1String("samples"));
        const quint32 samples = parseNumber<std::ratio<1>>(value, QLatin1String("S"));
        if (samples == 0) {
            errors.append(tr("Invalid samples value: %1").arg(value));
        } else {
            samplesToGo = samples;
        }
    }
    return errors;
}
 
/*!
 * \copybrief DeviceCommand::getService
 *
 * This override returns a pointer to a MultimeterService object.
 */
AbstractPokitService * MeterCommand::getService()
{
    Q_ASSERT(device);
    if (!service) {
        service = device->multimeter();
        Q_ASSERT(service);
        connect(service, &MultimeterService::settingsWritten,
                this, &MeterCommand::settingsWritten);
    }
    return service;
}
 
/*!
 * \copybrief DeviceCommand::serviceDetailsDiscovered
 *
 * This override fetches the current device's status, and outputs it in the selected format.
 */
void MeterCommand::serviceDetailsDiscovered()
{
    DeviceCommand::serviceDetailsDiscovered(); // Just logs consistently.
    settings.range = (minRangeFunc == nullptr) ? 0 : minRangeFunc(*service->pokitProduct(), rangeOptionValue);
    const QString range = service->toString(settings.range, settings.mode);
    qCInfo(lc).noquote() << tr("Measuring %1, with range %2, every %L3ms.").arg(
        MultimeterService::toString(settings.mode),
        (range.isNull()) ? QString::fromLatin1("N/A") : range).arg(settings.updateInterval);
    service->setSettings(settings);
}
 
/*!
 * \var MeterCommand::minRangeFunc
 *
 * 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 discovere,
 * 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 \c nullptr.
 *
 * \see processOptions
 * \see serviceDetailsDiscovered
 */
 
/*!
 * Invoked when the multimeter settings have been written, to begin reading the meter values.
 */
void MeterCommand::settingsWritten()
{
    qCDebug(lc).noquote() << tr("Settings written; starting meter readings...");
    connect(service, &MultimeterService::readingRead,
            this, &MeterCommand::outputReading);
    service->enableReadingNotifications();
}
 
/*!
 * Outputs meter \a reading in the selected ouput format.
 */
void MeterCommand::outputReading(const MultimeterService::Reading &reading)
{
    QString status;
    if (reading.status == MultimeterService::MeterStatus::Error) {
        status = QLatin1String("Error");
    } else switch (reading.mode) {
    case MultimeterService::Mode::Idle:
        break;
    case MultimeterService::Mode::DcVoltage:
    case MultimeterService::Mode::AcVoltage:
    case MultimeterService::Mode::DcCurrent:
    case MultimeterService::Mode::AcCurrent:
    case MultimeterService::Mode::Resistance:
    case MultimeterService::Mode::Capacitance:
        status = (reading.status == MultimeterService::MeterStatus::AutoRangeOn)
            ? tr("Auto Range On") : tr("Auto Range Off");
        break;
    case MultimeterService::Mode::Continuity:
        status = (reading.status == MultimeterService::MeterStatus::Continuity)
            ? tr("Continuity") : tr("No continuity");
        break;
    case MultimeterService::Mode::Temperature:
    case MultimeterService::Mode::ExternalTemperature:
    case MultimeterService::Mode::Diode:
        status = tr("Ok");
        break;
    }
 
    QString unit;
    switch (reading.mode) {
    case MultimeterService::Mode::Idle:        break;
    case MultimeterService::Mode::DcVoltage:   unit = QLatin1String("Vdc"); break;
    case MultimeterService::Mode::AcVoltage:   unit = QLatin1String("Vac"); break;
    case MultimeterService::Mode::DcCurrent:   unit = QLatin1String("Adc"); break;
    case MultimeterService::Mode::AcCurrent:   unit = QLatin1String("Aac"); break;
    case MultimeterService::Mode::Resistance:  unit = QString::fromUtf8("Ω"); break;
    case MultimeterService::Mode::Diode:       break;
    case MultimeterService::Mode::Continuity:  break;
    case MultimeterService::Mode::Temperature: unit = QString::fromUtf8("°C"); break;
    case MultimeterService::Mode::Capacitance: unit = QString::fromUtf8("F");  break;
    case MultimeterService::Mode::ExternalTemperature: unit = QString::fromUtf8("°C"); break;
    }
 
    const QString range = service->toString(reading.range, reading.mode);
 
    switch (format) {
    case OutputFormat::Csv:
        for (; showCsvHeader; showCsvHeader = false) {
            std::cout << qUtf8Printable(tr("mode,value,unit,status,range\n"));
        }
        std::cout << qUtf8Printable(QString::fromLatin1("%1,%2,%3,%4,%5\n")
            .arg(escapeCsvField(MultimeterService::toString(reading.mode)))
            .arg(reading.value, 0, 'f').arg(unit, status, range)
            );
        break;
    case OutputFormat::Json: {
        QJsonObject object{
            { QLatin1String("status"), status },
            { QLatin1String("value"), qIsInf(reading.value) ?
                QJsonValue(tr("Infinity")) : QJsonValue(reading.value) },
            { QLatin1String("mode"),   MultimeterService::toString(reading.mode) },
        };
        if (!unit.isNull()) {
            object.insert(QLatin1String("unit"), unit);
        }
        if (!range.isNull()) {
            object.insert(QLatin1String("range"), range);
        }
        std::cout << QJsonDocument(object).toJson().toStdString();
    }   break;
    case OutputFormat::Text:
        std::cout << qUtf8Printable(tr("Mode:   %1 (0x%2)\n").arg(MultimeterService::toString(reading.mode))
            .arg((quint8)reading.mode,2,16,QLatin1Char('0')));
        std::cout << qUtf8Printable(tr("Value:  %1 %2\n").arg(reading.value,0,'f').arg(unit));
        std::cout << qUtf8Printable(tr("Status: %1 (0x%2)\n").arg(status)
            .arg((quint8)reading.status,2,16,QLatin1Char('0')));
        std::cout << qUtf8Printable(tr("Range:  %1 (0x%2)\n").arg(range)
            .arg((quint8)reading.range,2,16,QLatin1Char('0')));
        break;
    }
 
    if ((samplesToGo > 0) && (--samplesToGo == 0)) {
        if (device) disconnect(); // Will exit the application once disconnected.
    }
}