Tutorial · Chapter 1

title: "Getting Started — from install to first run" chapter: 1 source: "Doc/QMachineStudio UserManaul.pdf" images:

  • install-overview.png
  • first-run.png
  • license-check.png

Getting Started

A step-by-step guide for first-time users. Install → first run → license check takes about 15 minutes.

QMachineStudio installer
ItemRecommended
OSWindows 10 or later (64-bit)
CPUIntel i5 or better
RAM8 GB or more
Storage2 GB free
Runtime.NET Framework 4.8 · (optional) USB license dongle

Install

  1. Run the installer (e.g. QMS_Setup_x.x.x.exe).
  2. Default install path is D:\QMS; change if needed.
  3. A shortcut QMachineStudio is placed on the desktop.
  4. First-time only: install the USB dongle driver from Tools → Install Drivers.

Windows permissions

  • The install folder requires write access — install as administrator.
  • Some antivirus tools block *.xms / *.xdf access — add the install folder to the exclusion list.

First run

First run
  1. Launch via the desktop shortcut or QMachineStudio.exe.
  2. If the recent-projects list is empty, use File → New to create a sample project.
  3. Editor · Solution Explorer · Output panes appear when the app is ready.

Exit via × or File → Exit. Unsaved changes prompt to save.

Open a sample project

The installer ships sample projects:

PathDescription
SampleProject/ChartDemoCharts · logs · file demo
SampleProject/Communication/TCP ServerClientTCP server / client
SampleProject/Fieldbus/ModbusTCP_ClientModbus/TCP
SampleProject/GUI/UISample1920x1080FHD UI sample

Open via File → Open Project and pick the .xproj file.

License check

Tools → Check License

Tools → Check License shows the current license state.

  • Valid — USB dongle present and authorized; a blue badge appears at the bottom.
  • No dongle — not plugged in or driver not installed; badge shown in gray.
  • Runtime only — development features disabled; execution allowed.

Contact sales@ict-lab.com for licensing questions.

Your first script

Create an empty project with File → New Project, paste this into the Run1 module, then Build → Build All.

FUNCTION OnSystemStart()
{
    Log("Hello, QMachineStudio!");
    TOWERLAMP.SetLamp("RUN");
    return true;
}
 
FUNCTION OnSystemStop()
{
    TOWERLAMP.SetLamp("STOP");
    return true;
}

Press Start → Hello, QMachineStudio! appears in the Output pane and the tower lamp switches to the RUN state.

Troubleshooting

SymptomCheck
Build error "Module not found"Is the module included in Solution Explorer?
Runtime error "License invalid"Reseat USB dongle / install driver
IO not updatingVerify board connectivity in Tools → IO Test
Output shows !!!--- logsInit sequence error — inspect Init.xms

Next steps