LumiScan Keryx
Every app publishes its nodes. Values, functions and results go into one tree. |
One address for everything. The same addresses on ctrlX OS and on a PC. |
Your PLC calls it directly. Over OPC UA, from SCADA or from your own program. |
LumiScan Keryx is the data backbone of the LumiScan apps. Every app puts its values, functions and results into one tree of named, typed nodes, and PLCs, SCADA systems, test scripts and your own programs reach all of them at one address, with no point-to-point wiring. On a PC with Windows 11 or Ubuntu 24.04 Keryx provides the Data Layer; on ctrlX OS the apps use the ctrlX Data Layer with the same addresses and call patterns.
The LumiScan vision apps - Cam Driver, AI Object Matching, Calibration, the finders and the code readers - offer their functions as nodes of a Data Layer. A PLC, an OPC UA client or your own program reads, writes and calls these nodes, and the apps use the same nodes to pass images and results to each other. LumiScan Cockpit reads them to show images and results.
This manual describes what is the same in every app: how addresses are built, the three ways to call a function, streams, status codes, settings and the tools. Each product manual describes only its own nodes, in its Data Layer Reference, and links here for the rest.
One interface, two Data Layers
| The app runs on | Data Layer | Read |
|---|---|---|
ctrlX OS (ctrlX CORE or a ctrlX IPC) |
ctrlX Data Layer |
|
a PC with Windows 11 or Ubuntu 24.04 |
LumiScan Keryx |
The node addresses, the node types and the call patterns are the same on both. A program written against one works against the other; only the connection, the tools and the names of a few results differ. See ctrlX Data Layer and LumiScan Keryx.
| This manual describes the Data Layer interface of the upcoming releases of the vision apps. Several nodes have moved compared with earlier releases, without an alias at the old address. If a program written for an earlier release reads a node that is "not found", compare it with the Data Layer Reference of the app version you run. |
Start here
New to Keryx? Start with What Is LumiScan Keryx? and try it hands-on in Getting Started with LumiScan Keryx. Then:
-
Read Addresses and Modules to understand where an app’s nodes are.
-
Choose how to call a function: Choosing a Pattern.
-
Look up the nodes of your app in its manual’s Data Layer Reference.
-
On a PC, set up the broker as in LumiScan Keryx on a PC. To connect a PLC or SCADA system there, use the OPC UA Connector.
-
On ctrlX OS, read ctrlX Data Layer on ctrlX OS: there is nothing to set up, and a ctrlX PLC on the same device uses the nodes directly.
Quick answers: Data Layer FAQ. Something does not work: Troubleshooting.
The apps on the Data Layer
| App | Base address |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
none: Cockpit only reads the other apps' nodes |
Licensing is described in the LumiScan Licensing manual.
In this manual
What Is LumiScan Keryx? – The concept behind LumiScan Keryx - one tree of named, typed values and functions that every LumiScan app, PLC and program reaches at one address.
Getting Started – Try LumiScan Keryx in about 30 minutes without a camera - start the broker, view the tree, read and write nodes, run a handshake, call an execute method.
ctrlX Data Layer and LumiScan Keryx – What is the same and what differs between the ctrlX Data Layer on ctrlX OS and LumiScan Keryx on Windows 11 and Ubuntu 24.04.
Addresses and Modules – Data Layer addresses in LumiScan Keryx - how app and module form an address, the folders control, input, output and setting, the system node, module names.
Status Codes and Results – Status codes in LumiScan Keryx - module status of the apps, execution status of the finders and method call results, also on ctrlX Data Layer and OPC UA.
Settings, Modules and Restart – Settings, modules and restart in LumiScan Keryx - the system node, settings files on the Data Layer, creating and removing modules, what a restart keeps.
Tools – Tools to look at and operate the Data Layer - the Keryx page, LumiScan Keryx Utilities, the command line client krxclient and the ctrlX OS web interface.
OPC UA Connector – The LumiScan OPC UA Connector presents LumiScan Keryx as an OPC UA address space for PLCs and SCADA - endpoint, node mapping, security and subscriptions.
FAQ – Frequently asked questions about the Data Layer of the LumiScan apps - platforms, broker, addresses, handshake, execute, streams, status codes and OPC UA.
Troubleshooting – Troubleshooting LumiScan Keryx - general checks, the broker, missing apps, modules and nodes, refused method calls, handshakes, streams, OPC UA Connector.