UAVCAN GUI Tool (legacy)

UAVCAN GUI Tool is a cross-platform (Windows/Linux/OSX) application for UAVCAN/CAN v0 management and diagnostics.

This is a legacy application; it is not compatible with the stable UAVCAN v1. There is work underway on the new GUI solution called Yukon that will support UAVCAN v1. While Yukon is unavailable, users of UAVCAN v1 are recommended to use the Yakut command line tool.

Read the docs at legacy.uavcan.org/GUI_Tool.

Ask questions at forum.uavcan.org.

Read installation instructions:

• GNU/LINUX
• WINDOWS
• MACOS

Installing on GNU/Linux

The general approach is simple:

1. Install PyQt5 for Python 3 using your OS' package manager (e.g. APT).
2. Install the application itself from Git via PIP: pip3 install git+https://github.com/UAVCAN/gui_tool@master (it is not necessary to clone this repository manually). Alternatively, if you're a developer and you want to install your local copy, use pip3 install ..

It also may be necessary to install additional dependencies, depending on your distribution (see details below).

Once the application is installed, you should see new desktop entries available in your desktop menu; also a new executable uavcan_gui_tool will be available in your PATH. If your desktop environment doesn't update the menu automatically, you may want to do it manually, e.g. by invoking sudo update-desktop-database (command depends on the distribution).

It is also recommended to install Matplotlib - it is not used by the application itself, but it may come in handy when using the embedded IPython console.

Debian-based distributions

sudo apt-get install -y python3-pip python3-setuptools python3-wheel
sudo apt-get install -y python3-numpy python3-pyqt5 python3-pyqt5.qtsvg git-core
sudo pip3 install git+https://github.com/UAVCAN/gui_tool@master

Troubleshooting

If installation fails with an error like below, try to install IPython directly with sudo pip3 install ipython:

error: Setup script exited with error in ipython setup command: Invalid environment marker: sys_platform == "darwin" and platform_python_implementation == "CPython"

If you're still unable to install the package, please open a ticket.

RPM-based distributions

Maintainers wanted

Fedora 29+

sudo dnf install python3-PyQt5
sudo pip3 install git+https://github.com/UAVCAN/gui_tool@master

Installing on Windows

In order to install this application, download and install the latest .msi package from here: https://files.zubax.com/products/org.uavcan.gui_tool/.

Building the MSI package

These instructions are for developers only. End users should use pre-built MSI packages (see the link above).

First, install dependencies:

• WinPython32-3.7.7.1dot pre-packaged with PyQt5 from WinPython or SourceForge. After installing, make sure you can run python --version from the terminal; if you can't, check your PATH environment variable.
• Microsoft Visual C++ 2015 Redistributable or later.

Note: WinPython64 will produce a large 64-bit executable; do not use this.

Note: WinPython 3.8+ is not compatible with pyqtgraph-0.9.0 used in this app. It requires pyqtgraph-0.11.0 or higher.

Having done that, execute the following (the script will prompt you for password to read the certificate file):

python -m pip uninstall -y uavcan
python -m pip uninstall -y uavcan_gui_tool
python setup.py install
python setup.py bdist_msi

Note: With a new WinPython installation, dependent packages get installed as egg files rather than wheels. As a result, the bdist_msi fails. To resolve this, uninstall and reinstall the failed package using pip, and then rerun the commands above. Repeat until all dependent packages are fully installed in your site-packages python tree.

Note: If bdist_msi cx_freeze fails with error code 4 or 6, check available disk space.

Collect the resulting signed MSI from dist/.

Installing on macOS

OSX support is a bit lacking in the way that installation doesn't create an entry in the applications menu, but this issue should be fixed someday in the future. Other than that, everything appears to function more or less correctly. If you have a choice, it is recommended to use Linux or Windows instead, as these ports are supported much better at the moment.

Homebrew option

• Install the Homebrew package manager for OSX.
• Run the following commands:

brew install python3
brew postinstall python3
pip3 install PyQt5
pip3 install git+https://github.com/UAVCAN/gui_tool@master
uavcan_gui_tool

MacPorts option

Install XCode from App Store, install MacPorts from https://www.macports.org/install.php, then run the commands below. If you're prompted to install Command Line Developer Tools, agree.

sudo port selfupdate
sudo port install curl-ca-bundle py35-pip py35-pyqt5 py35-numpy
sudo python3.5 -m pip install git+https://github.com/UAVCAN/gui_tool@master

We would like to provide prebuilt application packages instead of the mess above. Contributions adding this capability would be welcome.

Development

Releasing new version

First, deploy the new version to PyPI. In order to do that, perform the following steps:

1. Update the version tuple in version.py, e.g. 1, 0, and commit this change.
2. Create a new tag with the same version number as in the version file, e.g. git tag -a 1.0 -m v1.0.
3. Push to master: git push && git push --tags

Then, build a Windows MSI package using the instructions above, and upload the resulting MSI to the distribution server.

Code style

Please follow the Zubax Python Coding Conventions.