8.2. ArduinoGUI Library

The ArduinoGUI module provides tools to create simple graphical user interfaces for Arduino programs using the PyQt4 library. It may optionally use the PyQwt library to render a dynamic plot window.

Contents

• ArduinoGUI Library
  • ArduinoConsole.py
  • ArduinoScope.py
  • ArduinoConsoleWindow.py

8.2.1. ArduinoConsole.py

ArduinoConsole.py

PyQt4 window implementing a generic control console for an Arduino sketch, including command line, plot window, and serial port controls. Functions are provide to allow extending the basic interface with custom buttons and sliders without needing to use Qt Designer.

Copyright (c) 2013-2015, Garth Zeglin. All rights reserved. Licensed under the terms of the BSD 3-clause license as included in LICENSE.

class ArduinoGUI.ArduinoConsole.ArduinoConsole(view=None)

A custom window which inherits both from the QMainWindow class and the custom Ui_ArduinoConsoleWindow defined using Qt Designer.

ArduinoConnectToggled(flag)

Callback invoked whenever the Arduino Connect checkbox changes state.

ArduinoPortEntered()

Callback invoked whenever text is entered into the Arduino Port field.

addButton(title, callback)

Add a button to the general-purpose button area of the interface. The title argument should be a short string to appear on the face of the button. The callback function is invoked whenever the button is pressed.

addScope()

Add an ArduinoScope widget to the top of the layout.

addScopeChannel(*args, **kwargs)

Add a named channel to the ArduinoScope plotting widget. The arguments are passed unchanged to add_channel().

addScopeSamples(name, y, t)

Add a set of new samples to a given named channel to the ArduinoScope plotting widget. The arguments are passed unchanged to add_samples().

addSlider(title, callback)

Add a horizontal slider to the controls area. The range is fixed over [0,1.0).

Parameters:

• title – string used as a tooltip
• callback – function receiving floating slider value

attachCommandCallback(callback)

Set the callback function to be invoked when the user enters a command.

Parameters:callback – callback( command_string )

attachConnectCallback(callback)

Set the callback function to be invoked when the user requests a connect or disconnect from the Arduino.

Parameters:callback – callback( port_name, flag ) flag is True for connect, False for disconnect

commandEntered()

Callback invoked whenever command line text is entered.

isShowingRawData()

Returns true if the Show Raw Data checkbox is selected.

newInputMonitor(fd, callback)

Convenience function to create a notification callback when input is available on a file descriptor.

Parameters:

• fd – integer file descriptor
• callback – one-argument function callback(fd) to be called with the file descriptor

Returns:

the underlying QSocketNotifier object

newPeriodicTimer(interval, callback)

Convenience function to create a periodic timer which calls a function at the given interval.

Parameters:

• interval – interval in milliseconds
• callback – no-argument function callback() to be called at intervals

Returns:

the underlying QTimer object

newSingleShotTimer(interval, callback)

Convenience function to set up a single-shot timer which calls a function once after the given interval.

Parameters:

• interval – interval in milliseconds
• callback – no-argument function callback() to be called once after a delay

replotScope()

Update the ArduinoScope plot area after all new data has been added.

resetPlotPressed()

Callback invoked whenever the Reset Plot button is clicked.

setArduinoPortName(name)

Set the initial state of the Arduino Port name field (e.g., from command-line arguments).

write(string)

Write output to the console text area.

8.2.2. ArduinoScope.py

ArduinoScope.py : Qt/Qwt widget to show a real-time oscilloscope-like display of signals

Copyright (c) 2015, Garth Zeglin. All rights reserved. Licensed under the terms of the BSD 3-clause license.

class ArduinoGUI.ArduinoScope.ArduinoScope(*args)

Plot widget to show real-time data like a multichannel oscilloscope. Implemented as a subclass of the QwtPlot widget provided in the Qwt5 package. Requires Qwt5 and PyQwt5.

add_channel(name, *args, **kwargs)

Add a new channel to the oscilloscope. The parameters are passed to ScopeChannel.init.

Parameters:

• name – short name with which to identify the channel internally
• title – optional title string to use on plot (default is to use the name value)
• color – optional color name string. Examples: ‘red’, ‘purple, ‘#80ff30’ (default is random)
• duration – optional limit on the length of the time history to store

add_samples(name, y, t)

Add one or more data samples to the buffer in the channel. If a maximum duration was specified during creation, the data buffer will be truncated to hold the specified maximum amount of history. After all channels have been updated, call the replot() method to update the display.

Parameters:

• name – channel name as supplied during creation
• y – list or ndarray of signal values
• t – list or ndarray of times, must be same length as y

reset_plot()

Clear all the sample buffers.

class ArduinoGUI.ArduinoScope.ScopeChannel(name, title=None, color=None, duration=None)

Internal class to represent the state of one channel in an ArduinoScope widget. See ArduinoScope.add_channel() for arguments.

add_samples(y, t)

Add one or more data samples to the buffer in the channel. If a maximum duration was specified during creation, the data buffer will be truncated to hold the specified maximum amount of history.

Parameters:

• y – list or ndarray of signal values
• t – list or ndarray of times, must be same length as y

clear_data()

8.2.3. ArduinoConsoleWindow.py

This file is generated from an XML interface description using the pyuic interface compiler. The XML description represents the basic interface layout, created and edited using Qt Designer and saved as the XML file ArduinoConsoleWindow.ui.

class ArduinoGUI.ArduinoConsoleWindow.Ui_ArduinoConsoleWindow

retranslateUi(ArduinoConsoleWindow)

setupUi(ArduinoConsoleWindow)