Skip to content

Common Concepts

The protocol pages link here instead of repeating what is the same for every interface.

Every protocol page has a section Create or import signals. It names up to four routes:

RouteWhat it means
ManuallyYou type the protocol address in the signal dialog. The dialog shows protocol-specific address guidance and the available data types and, where the protocol supports it, validates the address with the parser the interface uses at connect time.
BrowseCONNECT asks the controller what it offers, and you select signals instead of typing them. For some protocols the browse reads a symbol file named in the interface settings instead.
File importA file exported from the engineering tool is read in the browser and pushed to the gateway, for example a Siemens tag table, a SEW symbol table or a CODESYS .gvl.
From the modelThe model already has its PLC signals and only the addresses are missing: Addresses → Fill from controller… (where Browse provides usable addresses) and Addresses → Import address table… (any interface). Tracking signals are generated automatically.

Where a route does not exist, the protocol page says so. The routes themselves are described in Configuring interfaces.

An address names a value in the protocol’s own notation, for example DB1.DBX0.0, ns=2;s=Motor1.Speed or HR40001. The direction follows the PLC convention: a PLCInput is written by realvirtual, a PLCOutput is written by the controller. When a model signal has the same name, its direction and type are binding. See Signal direction.

Both directions in one signal list: PLC inputs (InBool) written by realvirtual above, PLC outputs (OutBool) written by the PLC below

Values from the browser reach the real controller only when write access is switched on for that interface. It is off by default. In the interface settings it is labelled Allow Web → PLC writes (a few interface types word it slightly differently, for example Allow writing to the partner). See Write access to the controller.

Text signals (PLCInputText / PLCOutputText) travel only over protocols that carry strings:

Text supportedText planned
MQTT (single and JSON topics), OPC UA, ctrlX Data Layer, TwinCAT ADS, B&R PVI, DensoSiemens S7, PLCSIM Advanced, Modbus, UDP, ROS, CODESYS NVL

Text is never converted silently. Setters from outside CONNECT, such as the MCP tools signal_set_bool, signal_set_float, signal_set_text and signal_force, and the REST force call, check the type of the target signal: a text signal accepts only a JSON string, and a numeric or Boolean signal rejects a string. signal_set_text is the gateway tool for text signals. The historian skips text signals. When a signal is filled into a model and its CONNECT type differs, it is retyped to the model’s text type. See Text signals.

Here <id> is the CONNECT interface ID, N is a body or Flystick slot starting at 1, and K is a button number starting at 1. DTrack and NatNet generate read-only PLCOutput signals:

SignalTypeMeaning
<id>.frameIntFrame heartbeat; DTrack’s frame counter (or a local per-frame counter if absent), or NatNet’s frame number
<id>.body<N>.x, .y, .zFloatPosition in millimetres
<id>.body<N>.qx, .qy, .qz, .qwFloatUnit quaternion orientation
<id>.body<N>.validBoolWhether the body is tracked in the received frame
<id>.fly<N>.x, .y, .z, .qx, .qy, .qz, .qw, .validFloat / BoolDTrack only: the same pose fields for a Flystick
<id>.fly<N>.btn<K>BoolDTrack only: button currently held
<id>.fly<N>.btn<K>countIntDTrack only: rising-edge press counter, wrapping as a signed 32-bit integer
<id>.fly<N>.joyx, .joyyFloatDTrack only: joystick axes, -1 to 1

For example, interface ID dtrack generates dtrack.body1.x, dtrack.body1.valid and dtrack.frame. A DisplayWall viewport connects these signals to its pose and heartbeat slots, for example with Fill from body on the pose group dtrack.body1. The Flystick group dtrack.fly1 and its button and joystick signals feed the wall’s Flystick pointing, selecting and grabbing the same way. Use the press counters when short button presses must survive a publish interval; compare counter changes modulo 2³².

CONNECT publishes a right-handed, Y-up coordinate system in millimetres. DTrack positions already arrive in mm; NatNet positions are converted from metres to mm. With SourceUpAxis = Z, positions transform as (x, y, z) → (x, z, -y) and quaternion components as (qx, qy, qz, qw) → (qx, qz, -qy, qw). With Y, the axes are kept. Orientations are normalized. Measure the wall corners in this converted coordinate system, and verify actual tracking directions at the installation.

Both interfaces wait in Connecting for the first recognized frame. Afterwards, no recognized frame for TimeoutMs sets the interface to Error, reports dataStale and makes all pose .valid flags false. Position and orientation values keep their last numbers. A missing or untracked body also becomes invalid without clearing those numbers.

A data timeout keeps the UDP receiver open. The next recognized frame clears the stale state and restores Connected, without a reconnect. A real socket fault can still cause a reconnect. Consumers must check .valid and heartbeat freshness rather than treating unchanged coordinates as proof that tracking is working.

For licensing, only the generated names count: one heartbeat plus the pose fields of configured bodies and, for DTrack, the configured Flystick pose, button, counter and joystick fields. Manually entered signals on these two interface types are ignored, reported as unsupported and do not consume licence slots. Reduce the configured counts or BodyIds to publish fewer signals.