Skip to content

Operator Guide

The Operator Guide module allows you to create visual step-by-step instructions for machine operators. These guides are linked to a specific machine and controlled by a read-only integer node (e.g., a PLC tag representing the current step number).

Operator guide

How it works

  1. Configuration: An administrator creates a "Guide" in the admin panel and links it to a Machine and a Node.
  2. Images: The administrator uploads images for each step (index 1, 2, 3, etc.).
  3. Display: The operator accesses a specific URL (e.g., /guide/<guide_id>/).
  4. Automation: The page automatically updates the displayed image whenever the value of the linked Node changes.

Setup

Prerequisites

  • You need a Machine and a Node of type Integer with Read-Only access level.

Creating a Guide

  1. Go to the Admin Panel -> Core -> Machines.
  2. Select the machine you want to add a guide to.
  3. Scroll down to the Guides section (inline).
  4. Click Add another Guide.
  5. Name: Enter a name for the guide.
  6. Node: Select the controlling node. This node will determine which image is shown.
    • Note: The node must be Integer and Read-Only.
  7. Click Save and continue editing to add images.

Adding Images

  1. In the Guide edit page (or inline in Machine), look for Images.
  2. Click Add another Guide Image.
  3. Image: Upload the image file (JPG, PNG, GIF).
  4. Index: Enter the step number corresponding to this image (e.g., 1 for step 1).
  5. Repeat for all steps.
  6. Click Save.

Usage

The guide is accessible at: http://<your-server>/guide/<guide-uuid>/

You can find the UUID in the URL when editing the Guide in the admin panel, or you can copy the link if provided in your dashboard.

  • Default State: If the node has no value or the value is 0/invalid, the image with Index 1 is shown by default.
  • Step Change: When the machine updates the node value (e.g., from 1 to 2), the image on the page will automatically update to the image with Index 2.
  • Missing Image: If the machine sends a step number for which no image is defined, an error message will be displayed.