Tutorial · Chapter 1

Getting Started

A step-by-step guide for those new to QMachineStudio. From installation to first run, license verification, and understanding the development approach, this page covers what you should know before your actual first project.

ItemRecommended
OSMicrosoft Windows 10 or later (64-bit)
CPUIntel i5 or higher
RAM8 GB or more
Storage2 GB or more free space
Other.NET Framework 4.8 · (optional) USB license dongle

Installation

  1. Run the installer you received (e.g., QMS_Setup_x.x.x.exe).
  2. Follow the prompts to specify the installation path. When installation finishes, a QMachineStudio shortcut is created on the desktop.
  3. If you use a license, install the USB dongle driver once on first use.

The installation folder requires write permission, so installing with an administrator account is recommended. Real-time antivirus software may block access to project files (*.xmp · *.xms · *.xmd), so add the installation folder as an exception if needed.

First Run

  1. Run the desktop shortcut or QMachineStudio.exe.
  2. When the main window opens, the top menu and toolbar, the Solution Explorer on the left, the tabbed editing area in the center, and the result panel at the bottom are displayed. Each area is described in detail in the Main Window.
  3. At first there is no open project, so it is recommended to open the sample project below and review the screen layout.

To exit, use the X at the top right of the window or File → Exit. If there are unsaved changes, you will be asked whether to save.

Sample Projects Installed Alongside

Examples for various fields are provided in the SampleProject folder of the installation directory. From File → Open Project, you can open the .xmp file of the desired sample to run and analyze it.

CategoryPath (example)Content
Syntax overviewScriptSyntaxSampleA learning sample for running XScript syntax via buttons organized by category
Screen (GUI)GUI/UISample1920x1080 · GUI/DeviceUISampleFHD default UI · device UI control layout sample
CommunicationCommunication/TCP ServerClient · UDP_Sample · Mewtocol_Sample · ZeroMQ_Sample · CloudAWS_S3_SampleTCP/UDP · PLC protocol · message queue · cloud integration
FieldbusFieldbus/ModbusTCP_ClientModbus/TCP client
Motion · IOMotionIO/QMachineNetSample · MotionIO/AceAutoPMCMotion controller · IO board integration
DatabaseDatabase/DB_SqliteSQLite integration
Chart · FileChartDemo · FileSampleChart · log · file I/O demo
Lighting · VisionLightController/JoySystem_JPF · UsbCamera_SampleLighting controller · USB camera/vision
LibraryLibrarySample/FtpClient, etc.External library (FTP, etc.) integration

If this is your first time, it is recommended to first open ScriptSyntaxSample, where you can run syntax directly by category, and GUI/UISample1920x1080, which shows the screen layout.

License Verification

You can check the current license status from the Tools → Check License menu.

License Dialog — Tools → Check License
License Dialog — Tools → Check License
  • Recognized normally — The USB dongle is connected and authenticated, displaying the version, license type (e.g., Developer), serial, motor count, and more.
  • No dongle — The dongle is not connected, or the driver is not installed.
  • Runtime mode — Development features are disabled and only execution is possible.

For inquiries about license types and scope, contact sales@ict-lab.com.

The QMachineStudio Development Approach — Add and Edit in the Tree

QMachineStudio does not work by directly editing a single source file as text, the way C / C++ / C# do. In the Solution Explorer tree on the left, you add and remove modules, functions, sequences, and steps as individual items, and edit only the code of the selected item in a separate tab. Understanding this approach makes subsequent work much easier.

  • Modules: Divided into Run modules, which hold the operation logic, and View modules, which hold the screen (HMI).
  • Structure of a Run module: When you expand a module, it consists of Variable (module variables), Functions (individual functions), and Sequence (the individual Step items within a sequence).
  • Adding a function: Right-click FunctionsAdd Function → enter a name, and a function node is added with that function's editing tab opening automatically.
  • Adding a step: Right-click SequenceAdd Step to add a sequence step.
  • Rename · Move · Delete: Right-clicking each function/step node lets you use Rename · Move Up/Down · Delete.
  • View modules: Place controls such as buttons on the screen, and connect the controls' events (e.g., clicks) to functions.

In other words, rather than "directly typing many functions into one long script file," you add the functions/steps you need in the tree and then write only the code for that node. You will learn the actual flow step by step by creating a single button in the first project.

Troubleshooting

SymptomCheck
Build error "Module not found"Whether the module is included in the Solution Explorer
Runtime error "License invalid"Reinsert the USB dongle · install the driver
IO is not updatedCheck the board connection in System → Io Test
Where do I view logs?Check system logs with the Log Manager

Next Steps