pv/binding/device.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include <cstdint>
  21
  22 #include <QDebug>
  23
  24 #include "device.hpp"
  25
  26 #include <pv/prop/bool.hpp>
  27 #include <pv/prop/enum.hpp>
  28 #include <pv/prop/int.hpp>
  29
  30 #include <libsigrokcxx/libsigrokcxx.hpp>
  31
  32 using boost::optional;
  33
  34 using std::function;
  35 using std::pair;
  36 using std::set;
  37 using std::shared_ptr;
  38 using std::string;
  39 using std::vector;
  40
  41 using sigrok::Capability;
  42 using sigrok::Configurable;
  43 using sigrok::ConfigKey;
  44 using sigrok::Error;
  45
  46 using pv::prop::Bool;
  47 using pv::prop::Enum;
  48 using pv::prop::Int;
  49 using pv::prop::Property;
  50
  51 namespace pv {
  52 namespace binding {
  53
  54 Device::Device(shared_ptr<sigrok::Configurable> configurable) :
  55         configurable_(configurable)
  56 {
  57
  58         auto keys = configurable->config_keys();
  59
  60         for (auto key : keys) {
  61
  62                 auto capabilities = configurable->config_capabilities(key);
  63
  64                 if (!capabilities.count(Capability::GET) ||
  65                         !capabilities.count(Capability::SET))
  66                         continue;
  67
  68                 string name_str;
  69                 try {
  70                         name_str = key->description();
  71                 } catch (Error& e) {
  72                         name_str = key->name();
  73                 }
  74
  75                 const QString name = QString::fromStdString(name_str);
  76
  77                 const Property::Getter get = [&, key]() {
  78                         return configurable_->config_get(key); };
  79                 const Property::Setter set = [&, key](Glib::VariantBase value) {
  80                         configurable_->config_set(key, value);
  81                         config_changed();
  82                 };
  83
  84                 switch (key->id()) {
  85                 case SR_CONF_SAMPLERATE:
  86                         // Sample rate values are not bound because they are shown
  87                         // in the MainBar
  88                         break;
  89
  90                 case SR_CONF_CAPTURE_RATIO:
  91                         bind_int(name, "", "%", pair<int64_t, int64_t>(0, 100), get, set);
  92                         break;
  93
  94                 case SR_CONF_PATTERN_MODE:
  95                 case SR_CONF_BUFFERSIZE:
  96                 case SR_CONF_TRIGGER_SOURCE:
  97                 case SR_CONF_TRIGGER_SLOPE:
  98                 case SR_CONF_COUPLING:
  99                 case SR_CONF_CLOCK_EDGE:
 100                 case SR_CONF_DATA_SOURCE:
 101                 case SR_CONF_EXTERNAL_CLOCK_SOURCE:
 102                         bind_enum(name, "", key, capabilities, get, set);
 103                         break;
 104
 105                 case SR_CONF_FILTER:
 106                 case SR_CONF_EXTERNAL_CLOCK:
 107                 case SR_CONF_RLE:
 108                 case SR_CONF_POWER_OFF:
 109                 case SR_CONF_AVERAGING:
 110                         bind_bool(name, "", get, set);
 111                         break;
 112
 113                 case SR_CONF_TIMEBASE:
 114                         bind_enum(name, "", key, capabilities, get, set, print_timebase);
 115                         break;
 116
 117                 case SR_CONF_VDIV:
 118                         bind_enum(name, "", key, capabilities, get, set, print_vdiv);
 119                         break;
 120
 121                 case SR_CONF_VOLTAGE_THRESHOLD:
 122                         bind_enum(name, "", key, capabilities, get, set, print_voltage_threshold);
 123                         break;
 124
 125                 case SR_CONF_PROBE_FACTOR:
 126                         if (capabilities.count(Capability::LIST))
 127                                 bind_enum(name, "", key, capabilities, get, set, print_probe_factor);
 128                         else
 129                                 bind_int(name, "", "", pair<int64_t, int64_t>(1, 500), get, set);
 130                         break;
 131
 132                 case SR_CONF_AVG_SAMPLES:
 133                         bind_int(name, "", "", pair<int64_t, int64_t>(0, INT32_MAX), get, set);
 134                         break;
 135
 136                 default:
 137                         break;
 138                 }
 139         }
 140 }
 141
 142 void Device::bind_bool(const QString &name, const QString &desc,
 143         Property::Getter getter, Property::Setter setter)
 144 {
 145         assert(configurable_);
 146         properties_.push_back(shared_ptr<Property>(new Bool(
 147                 name, desc, getter, setter)));
 148 }
 149
 150 void Device::bind_enum(const QString &name, const QString &desc,
 151         const ConfigKey *key, set<const Capability *> capabilities,
 152         Property::Getter getter,
 153         Property::Setter setter, function<QString (Glib::VariantBase)> printer)
 154 {
 155         assert(configurable_);
 156
 157         if (!capabilities.count(Capability::LIST))
 158                 return;
 159
 160         try {
 161                 Glib::VariantContainerBase gvar = configurable_->config_list(key);
 162                 Glib::VariantIter iter(gvar);
 163
 164                 vector< pair<Glib::VariantBase, QString> > values;
 165                 while ((iter.next_value(gvar)))
 166                         values.emplace_back(gvar, printer(gvar));
 167
 168                 properties_.push_back(shared_ptr<Property>(new Enum(name, desc, values,
 169                         getter, setter)));
 170
 171         } catch (sigrok::Error& e) {
 172                 qDebug() << "Error: Listing device key" << name << "failed!";
 173                 return;
 174         }
 175 }
 176
 177 void Device::bind_int(const QString &name, const QString &desc, QString suffix,
 178         optional< pair<int64_t, int64_t> > range,
 179         Property::Getter getter, Property::Setter setter)
 180 {
 181         assert(configurable_);
 182
 183         properties_.push_back(shared_ptr<Property>(new Int(name, desc, suffix,
 184                 range, getter, setter)));
 185 }
 186
 187 QString Device::print_timebase(Glib::VariantBase gvar)
 188 {
 189         uint64_t p, q;
 190         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 191         return QString::fromUtf8(sr_period_string(p, q));
 192 }
 193
 194 QString Device::print_vdiv(Glib::VariantBase gvar)
 195 {
 196         uint64_t p, q;
 197         g_variant_get(gvar.gobj(), "(tt)", &p, &q);
 198         return QString::fromUtf8(sr_voltage_string(p, q));
 199 }
 200
 201 QString Device::print_voltage_threshold(Glib::VariantBase gvar)
 202 {
 203         gdouble lo, hi;
 204         g_variant_get(gvar.gobj(), "(dd)", &lo, &hi);
 205         return QString("L<%1V H>%2V").arg(lo, 0, 'f', 1).arg(hi, 0, 'f', 1);
 206 }
 207
 208 QString Device::print_probe_factor(Glib::VariantBase gvar)
 209 {
 210         uint64_t factor;
 211         factor = g_variant_get_uint64(gvar.gobj());
 212         return QString("%1x").arg(factor);
 213 }
 214
 215 }  // namespace binding
 216 }  // namespace pv