The "qview" Python package is a powerful Visualization and Monitoring facility, which allows embedded developers to create virtual Graphical User Interfaces in Python to monitor and control their embedded devices from a host (desktop) computer. The interfaces created by QView can visualize the data produced by QP/Spy software tracing system and can also interact with the embedded target by sending various commands.

General Requirements

The "qview" package requires Python 3 with the tkinter package, which is included in the QTools distribution for Windows and is typically included with other operating systems, such as Linux and MacOS.

To run "qview" in Python, you need to first launch the QSPY console application to communicate with the chosen embedded target (or the host executable if you are simulating your embedded target).

Once QSPY is running, from a separate terminal you can launch qview.py and "attach" to the QSPY UDP socket. After this communication has been established, "qview" can interact with the instrumented target and receive data from it (through QSPY).

NOTE The embedded C or C++ code running inside the target needs to be built with the QP/Spy software tracing system instrumentation enabled. This is achieved by building the "Spy" build configuration.

Installing qview

The qview monitoring must be installed in your Python distribution.

Installation from PyPi

The qview project is available on PyPi, so it can be installed with pip as follows:

pip install qview

Installation from QuantumLeaps GitHub

Alternatively, you can direct pip to install from Quantum Leaps GitHub:

pip install https://github.com/QuantumLeaps/qtools/releases/latest/download/qview.tar.gz

Installation from local package

Alternatively, you can direct pip to install from local package:

pip install /qp/qtools/qview/qview.tar.gz

Using qview

If you've installed qview with pip, you can either run it standalone:

qview [qspy_host[:udp_port]] [local_port]

Or (more commonly) import it into your script, where you customize QView. In that case, you invoke your script as usual:

pythonw my_qivew.py [qspy_host[:udp_port]] [local_port]

Command-line Options

• qspy_host[:udp_port] - optional host-name/IP-address:port for the host running the QSPY host utility. If not specified, the default is 'localhost:7701'.

• local_port - optional the local UDP port to be used by "qview". If not specified, the default is '0', which means that the operating system will choose an open port.

Examples:

pythonw %QTOOLS%\qview\qview.py

opens the generic (not customized) "qview".

pythonw dpp.py

opens "qview" with the customization provided in the dpp.py script located in the current directory.

pythonw dpp.py localhost:7701

opens "qview" (installed with pip) with the customization provided in the dpp.py script located in the directory ..\qview. The "qview" will attach to the QSPY utility running at localhost:7701.

pythonw dpp.py 192.168.1.100:7705

opens "qview" (installed with pip) with the customization provided in the dpp.py script located in the current directory. The "qview" will attach to the QSPY utility running remotely at IP address 192.168.1.100:7705.

More Information

More information about the QView Visualization and Monitoring is available online at:

• https://www.state-machine.com/qtools/qview.html

More information about the QP/QSPY software tracing system is available online at:

• https://www.state-machine.com/qtools/qpspy.html