Repository files navigation

View QTools Revision History at:https://www.state-machine.com/qtools/history.html

The offline HTML documentation forthis particular version of QToolsis located in the folder html/. To view the offline documentation, openthe file html/index.html in your web browser.

The online HTML documention for thelatest version of QTools is locatedat:https://www.state-machine.com/qtools/

QTools is a collection of various open source tools for working with theQP Real-Time Embedded Frameworks (RTEFs) on desktop platforms, suchas Windows, Linux, and macOS.

The following open-source tools are currently provided (NOTE: toolsstarting with 'q' are contributed by Quantum Leaps)

1. qspy -host application for receiving and displaying the real-time data fromembedded targets running the QS software tracing.

2. qutest -Python extension of theqspy host application forunit and integration testing specifically designed for embedded systems,but also supports unit testing of embedded code on host computers("dual targeting").

3. qview -Python extension of theqspy host application for visualization andmonitoring of the QS real-time tracing data from embedded targets atreal-time. QView enables developers to quickly build both GUI-based and"headless" scripts for their specific applications.

4. qwin -QWIN GUI toolkit for prototyping embedded systems on Windows in theC programming language. QWIN enables developers to build realistic embeddedfront panels consisting of LCD displays (both graphical and segmented),buttons, and LEDs. QWIN is based on the Win32 API.

5. qcalc -programmer's calculator specifically designed for embedded systems programmers.

6. qclean -forfast cleanup of white space (tabs, trailing spaces, end-of-line)in source code files

7. qfsgen -for generating ROM-based file systems to be used in embedded web pagesserved by the HTTP server

8. Unity - traditional unit testing harness (framework) for embedded C(version 2.5.2)

Additionally, QTools for Windows contains the following open-source,3rd-party tools:

9. make for Windows (GNU-make-32-bit version 4.2.1)

10. cmake for Windows (version 3.29.0-rc1)

11. ninja for Windows (version 1.11.1)

12. Termite serial terminal for Windows (version 3.4)

13. LMFlash for Windows (32-bit build 1613)

Additionally, the QTools directory in the QP-bundle contains thefollowing 3rd-party tools:

14. GNU C/C++ toolset for Windows (MinGW 32-bit version 9.2.0)

15. GNU C/C++ toolset for ARM-EABI (GCC version 10.3-2021.10)

16. Python for Windows (version 3.10 32-bit)

The most recommended way of obtaining QTools is by downloading theQP-bundle, which includes QToolsand also allQP frameworks andtheQM modeling tool. The main advantageof obtaining QTools bundled together like that is that you get all components,tools and examples ready to go.

NOTE:QP-bundle is the mostrecommended way of downloading and installing QTools. However,if you are allergic to installers and GUIs or don't have administratorprivileges you can alsodownload and install QM separatelyas described below.

Alternatively, you can download QToolsseparately as described below:

On Windows, installation of QTools consists of unzipping theqtools-windows_<ver>.zip archive into a directory of your choice,although the recommended default isC:\qp.

After unzipping the archive, you need to add the following directoriesto the PATH (<qp> stands for the directory, where you installed qp):

• <qp>\qtools\bin
• <qp>\qtools\mingw32\bin

NOTE: To use theQUTest unit testing you need to define theenvironment variableQTOOLS to point to the installation directoryof QTools.

On Linux/MacOS, installation of QTools consists of unzipping theqtools-posix_<ver>.zip archive into a directory of your choice,although the recommended default is~/qp.

After unzipping the archive, you need to add the following directoriesto the PATH (<qp> stands for the directory, where you installed qp):

• <qp>/qtools/bin

NOTE: To use theQUTest unit testing you need to define theenvironment variableQTOOLS to point to the installation directoryof QTools.

The various Licenses for distributed components are located in theLICENSES/ sub-directory of this QTools distribution.

• Theqspy host utilityis distributed under the terms of QSPY LICENSE AGREEMENT, included in the fileLICENSE-qspy.txt in theLICENSES/ sub-directory.

• TheTermite host utility for Windowsis is distributed under the terms of the Termite license, included in the fileLICENSE-Termite.txt in theLICENSES/ sub-directory.

• TheLMFlash host utility for Windowsis is distributed under the terms of the LMFlash license, included in the fileLICENSE-LMFlash.txt in theLICENSES/ sub-directory. Specifically, the LMFlashutility is distributed according to Section 2a "Demonstration License".

• ThePython package for Windows is distributedunder the terms of the PYTHON LICENSE AGREEMENT, included in the fileLICENSE-Python.txt in theLICENSES/ sub-directory.

Most other tools included in this collection are distributed under theterms of the GNU General Public License (GPL) as published by the FreeSoftware Foundation, either version 2 of the License, or (at youroption) any later version. The text of GPL version 2 is included in thefile GPL-2.0-or-later.txt in theLICENSES/ sub-directory.

Some other the tools are distributed under the terms of the MIT opensource license. The complete text of the MIT license is included in thecomments and also in the file LICENSE-MIT.txt in theLICENSES/sub-directory.

In compliance with GPL, this distribution contains the source code forthe utilities contributed by Quantum Leaps in the<qtools>\sourcesubdirectory, except for the QSPY source code, which is provided in the<qtools>\qspy\source directory. All tools with names starting with 'q'have been developed and are copyrighted by Quantum Leaps.

Have been taken from the MSYS2 project at

• https://www.msys2.org/

The installer mingw-get-setup.exe has been used and after the installation,the files have been pruned to reduce the size of the distribution.Please refer to the MinGW project for the source code.

Have been taken from:

• https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads

The installer gcc-arm-none-eabi-8-2018-q4-major-win32-sha1.exe has been used.(Version 8-2018-q4-major Released: December 20, 2018)

Has been taken from the MinGW project at SourceForge.net:

Have been taken from the Gow (Gnu On Windows) project at GitHub:

• https://github.com/bmatzelle/gow

Has been taken from the GitHub at:

• https://github.com/ThrowTheSwitch/Unity

If you like this project, please give it a star (in the upper-right cornerof your browser window):

• https://www.state-machine.com
• info@state-machine.com