4 ## This file is part of the sigrok-meter project.
6 ## Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
7 ## Copyright (C) 2014 Jens Steinhauser <jens.steinhauser@gmail.com>
9 ## This program is free software; you can redistribute it and/or modify
10 ## it under the terms of the GNU General Public License as published by
11 ## the Free Software Foundation; either version 2 of the License, or
12 ## (at your option) any later version.
14 ## This program is distributed in the hope that it will be useful,
15 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ## GNU General Public License for more details.
19 ## You should have received a copy of the GNU General Public License
20 ## along with this program; if not, write to the Free Software
21 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 import sigrok.core as sr
32 default_drivers = [('demo', {'analog_channels': 1})]
33 default_loglevel = sr.LogLevel.WARN
36 parser = argparse.ArgumentParser(
37 description='Simple sigrok GUI for multimeters and dataloggers.',
38 epilog=textwrap.dedent('''\
39 The DRIVER string is the same as for sigrok-cli(1).
43 %(prog)s --driver tecpel-dmm-8061-ser:conn=/dev/ttyUSB0
45 %(prog)s --driver uni-t-ut61e:conn=1a86.e008
47 formatter_class=argparse.RawDescriptionHelpFormatter)
49 parser.add_argument('-d', '--driver',
51 help='The driver to use')
52 parser.add_argument('-l', '--loglevel',
54 help='Set loglevel (5 is most verbose)')
55 parser.add_argument('--pyside',
58 help='Force use of PySide (default is to use PyQt4)')
59 args = parser.parse_args()
62 'drivers': default_drivers,
63 'loglevel': default_loglevel,
68 result['drivers'] = []
70 m = re.match('(?P<name>[^:]+)(?P<opts>(:[^:=]+=[^:=]+)*)', d)
72 sys.exit('error parsing option "{}"'.format(d))
74 opts = m.group('opts').split(':')[1:]
75 opts = [tuple(kv.split('=')) for kv in opts]
78 result['drivers'].append((m.group('name'), opts))
80 if args.loglevel != None:
82 result['loglevel'] = sr.LogLevel.get(args.loglevel)
84 sys.exit('error: invalid log level')
88 if __name__ == '__main__':
89 # The command line parsing and import of the Qt modules is done here,
90 # so that the modules are imported before the classes below derive
91 # from classes therein. The rest of the main function is at the bottom.
98 from PySide import QtCore, QtGui
99 qt_signal = QtCore.Signal
102 from PyQt4 import QtCore, QtGui
103 qt_signal = QtCore.pyqtSignal
105 sys.stderr.write('import of PyQt4 failed, using PySide\n')
106 from PySide import QtCore, QtGui
107 qt_signal = QtCore.Signal
109 class SamplingThread(QtCore.QObject):
110 '''A class that handles the reception of sigrok packets in the background.'''
112 class Worker(QtCore.QObject):
113 '''Helper class that does the actual work in another thread.'''
115 '''Signal emitted when new data arrived.'''
116 measured = qt_signal(object)
118 '''Signal emmited in case of an error.'''
119 error = qt_signal(str)
121 def __init__(self, drivers, loglevel):
122 super(self.__class__, self).__init__()
124 self.sampling = False
125 self.drivers = drivers
127 self.context = sr.Context_create()
128 self.context.log_level = loglevel
130 self.sr_pkg_version = self.context.package_version
131 self.sr_lib_version = self.context.lib_version
133 def start_sampling(self):
135 for name, options in self.drivers:
137 dr = self.context.drivers[name]
138 devices.append(dr.scan(**options)[0])
141 'Unable to get device for driver "{}".'.format(name))
144 self.session = self.context.create_session()
146 self.session.add_device(dev)
148 self.session.add_datafeed_callback(self.callback)
153 # If sampling is 'True' here, it means that 'stop_sampling()' was
154 # not called, therefore 'session.run()' ended too early, indicating
157 self.error.emit('An error occured during the acquisition.')
159 def stop_sampling(self):
161 self.sampling = False
164 def callback(self, device, packet):
165 if packet.type == sr.PacketType.ANALOG:
166 dev = '{} {}'.format(device.vendor, device.model)
168 # only send the most recent value
169 mag = packet.payload.data[0][-1]
171 self.measured.emit((dev, mag, packet.payload.unit,
172 packet.payload.mq_flags))
174 # wait a short time so that in any case we don't flood the GUI
175 # with new data (for example if the demo device is used)
176 self.thread().msleep(100)
178 # signal used to start the worker across threads
179 _start_signal = qt_signal()
181 def __init__(self, drivers, loglevel):
182 super(self.__class__, self).__init__()
184 self.worker = self.Worker(drivers, loglevel)
185 self.thread = QtCore.QThread()
186 self.worker.moveToThread(self.thread)
188 self._start_signal.connect(self.worker.start_sampling)
190 # expose the signals of the worker
191 self.measured = self.worker.measured
192 self.error = self.worker.error
197 '''Starts sampling'''
198 self._start_signal.emit()
201 '''Stops sampling and the background thread.'''
202 self.worker.stop_sampling()
204 # the timeout is needed when the demo device is used, because it
205 # produces so much outstanding data that quitting takes a long time
206 self.thread.wait(500)
208 def sr_pkg_version(self):
209 '''Returns the version number of the libsigrok package.'''
210 return self.worker.sr_pkg_version
212 def sr_lib_version(self):
213 '''Returns the version number fo the libsigrok library.'''
214 return self.worker.sr_lib_version
216 class SigrokMeter(QtGui.QMainWindow):
217 '''The main window of the application.'''
219 def __init__(self, thread):
220 super(SigrokMeter, self).__init__()
223 self.inf = float('inf')
226 self.thread.measured.connect(self.update, QtCore.Qt.QueuedConnection)
227 self.thread.error.connect(self.error)
231 self.setWindowTitle('sigrok-meter')
232 self.setMinimumHeight(130)
233 self.setMinimumWidth(260)
235 p = os.path.abspath(os.path.dirname(__file__))
236 p = os.path.join(p, 'sigrok-logo-notext.png')
237 self.setWindowIcon(QtGui.QIcon(p))
239 actionQuit = QtGui.QAction(self)
240 actionQuit.setText('&Quit')
241 actionQuit.setIcon(QtGui.QIcon.fromTheme('application-exit'))
242 actionQuit.setShortcut('Ctrl+Q')
243 actionQuit.triggered.connect(self.close)
245 actionAbout = QtGui.QAction(self)
246 actionAbout.setText('&About')
247 actionAbout.setIcon(QtGui.QIcon.fromTheme('help-about'))
248 actionAbout.triggered.connect(self.show_about)
250 menubar = self.menuBar()
251 menuFile = menubar.addMenu('&File')
252 menuFile.addAction(actionQuit)
253 menuHelp = menubar.addMenu('&Help')
254 menuHelp.addAction(actionAbout)
256 self.lblValue = QtGui.QLabel('waiting for data...')
257 self.lblValue.setAlignment(QtCore.Qt.AlignCenter)
258 font = self.lblValue.font()
259 font.setPointSize(font.pointSize() * 1.7)
261 self.lblValue.setFont(font)
262 self.setCentralWidget(self.lblValue)
263 self.centralWidget().setContentsMargins(0, 0, 0, 0)
265 self.lblDevName = QtGui.QLabel()
266 self.lblDevName.setToolTip('Name of used measurement device.')
267 self.statusBar().insertWidget(0, self.lblDevName, 10)
268 self.lblTime = QtGui.QLabel()
269 self.lblTime.setToolTip('Time of the last measurement.')
270 self.statusBar().insertWidget(1, self.lblTime)
272 self.statusBar().setSizeGripEnabled(False)
274 def show_about(self):
275 text = textwrap.dedent('''\
277 <b>sigrok-meter</b><br/>
279 Using libsigrok {} (lib version {}).<br/>
280 <a href='http://www.sigrok.org'>
281 http://www.sigrok.org</a><br/>
283 This program comes with ABSOLUTELY NO WARRANTY;<br/>
285 <a href='http://www.gnu.org/licenses/gpl.html'>
286 http://www.gnu.org/licenses/gpl.html</a>
288 '''.format(self.thread.sr_pkg_version(), self.thread.sr_lib_version()))
290 QtGui.QMessageBox.about(self, 'About sigrok-meter', text)
292 def format_unit(self, u):
296 sr.Unit.OHM: u'\u03A9',
299 sr.Unit.CELSIUS: u'\u00B0C',
300 sr.Unit.FAHRENHEIT: u'\u00B0F',
302 sr.Unit.PERCENTAGE: '%',
305 sr.Unit.SIEMENS: 'S',
306 sr.Unit.DECIBEL_MW: 'dBu',
307 sr.Unit.DECIBEL_VOLT: 'dBV',
309 sr.Unit.DECIBEL_SPL: 'dB',
310 # sr.Unit.CONCENTRATION
311 sr.Unit.REVOLUTIONS_PER_MINUTE: 'rpm',
312 sr.Unit.VOLT_AMPERE: 'VA',
314 sr.Unit.WATT_HOUR: 'Wh',
315 sr.Unit.METER_SECOND: 'm/s',
316 sr.Unit.HECTOPASCAL: 'hPa',
317 sr.Unit.HUMIDITY_293K: '%rF',
318 sr.Unit.DEGREE: u'\u00B0',
322 return units.get(u, '')
324 def format_mqflags(self, mqflags):
325 if sr.QuantityFlag.AC in mqflags:
327 elif sr.QuantityFlag.DC in mqflags:
334 def format_mag(self, mag):
337 return '{:f}'.format(mag)
339 def update(self, data):
340 '''Updates the labels with new measurement values.'''
342 device, mag, unit, mqflags = data
344 unit_str = self.format_unit(unit)
345 mqflags_str = self.format_mqflags(mqflags)
346 mag_str = self.format_mag(mag)
347 value = ' '.join([mag_str, unit_str, mqflags_str])
349 n = datetime.datetime.now().time()
350 now = '{:02}:{:02}:{:02}.{:03}'.format(
351 n.hour, n.minute, n.second, n.microsecond / 1000)
353 self.lblValue.setText(value)
354 self.lblDevName.setText(device)
355 self.lblTime.setText(now)
357 def error(self, msg):
358 '''Error handler for the sampling thread.'''
359 QtGui.QMessageBox.critical(self, 'Error', msg)
362 if __name__ == '__main__':
363 thread = SamplingThread(args['drivers'], args['loglevel'])
365 app = QtGui.QApplication([])
366 s = SigrokMeter(thread)