Repository files navigation

View QM Revision History at:https://www.state-machine.com/qm/history.html

The online HTML documentation for thelatest version of QM is locatedat:https://www.state-machine.com/qm/

The offline HTML documentation forthis particular version of QMis located in the folderhtml/. To view the offline documentation, openthe filehtml/index.html in your web browser.

QM (QP Modeler) is a freeware graphical modeling tool for designing andimplementing real-time embedded software based on the UML state machinesand the lightweightQP Real-Time Event Frameworks (RTEFs).QM is available for Windows (x64), Linux (x64), and macOS (ARM64).

NOTE: For more information, please refer to the online QM Manual at:https://www.state-machine.com/qm/

The most recommended way of obtaining QM is by downloading theQP-bundle, which includesQM and also allQP frameworksand theQTools collection.The main advantage of obtaining QM bundled together like that is that youget all components, tools and examples ready to go.

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

CAUTION: If you have any previous version of QM installed on your system,pleaseuninstall it before installing the new version.

Go to theQM releases anddownload the QM installer (qm_<ver>-windows.exe), which is digitally signedby Quantum Leaps. The installer will create a desktop shortcut for QM and willalso associate QM model files (*.qm and*.qmp)

Alternatively, if you are allergic to installers, you can download QM ziparchive for Windows (qm_<ver>-windows.zip). Installation consists ofunzipping the archive into any directory, although theC:\qp\ folder is therecommended default.

NOTE: It is generally not recommended to install QM in such standardlocations as "Program Files" or "Program Files (x86)" because thesedirectories have access limitations and don't allow you to modify theQM Style Sheets (qm_dark.qss andqm_light.qss) or the model templates.

If you installed QM via the installer program, the uninstaller will beprovided and you can uninstall QM via the standard "Apps and Features".

If you installed QM from the zip archive, you uninstall QM by simply deletingthe installation directory.

Go to theQM releases anddownload the QM zip archive for Linux (qm_<ver>-linux.zip). You canunzip the archive into any directory, although the~/qp/ folder is therecommended default.

After unzipping the archive, go to theqm/bin/ directory and make surethat theqm executable and theqm.sh shell script have executablepermissions. You can either do this with your desktop's file manageror at the command line, type:

chmod u+x qmchmod u+x qm.sh

NOTE: To run the QM application on Linux, you need to run theqm/bin/qm.sh script as well as theqm/bin/qm executable. Make surethat both files have executable permissions.

NOTE: Some Linux distributions (e.g., Ubuntu) might report problemswith missing Qt plugins. For example, if you launchqm/bin/qm.sh form aterminal, you might get the following output:

qt.qpa.plugin: Could not load the Qt platform plugin "wayland"...orqt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found...

One know solution to fix this issue is to install the following:

sudo apt install libxcb-cursor0

Go to theQM releases anddownload the disk image for macOS (qm_<ver>-macos.dmg). Because the.dmgfile is not coming from the Apple Store, after downloading you need to launcha console and change the attribute of this file:

xattr -c qm_<ver>-macos.dmg

Only after changing the file attribute, you can install QM on your macOS.Double click on.dmg file. This will mount and open the disk image.To install the QM tool, you simply drag the qm.app image into theApplications folder (typically visible in the Dock). If you wish, you mightalso create the alias of the qm.app and place it on your Desktop.

To uninstall QM, simply delete the qm.app file and the examples.

The QM example models are included in the QP baseline distributions. Theconsole-type examples are available for Windows (MinGW and Visual C++),Linux, and macOS.

Embedded examples are available for a number of boards, such as ARMCortex-M, ARM Cortex-R and MSP430 with the GNU, ARM/KEIL, and IAR compilers.

Additionally, a number of examples are provided for the host computers(Windows, Linux and macOS). These examples don't require any embeddedhardware to try.

All examples are located in the /examples/ directory, where denotes the folder where you have installed the specific version of theQP framework (QP/C or QP/C++).

The QM graphical modeling tool is freeware. It is free to download andfree use, but is not open source. During the installation you will needto accept a basic End-User License Agreement (seehttps://www.state-machine.com/qm/license.html ), which legally protectsQuantum Leaps from any warranty claims, prohibits removing any copyrightnotices from QM, selling it, and creating similar competitive products.The EULA also prohibits distributing QM from third-party websites. Theonly legitimate source of QM is the SourceForge.net/projects/qpc/ website.

NOTE: QM uses internally the Qt application toolkit under LGPLPlease refer to the LGPL Compliance Package for QM in the sub-directoryqt_lgpl or online athttps://www.state-machine.com/qm/qt_lgpl.html formore information how to obtain the source code for the Qt toolkit.

The code generated by QM is licensed under the same terms as theunderlying QP framework, for which the code has been generated. Pleaserefer to the QP licensing (https://www.state-machine.com/licensing/ )for more information.

NOTE: QM models without a valid QP license certificate (assumed to becovered by GPL) can only generateup to 20 states. The limitation hasbeen introduced to reduce the widespread GPL infringement with respect tothe QP/C and QP/C++ real-time embedded frameworks that underline the codegeneration in QM.

Support for QM is provided in the Free Support forum at:

• https://sourceforge.net/projects/qpc/forums/forum/668726

The QM software has many assertions inside, and the assertions areENABLED in the release version. When you hit an assertion, or any other error,please check the "Bug Tracker" available at:

• https://sourceforge.net/p/qpc/bugs/

If you don't find your problem, please try to reliably reproduce theproblem, and submit a concise report to the "Bug Tracker"

Thank you for your help in improving QM!

Also, if you find inconsistencies or any awkward features, please submita suggestion how to improve this functionality to the "Feature Tracker" at:

• https://sourceforge.net/p/qpc/feature-requests/

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