Introduction
This documentation describes how to install and use ctrlX G-Code UI. G-Code UI was developed with Node-RED and PLC Engineering. It consists of a PLC project package and Node-RED template which can be customized.
G-Code UI functionality
G-Code UI supports the following features:
- Editor to create / write / delete a NC program.
- NC program selection.
- Start, stop, reset, and pause the NC program kinematics, respectively.
- Control path velocity by feed rate override.
- Different coordinate systems like ACS and PCS.
- Observe position and state of kinematics.
- System diagnostics.
Installation and activation of G-Code UI
A licensed installation of following apps (V2.4.x or above) is expected before activating G-Code UI.
Mandatory:
- ctrlX CORE - MOTION App (2.4.2 or above)
- ctrlX CORE - Motion Standard License 4 Axes
- ctrlX CORE - Motion Cartesian License (add-on)
- ctrlX AUTOMATION - G-Code Runtime App (2.4.0 or above)
- ctrlX OS License - G-Code Runtime
- ctrlX AUTOMATION - Node-RED App （2.4.0 or above）
- ctrlX OS License - Node-RED
- ctrlX OS License - Node-RED
- ctrlX AUTOMATION - PLC App (2.4.0 or above)
- ctrlX CORE License - PLC Standard (add-on)
- ctrlX AUTOMATION - G-Code UI (2.4.0)
- ctrlX AUTOMATION - G-Code UI (2.6.0.3)
- ctrlX AUTOMATION - G-Code UI (3.2.0)
Note: Please install G-Code Runtime App after MOTION App!
Optional:
- ctrlX AUTOMATION - 3D Viewer App
- ctrlX OS License - 3D Viewer
- ctrlX AUTOMATION - Oscilloscope App
The G-Code UI template includes two parts:
- PLC package: Bosch Rexroth AG GCode ****.package
- Node-RED template flows: GCode_UI_****.json (or GCode_UI_*.*.*.*.zip)
Both should be installed to activate and operate the UI.
PLC Part
Install the G-Code template package to the ctrlX PLC Engineering, only need to install for the first time:
Create a new PLC project and insert PLC templates. Both the G-Code template and Motion Interface template need to be inserted:
Select and insert G-Code template
Select and insert Motion Interface template
Application of PLC runtime in ctrlX WORKS is in state of RUN
PLC interface variables in the DataLayer nodeNode-RED part
There are two methods to load and active Node-RED configuration:
- Load GCode_UI_****.zip from the "Manage app data".
- Or import GCode_UI_****. json in Node-RED flow editor.
Note:
GCode_UI_****. json: It only contains the configuration of Node-RED, the user needs to add axes and create at least one kinematics before implementation.
- Switch ctrlX CORE state to "Setup" mode, uploads GCode_UI_****.zip file via "Home → Manage app data → Archive/Uploads Configuration".
- Active the configuration and switch the ctrlX CORE state to "Operating" mode.
Activate the configuration of Node-RED by loading the GCode_UI_****.zip file
Activate the configuration of Node-RED by import the GCode_UI_****. json file
“Data Layer Request” node
“Data Layer Subscribe" nodeHow to log in “Data Layer Request” node:
- Double-click any “Data Layer Request” node to open the configuration window.
- Enter the user name and password to log in, as shown in the figure below.
- Deploy the flows.
How to log in Data Layer request node
Description of G-Code UI
The page HMI-Operating includes five areas: kinematics select, program, machine status, operation and diagnosis.
HMI-Operating of G-Code UI
kinematics select area:
Before using this UI, at least one kinematics should be created, then the created kinematics can be read and selected.
For 2.6.0 and below, before active operating mode, need refresh and select the kinematics in the configuration mode page, show as below picture.
HMI-Configuration of G-Code UI (2.6.0 and below)
Programming area:
There are two pages in the program area. The default page "NC_Program" displays the operable fields for of the program, which are described in the table 1. The "Active_NC_Blocks" page displays the activated NC block. The page is switched from "NC_Program" to "Active_NC_Blocks" automatically when the NC program is running.
| Name | Description | |
| 1 | Path | Show the file path of program. |
| 2 | PARENT DIR | Return to the parent directory. |
| 3 | REFRESH | Refresh the program list. |
| 4 | CREATE FILE |
Create program. For 2.6.0 and below, need input the file name of new program via "Filename to be created", and then click "CREATE" to complete the creation of the program. |
| 5 | DELETE FILE | Delete program. |
| 6 | CREATE DIR |
Create customer directors in path "Manage app data/Active/scripts". |
| 7 | ACTIVE BLOCKS | Switch page to "Active_NC_Blocks" manually via "ACTIVE BLOCKS". Only when NC program is running, the "ACTIVE_NC_ BLOCKS" page can display the executing NC blocks. Switch from "Active_NC_Blocks" page to "NC_Program" page via "PROGRAM" button. |
| 8 | SAVE | Save the NC program. |
Machine status area:
- Display axis status, position, and velocity information. Maximal seven axes status can be displayed.
- Slider of override to modify the percentage of command value F.
- Observe the active command options.
- Show kinematics activated name and state.
- Displays pre-selected and loaded programs.
Operating area:
This area provides operation buttons to control the system.| Name | Description | |
| 1 | KIN ON | Axes power on and group enable. |
| 2 | KIN OFF | Axes power off and group disable. |
| 3 | PROG LOAD | Load the pre-selected program, switch UI state from "DISABLED" to "READY". |
| 4 | START |
|
| 5 | STOP | Stop NC program, switch UI state from "RUNNING" /"PAUSE" to "READY". |
| 6 | PAUSE | Pause NC program, switch UI state from "RUNNING" to "PAUSE". |
| 7 | RESET | Reset errors, switch UI state from "ERROR" to "DISABLED". |
| 8 | PCS | Show kinematics position in product coordinate system. |
Diagnosis display:
When an error occurs, the user can get the following information from the UI:
- Main diagnosis: Main number of the diagnostic information.
- Detail diagnosis: Detailed number of the diagnostic information.
- Error Information: Description of error.
- Error source: Traced source of the error
The diagnosis includes motion error, G-Code error, PLC error and error from others. If the error cannot reset from UI, users can clear pending alarm as below picture.
Clear pending alarms
All errors also can be traced in Diagnostics/Logbook, and in addition, the errors from G-Code and motion can also be traced in data layer node.
G-Code error: script/instances/<"kinematics name">/diag
The DataLayer node for G-Code error
Motion error: motion/kin/Kinematics_1/state/diag-info
The DataLayer node for Motion errors
Note:
Operate G-Code UI
Before you operate G-Code UI, at least one kinematics should be created and PLC project should be in “RUN” state.
- Open G-Code UI at the Node-RED/ Dashboard.
- Select one kinematics.
- Axes power on and group axes of kinematics via "KINON" button.
- Create a new program via "CREATE FILE". The NC programs are saved in "Manage app data-> Active->Scripts will be executed by script runner->gcode".
- Select and open the new program, then NC program can be edited.
- Save the NC program via "SAVE" button.
- Click the "PROG LOAD" button to load the pre-selected program.
- Click the "START" button to implement the program which loaded.
- Pause NC program via "PAUSE", and then continue running program via "START".
- Stop NC program via "STOP" and reset error via "RESET".
