2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
26 #include <pv/prop/bool.hpp>
27 #include <pv/prop/enum.hpp>
28 #include <pv/prop/int.hpp>
30 #include <libsigrokcxx/libsigrokcxx.hpp>
32 using boost::optional;
37 using std::shared_ptr;
41 using sigrok::Capability;
42 using sigrok::Configurable;
43 using sigrok::ConfigKey;
49 using pv::prop::Property;
54 Device::Device(shared_ptr<sigrok::Configurable> configurable) :
55 configurable_(configurable)
58 auto keys = configurable->config_keys();
60 for (auto key : keys) {
64 descr_str = key->description();
66 descr_str = key->name();
68 const QString descr = QString::fromStdString(descr_str);
70 auto capabilities = configurable->config_capabilities(key);
72 if (!capabilities.count(Capability::GET) ||
73 !capabilities.count(Capability::SET)) {
75 // Ignore common read-only keys
76 if ((key->id() == SR_CONF_CONTINUOUS) || (key->id() == SR_CONF_TRIGGER_MATCH) ||
77 (key->id() == SR_CONF_CONN) || (key->id() == SR_CONF_SERIALCOMM) || (key->id() == SR_CONF_NUM_LOGIC_CHANNELS) ||
78 (key->id() == SR_CONF_NUM_ANALOG_CHANNELS) || (key->id() == SR_CONF_SESSIONFILE) || (key->id() == SR_CONF_CAPTUREFILE) ||
79 (key->id() == SR_CONF_CAPTURE_UNITSIZE))
82 qDebug() << QString(tr("Note for device developers: Ignoring device configuration capability '%1' " \
83 "as it is missing GET and/or SET")).arg(descr);
87 const Property::Getter get = [&, key]() {
88 return configurable_->config_get(key); };
89 const Property::Setter set = [&, key](Glib::VariantBase value) {
90 configurable_->config_set(key, value);
95 case SR_CONF_SAMPLERATE:
96 // Sample rate values are not bound because they are shown
100 case SR_CONF_CAPTURE_RATIO:
101 bind_int(descr, "", "%", pair<int64_t, int64_t>(0, 100), get, set);
104 case SR_CONF_LIMIT_FRAMES:
105 // Value 0 means that there is no limit
106 bind_int(descr, "", "", pair<int64_t, int64_t>(0, 1000000), get, set,
110 case SR_CONF_PATTERN_MODE:
111 case SR_CONF_BUFFERSIZE:
112 case SR_CONF_TRIGGER_SOURCE:
113 case SR_CONF_TRIGGER_SLOPE:
114 case SR_CONF_COUPLING:
115 case SR_CONF_CLOCK_EDGE:
116 case SR_CONF_DATA_SOURCE:
117 case SR_CONF_EXTERNAL_CLOCK_SOURCE:
118 bind_enum(descr, "", key, capabilities, get, set);
122 case SR_CONF_EXTERNAL_CLOCK:
124 case SR_CONF_POWER_OFF:
125 case SR_CONF_AVERAGING:
126 bind_bool(descr, "", get, set);
129 case SR_CONF_TIMEBASE:
130 bind_enum(descr, "", key, capabilities, get, set, print_timebase);
134 bind_enum(descr, "", key, capabilities, get, set, print_vdiv);
137 case SR_CONF_VOLTAGE_THRESHOLD:
138 bind_enum(descr, "", key, capabilities, get, set, print_voltage_threshold);
141 case SR_CONF_PROBE_FACTOR:
142 if (capabilities.count(Capability::LIST))
143 bind_enum(descr, "", key, capabilities, get, set, print_probe_factor);
145 bind_int(descr, "", "", pair<int64_t, int64_t>(1, 500), get, set);
148 case SR_CONF_AVG_SAMPLES:
149 if (capabilities.count(Capability::LIST))
150 bind_enum(descr, "", key, capabilities, get, set, print_averages);
152 bind_int(descr, "", "", pair<int64_t, int64_t>(0, INT32_MAX), get, set);
161 void Device::bind_bool(const QString &name, const QString &desc,
162 Property::Getter getter, Property::Setter setter)
164 assert(configurable_);
165 properties_.push_back(shared_ptr<Property>(new Bool(
166 name, desc, getter, setter)));
169 void Device::bind_enum(const QString &name, const QString &desc,
170 const ConfigKey *key, set<const Capability *> capabilities,
171 Property::Getter getter,
172 Property::Setter setter, function<QString (Glib::VariantBase)> printer)
174 assert(configurable_);
176 if (!capabilities.count(Capability::LIST))
180 Glib::VariantContainerBase gvar = configurable_->config_list(key);
181 Glib::VariantIter iter(gvar);
183 vector< pair<Glib::VariantBase, QString> > values;
184 while ((iter.next_value(gvar)))
185 values.emplace_back(gvar, printer(gvar));
187 properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
190 } catch (sigrok::Error& e) {
191 qDebug() << "Error: Listing device key" << name << "failed!";
196 void Device::bind_int(const QString &name, const QString &desc, QString suffix,
197 optional< pair<int64_t, int64_t> > range, Property::Getter getter,
198 Property::Setter setter, QString special_value_text)
200 assert(configurable_);
202 properties_.push_back(shared_ptr<Property>(new Int(name, desc, suffix,
203 range, getter, setter, special_value_text)));
206 QString Device::print_timebase(Glib::VariantBase gvar)
209 g_variant_get(gvar.gobj(), "(tt)", &p, &q);
210 return QString::fromUtf8(sr_period_string(p, q));
213 QString Device::print_vdiv(Glib::VariantBase gvar)
216 g_variant_get(gvar.gobj(), "(tt)", &p, &q);
217 return QString::fromUtf8(sr_voltage_string(p, q));
220 QString Device::print_voltage_threshold(Glib::VariantBase gvar)
223 g_variant_get(gvar.gobj(), "(dd)", &lo, &hi);
224 return QString("L<%1V H>%2V").arg(lo, 0, 'f', 1).arg(hi, 0, 'f', 1);
227 QString Device::print_probe_factor(Glib::VariantBase gvar)
230 factor = g_variant_get_uint64(gvar.gobj());
231 return QString("%1x").arg(factor);
234 QString Device::print_averages(Glib::VariantBase gvar)
237 avg = g_variant_get_uint64(gvar.gobj());
238 return QString("%1").arg(avg);
241 } // namespace binding