Installation of QuickHMI Runtime on Linux systems

A ready-to-use image(8GB) is available for download for use on a Raspberry Pi. This image is fully configured with QuickHMI Runtime and access options via SSH and VNC.

You can find the download for the image in our download-section. Please download the image and write it to a mini SD card of at least 8 GB. After inserting the card into the slot of the Raspberry Pi, supply it with power and connect a LAN cable for the initial setup.

The image is configured so that the Raspberry Pi receives its IP address via a DHCP request. You can determine the IP address using the “Advanced IP Scanner” network tool or connect a monitor.

The image is delivered with the following standard access data for the user “pi”:

User: pi
Password: raspberry

Security risk: Please change the password when setting up for the first time!

The QuickHMI server is installed on a Linux distribution via the terminal. Please note the system requirements for Linux!

Open a terminal or connect to your Linux system via SSH access.

The commands to be executed may differ from distribution to distribution. The commands in these instructions are based on Linux Ubuntu.

Installing a different major version

A different major version of QuickHMI can be installed if all occurrences of “Lynx” in the following script excerpts are replaced by the corresponding other version.

For a manual update within the same main version, simply carry out the steps marked with [U]. This assumes that the other steps have already been carried out in the past or that you are using the Raspberry image provided by us.

1. install an openJDK runtime environment. Runtime environments from version 11 are supported. If there is no current package source for version 11 of openjdk in the Linux distribution used, you can use version 17 .
sudo apt-get install openjdk-11-jre
2. if you want to use the graphical RuntimeManager, install openjfx. Otherwise you can skip this step.
sudo apt-get install openjfx
3. create a new user quickhmi with the password indi . This user is used to start the QuickHMI server.
username="quickhmi"
password="indi"
pass=$(perl -e 'print crypt($ARGV[0], "password")' $password)
sudo useradd -m -p $pass $username
4. [U]* Change to the “/home/quickhmi” folder.
cd /home/quickhmi
5 [U]* Download the QuickHMI Server package. Instead of using the wget command, you can use the file on another computer beforehand and then copy it to the current directory (/home/quickhmi).
sudo wget https://www.quickhmi.de/linux/lynx/QuickHMIServer.tar
6. [U]* Unzip the QuickHMI Server package to /home/quickhmi.
sudo tar -xvf QuickHMIServer.tar

You should now find the following folder structure: /home/quickhmi/QuickHMIServer Lynx
7. [U]* Delete the QuickHMI Server package.
sudo rm QuickHMIServer.tar
8. set the user quickhmi as the owner of the QuickHMIServer folder.
sudo chown quickhmi "QuickHMIServer Lynx"
9. create a symbolic link to the file /home/quickhmi/QuickHMIServer/qhmiRM.sh to /usr/bin/qhmiRM .
sudo ln -sf "/home/quickhmi/QuickHMIServer Lynx/qhmiRM.sh" /usr/bin/qhmiRM
10. [U]* Copy the folder /home/quickhmi/QuickHMIServer Lynx/usr/ to /usr/. The cp -a command copies the folder with all its contents.

The / after the source directory is important for this command!

sudo cp -a "QuickHMIServer Lynx/usr/." /usr/
11. [U]* You can now delete the /home/quickhmi/QuickHMIServer Lynx/usr folder. It is no longer needed here.
sudo rm -rf "QuickHMIServer Lynx/usr"
12. [U]* Copy the folder /home/quickhmi/QuickHMIServer Lynx/etc/ to /etc/. Use the command cp -a to copy the folder with all its contents.

The / after the source directory is important for this command!
sudo cp -a "QuickHMIServer Lynx/etc/." /etc/
13. [U]* You can now delete the /home/quickhmi/QuickHMIServer Lynx/etc folder. It is no longer required here.
sudo rm -rf "QuickHMIServer Lynx/etc"
* If an older version of the server is already installed, it is sufficient to carry out the steps marked with [U] for an update.

This completes the installation.

Now switch to the folder for QHMI:

cd /home/quickhmi/QuickHMIServer Lynx

You will also receive a list of all possible commands:

sudo qhmiRM

The possible commands are listed below:

CommandText
-rQuickHMI console runtime manager is started
-rgQuickHMI runtime manager GUI is started
-rdstarts the QuickHMI Server
-sdstops the QuickHMI Server
-iDirect import of a QuickHMI export file into the server. Can be used together with the -instance (instance_ID) argument
-vshows the currently installed version
-u Starts the update process
-startStarts an instance manually. Must be used together with the argument for the instance (-instance instance_ID)
-stopStops an instance. Must be used together with the argument for the instance (-instance instance_ID)

The description of the graphical runtime manager can be found here https://docs.quickhmi.com/wp-admin/post.php?post=2554&action=edit&lang=en

In the first step, a project should be imported via the export file.

sudo qhmiRM -i Testproject1.qexp

After selecting a running instance or creating a new instance, the project is imported.

The runtime can then be started with :

sudo qhmiRM -rd