Fix #1549 by notifying user of wrong input parameter names
[pulseview.git] / pv / dialogs / connect.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012-2013 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 <cassert>
21
22 #include <libsigrokcxx/libsigrokcxx.hpp>
23
24 #include <QGroupBox>
25 #include <QLabel>
26 #include <QRadioButton>
27
28 #include "connect.hpp"
29
30 #include <pv/devicemanager.hpp>
31 #include <pv/devices/hardwaredevice.hpp>
32
33 using std::list;
34 using std::map;
35 using std::shared_ptr;
36 using std::string;
37
38 using Glib::ustring;
39 using Glib::Variant;
40 using Glib::VariantBase;
41
42 using sigrok::ConfigKey;
43 using sigrok::Driver;
44
45 using pv::devices::HardwareDevice;
46
47 namespace pv {
48 namespace dialogs {
49
50 Connect::Connect(QWidget *parent, pv::DeviceManager &device_manager) :
51         QDialog(parent),
52         device_manager_(device_manager),
53         layout_(this),
54         form_(this),
55         form_layout_(&form_),
56         drivers_(&form_),
57         serial_devices_(&form_),
58         scan_button_(tr("&Scan for devices using driver above"), this),
59         device_list_(this),
60         button_box_(QDialogButtonBox::Ok | QDialogButtonBox::Cancel,
61                 Qt::Horizontal, this)
62 {
63         setWindowTitle(tr("Connect to Device"));
64
65         connect(&button_box_, SIGNAL(accepted()), this, SLOT(accept()));
66         connect(&button_box_, SIGNAL(rejected()), this, SLOT(reject()));
67
68         populate_drivers();
69         connect(&drivers_, SIGNAL(activated(int)), this, SLOT(driver_selected(int)));
70
71         form_.setLayout(&form_layout_);
72
73         QVBoxLayout *vbox_drv = new QVBoxLayout;
74         vbox_drv->addWidget(&drivers_);
75         QGroupBox *groupbox_drv = new QGroupBox(tr("Step 1: Choose the driver"));
76         groupbox_drv->setLayout(vbox_drv);
77         form_layout_.addRow(groupbox_drv);
78
79         QRadioButton *radiobtn_usb = new QRadioButton(tr("&USB"), this);
80         QRadioButton *radiobtn_serial = new QRadioButton(tr("Serial &Port"), this);
81         QRadioButton *radiobtn_tcp = new QRadioButton(tr("&TCP/IP"), this);
82
83         radiobtn_usb->setChecked(true);
84
85         serial_config_ = new QWidget();
86         QHBoxLayout *serial_config_layout = new QHBoxLayout(serial_config_);
87
88         serial_devices_.setEditable(true);
89         serial_devices_.setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
90
91         serial_baudrate_.setEditable(true);
92         serial_baudrate_.addItem("");
93         serial_baudrate_.addItem("921600");
94         serial_baudrate_.addItem("115200");
95         serial_baudrate_.addItem("57600");
96         serial_baudrate_.addItem("19200");
97         serial_baudrate_.addItem("9600");
98
99         serial_config_layout->addWidget(&serial_devices_);
100         serial_config_layout->addWidget(&serial_baudrate_);
101         serial_config_layout->addWidget(new QLabel("baud"));
102         serial_config_->setEnabled(false);
103
104         tcp_config_ = new QWidget();
105         QHBoxLayout *tcp_config_layout = new QHBoxLayout(tcp_config_);
106         tcp_host_ = new QLineEdit;
107         tcp_host_->setText("192.168.1.100");
108         tcp_config_layout->addWidget(tcp_host_);
109         tcp_config_layout->addWidget(new QLabel(":"));
110         tcp_port_ = new QSpinBox;
111         tcp_port_->setRange(1, 65535);
112         tcp_port_->setValue(5555);
113         tcp_config_layout->addWidget(tcp_port_);
114
115         tcp_config_layout->addSpacing(30);
116         tcp_config_layout->addWidget(new QLabel(tr("Protocol:")));
117         tcp_protocol_ = new QComboBox();
118         tcp_protocol_->addItem("Raw TCP", QVariant("tcp-raw/%1/%2"));
119         tcp_protocol_->addItem("VXI", QVariant("vxi/%1/%2"));
120         tcp_config_layout->addWidget(tcp_protocol_);
121         tcp_config_layout->setContentsMargins(0, 0, 0, 0);
122         tcp_config_->setEnabled(false);
123
124         // Let the device list occupy only the minimum space needed
125         device_list_.setMaximumHeight(device_list_.minimumSizeHint().height());
126
127         QVBoxLayout *vbox_if = new QVBoxLayout;
128         vbox_if->addWidget(radiobtn_usb);
129         vbox_if->addWidget(radiobtn_serial);
130         vbox_if->addWidget(serial_config_);
131         vbox_if->addWidget(radiobtn_tcp);
132         vbox_if->addWidget(tcp_config_);
133
134         QGroupBox *groupbox_if = new QGroupBox(tr("Step 2: Choose the interface"));
135         groupbox_if->setLayout(vbox_if);
136         form_layout_.addRow(groupbox_if);
137
138         QVBoxLayout *vbox_scan = new QVBoxLayout;
139         vbox_scan->addWidget(&scan_button_);
140         QGroupBox *groupbox_scan = new QGroupBox(tr("Step 3: Scan for devices"));
141         groupbox_scan->setLayout(vbox_scan);
142         form_layout_.addRow(groupbox_scan);
143
144         QVBoxLayout *vbox_select = new QVBoxLayout;
145         vbox_select->addWidget(&device_list_);
146         QGroupBox *groupbox_select = new QGroupBox(tr("Step 4: Select the device"));
147         groupbox_select->setLayout(vbox_select);
148         form_layout_.addRow(groupbox_select);
149
150         unset_connection();
151
152         connect(radiobtn_serial, SIGNAL(toggled(bool)), this, SLOT(serial_toggled(bool)));
153         connect(radiobtn_tcp, SIGNAL(toggled(bool)), this, SLOT(tcp_toggled(bool)));
154         connect(&scan_button_, SIGNAL(pressed()), this, SLOT(scan_pressed()));
155
156         setLayout(&layout_);
157
158         layout_.addWidget(&form_);
159         layout_.addWidget(&button_box_);
160 }
161
162 shared_ptr<HardwareDevice> Connect::get_selected_device() const
163 {
164         const QListWidgetItem *const item = device_list_.currentItem();
165         if (!item)
166                 return shared_ptr<HardwareDevice>();
167
168         return item->data(Qt::UserRole).value<shared_ptr<HardwareDevice>>();
169 }
170
171 void Connect::populate_drivers()
172 {
173         for (auto& entry : device_manager_.context()->drivers()) {
174                 auto name = entry.first;
175                 auto driver = entry.second;
176                 /**
177                  * We currently only support devices that can deliver
178                  * samples at a fixed samplerate i.e. oscilloscopes and
179                  * logic analysers.
180                  * @todo Add support for non-monotonic devices i.e. DMMs
181                  * and sensors.
182                  */
183                 const auto keys = driver->config_keys();
184
185                 bool supported_device = keys.count(ConfigKey::LOGIC_ANALYZER) |
186                         keys.count(ConfigKey::OSCILLOSCOPE);
187
188                 if (supported_device)
189                         drivers_.addItem(QString("%1 (%2)").arg(
190                                 driver->long_name().c_str(), name.c_str()),
191                                 QVariant::fromValue(driver));
192         }
193 }
194
195 void Connect::populate_serials(shared_ptr<Driver> driver)
196 {
197         serial_devices_.clear();
198         for (auto& serial : device_manager_.context()->serials(driver))
199                 serial_devices_.addItem(QString("%1 (%2)").arg(
200                         serial.first.c_str(), serial.second.c_str()),
201                         QString::fromStdString(serial.first));
202 }
203
204 void Connect::unset_connection()
205 {
206         device_list_.clear();
207         button_box_.button(QDialogButtonBox::Ok)->setDisabled(true);
208 }
209
210 void Connect::serial_toggled(bool checked)
211 {
212         serial_devices_.setEnabled(checked);
213         serial_baudrate_.setEnabled(checked);
214         serial_config_->setEnabled(checked);
215 }
216
217 void Connect::tcp_toggled(bool checked)
218 {
219         tcp_config_->setEnabled(checked);
220 }
221
222 void Connect::scan_pressed()
223 {
224         device_list_.clear();
225
226         const int index = drivers_.currentIndex();
227         if (index == -1)
228                 return;
229
230         shared_ptr<Driver> driver =
231                 drivers_.itemData(index).value<shared_ptr<Driver>>();
232
233         assert(driver);
234
235         map<const ConfigKey *, VariantBase> drvopts;
236
237         if (serial_config_->isEnabled()) {
238                 QString serial;
239                 const int index = serial_devices_.currentIndex();
240                 if (index >= 0 && index < serial_devices_.count() &&
241                     serial_devices_.currentText() == serial_devices_.itemText(index))
242                         serial = serial_devices_.itemData(index).toString();
243                 else
244                         serial = serial_devices_.currentText();
245
246                 drvopts[ConfigKey::CONN] = Variant<ustring>::create(
247                         serial.toUtf8().constData());
248
249                 // Set baud rate if specified
250                 if (serial_baudrate_.currentText().length() > 0)
251                         drvopts[ConfigKey::SERIALCOMM] = Variant<ustring>::create(
252                                 QString("%1/8n1").arg(serial_baudrate_.currentText()).toUtf8().constData());
253         }
254
255         if (tcp_config_->isEnabled()) {
256                 QString host = tcp_host_->text();
257                 QString port = tcp_port_->text();
258                 if (!host.isEmpty()) {
259                         QString conn =
260                                 tcp_protocol_->itemData(tcp_protocol_->currentIndex()).toString();
261
262                         conn = conn.arg(host, port);
263
264                         drvopts[ConfigKey::CONN] = Variant<ustring>::create(
265                                 conn.toUtf8().constData());
266                 }
267         }
268
269         const list< shared_ptr<HardwareDevice> > devices =
270                 device_manager_.driver_scan(driver, drvopts);
271
272         for (const shared_ptr<HardwareDevice>& device : devices) {
273                 assert(device);
274
275                 QString text = QString::fromStdString(device->display_name(device_manager_));
276                 text += QString(" with %1 channels").arg(device->device()->channels().size());
277
278                 QListWidgetItem *const item = new QListWidgetItem(text, &device_list_);
279                 item->setData(Qt::UserRole, QVariant::fromValue(device));
280                 device_list_.addItem(item);
281         }
282
283         device_list_.setCurrentRow(0);
284         button_box_.button(QDialogButtonBox::Ok)->setDisabled(device_list_.count() == 0);
285 }
286
287 void Connect::driver_selected(int index)
288 {
289         shared_ptr<Driver> driver =
290                 drivers_.itemData(index).value<shared_ptr<Driver>>();
291
292         unset_connection();
293
294         populate_serials(driver);
295 }
296
297 } // namespace dialogs
298 } // namespace pv