Line data Source code
1 : // SPDX-FileCopyrightText: 2022-2025 Paul Colby <git@colby.id.au>
2 : // SPDX-License-Identifier: LGPL-3.0-or-later
3 :
4 : #include "loggerstartcommand.h"
5 : #include "../stringliterals_p.h"
6 :
7 : #include <qtpokit/pokitdevice.h>
8 :
9 : #include <QDateTime>
10 : #include <QJsonDocument>
11 : #include <QJsonObject>
12 :
13 : #include <iostream>
14 :
15 : DOKIT_USE_STRINGLITERALS
16 :
17 : /*!
18 : * \class LoggerStartCommand
19 : *
20 : * The LoggerStartCommand class implements the `logger` CLI command.
21 : */
22 :
23 : /*!
24 : * Construct a new LoggerStartCommand object with \a parent.
25 : */
26 3672 : LoggerStartCommand::LoggerStartCommand(QObject * const parent) : DeviceCommand(parent)
27 1944 : {
28 :
29 4104 : }
30 :
31 3600 : QStringList LoggerStartCommand::requiredOptions(const QCommandLineParser &parser) const
32 3240 : {
33 16110 : return DeviceCommand::requiredOptions(parser) + QStringList{
34 3240 : u"mode"_s,
35 12735 : };
36 3240 : }
37 :
38 1760 : QStringList LoggerStartCommand::supportedOptions(const QCommandLineParser &parser) const
39 1584 : {
40 11132 : return DeviceCommand::supportedOptions(parser) + QStringList{
41 1584 : u"interval"_s,
42 1584 : u"range"_s, // May still be required by processOptions(), depending on the --mode option's value.
43 1584 : u"timestamp"_s,
44 9746 : };
45 1584 : }
46 :
47 : /*!
48 : * \copybrief DeviceCommand::processOptions
49 : *
50 : * This implementation extends DeviceCommand::processOptions to process additional CLI options
51 : * supported (or required) by this command.
52 : */
53 1680 : QStringList LoggerStartCommand::processOptions(const QCommandLineParser &parser)
54 1512 : {
55 3192 : QStringList errors = DeviceCommand::processOptions(parser);
56 3192 : if (!errors.isEmpty()) {
57 144 : return errors;
58 144 : }
59 :
60 : // Parse the (required) mode option.
61 4408 : if (const QString mode = parser.value(u"mode"_s).trimmed().toLower();
62 5225 : mode.startsWith(u"ac v"_s) || mode.startsWith(u"vac"_s)) {
63 152 : settings.mode = DataLoggerService::Mode::AcVoltage;
64 152 : minRangeFunc = minVoltageRange;
65 4950 : } else if (mode.startsWith(u"dc v"_s) || mode.startsWith(u"vdc"_s)) {
66 1976 : settings.mode = DataLoggerService::Mode::DcVoltage;
67 1976 : minRangeFunc = minVoltageRange;
68 1951 : } else if (mode.startsWith(u"ac c"_s) || mode.startsWith(u"aac"_s)) {
69 152 : settings.mode = DataLoggerService::Mode::AcCurrent;
70 152 : minRangeFunc = minCurrentRange;
71 1100 : } else if (mode.startsWith(u"dc c"_s) || mode.startsWith(u"adc"_s)) {
72 152 : settings.mode = DataLoggerService::Mode::DcCurrent;
73 152 : minRangeFunc = minCurrentRange;
74 585 : } else if (mode.startsWith(u"temp"_s)) {
75 304 : settings.mode = DataLoggerService::Mode::Temperature;
76 304 : minRangeFunc = nullptr;
77 144 : } else {
78 152 : minRangeFunc = nullptr;
79 241 : errors.append(tr("Unknown logger mode: %1").arg(parser.value(u"mode"_s)));
80 72 : return errors;
81 775 : }
82 :
83 : // Parse the range option.
84 2736 : rangeOptionValue = 0;
85 3510 : if (parser.isSet(u"range"_s)) {
86 2584 : const QString value = parser.value(u"range"_s);
87 2584 : switch (settings.mode) {
88 1904 : case DataLoggerService::Mode::DcVoltage:
89 936 : case DataLoggerService::Mode::AcVoltage:
90 1976 : rangeOptionValue = parseNumber<std::milli>(value, u"V"_s, 50); // mV.
91 1976 : break;
92 232 : case DataLoggerService::Mode::DcCurrent:
93 144 : case DataLoggerService::Mode::AcCurrent:
94 304 : rangeOptionValue = parseNumber<std::milli>(value, u"A"_s, 5); // mA.
95 304 : break;
96 304 : default:
97 608 : qCInfo(lc).noquote() << tr("Ignoring range value: %1").arg(value);
98 1224 : }
99 2584 : if ((minRangeFunc != nullptr) && (rangeOptionValue == 0)) {
100 195 : errors.append(tr("Invalid range value: %1").arg(value));
101 72 : }
102 1933 : } else if (settings.mode != DataLoggerService::Mode::Temperature) {
103 241 : errors.append(tr("Missing required option for logger mode '%1': range").arg(parser.value(u"mode"_s)));
104 72 : }
105 :
106 : // Parse the interval option.
107 3510 : if (parser.isSet(u"interval"_s)) {
108 1020 : const QString value = parser.value(u"interval"_s);
109 760 : const quint32 interval = parseNumber<std::milli>(value, u"s"_s, 500);
110 760 : if (interval == 0) {
111 390 : errors.append(tr("Invalid interval value: %1").arg(value));
112 216 : } else {
113 456 : settings.updateInterval = interval;
114 216 : }
115 545 : }
116 :
117 : // Parse the timestamp option.
118 2736 : settings.timestamp = (quint32)QDateTime::currentSecsSinceEpoch(); // Note, subject to Y2038 epochalypse.
119 3510 : if (parser.isSet(u"timestamp"_s)) {
120 760 : const QString value = parser.value(u"timestamp"_s);
121 760 : QLocale locale; bool ok;
122 360 : static_assert(sizeof(uint) == sizeof(settings.timestamp), "QLocale has no toUint32().");
123 545 : const int timestamp = locale.toUInt(value, &ok);
124 760 : if (!ok) {
125 390 : errors.append(tr("Invalid timestamp value: %1").arg(value));
126 216 : } else {
127 456 : settings.timestamp = timestamp;
128 216 : }
129 760 : }
130 1296 : return errors;
131 1296 : }
132 :
133 : /*!
134 : * \copybrief DeviceCommand::getService
135 : *
136 : * This override returns a pointer to a DataLoggerService object.
137 : */
138 0 : AbstractPokitService * LoggerStartCommand::getService()
139 0 : {
140 0 : Q_ASSERT(device);
141 0 : if (!service) {
142 0 : service = device->dataLogger();
143 0 : Q_ASSERT(service);
144 0 : connect(service, &DataLoggerService::settingsWritten, this, &LoggerStartCommand::settingsWritten);
145 0 : }
146 0 : return service;
147 0 : }
148 :
149 : /*!
150 : * \copybrief DeviceCommand::serviceDetailsDiscovered
151 : *
152 : * This override fetches the current device's status, and outputs it in the selected format.
153 : */
154 0 : void LoggerStartCommand::serviceDetailsDiscovered()
155 0 : {
156 0 : DeviceCommand::serviceDetailsDiscovered(); // Just logs consistently.
157 0 : settings.range = (minRangeFunc == nullptr) ? 0 : minRangeFunc(*service->pokitProduct(), rangeOptionValue);
158 0 : const QString range = service->toString(settings.range, settings.mode);
159 0 : qCInfo(lc).noquote() << tr("Logging %1, with range %2, every %L3ms.").arg(DataLoggerService::toString(settings.mode),
160 0 : (range.isNull()) ? QString::fromLatin1("N/A") : range).arg(settings.updateInterval);
161 0 : service->setSettings(settings);
162 0 : }
163 :
164 : /*!
165 : * \var LoggerStartCommand::minRangeFunc
166 : *
167 : * Pointer to function for converting #rangeOptionValue to a Pokit device's range enumerator. This function pointer
168 : * is assigned during the command line parsing, but is not invoked until after the device's services are discovered,
169 : * because prior to that discovery, we don't know which product (Meter vs Pro vs Clamp, etc) we're talking to and thus
170 : * which enumerator list to be using.
171 : *
172 : * If the current mode does not support ranges (eg diode, and continuity modes), then this member will be \c nullptr.
173 : *
174 : * \see processOptions
175 : * \see serviceDetailsDiscovered
176 : */
177 :
178 : /*!
179 : * Invoked when the data logger settings have been written.
180 : */
181 240 : void LoggerStartCommand::settingsWritten()
182 216 : {
183 543 : qCDebug(lc).noquote() << tr("Settings written; data logger has started.");
184 456 : switch (format) {
185 152 : case OutputFormat::Csv:
186 164 : std::cout << qUtf8Printable(tr("logger_start_result\nsuccess\n"));
187 152 : break;
188 152 : case OutputFormat::Json:
189 164 : std::cout << qUtf8Printable(u"true\n"_s);
190 152 : break;
191 152 : case OutputFormat::Text:
192 164 : std::cout << qUtf8Printable(tr("Done.\n"));
193 152 : break;
194 216 : }
195 456 : if (device) disconnect(); // Will exit the application once disconnected.
196 456 : }
|
