Skip to content

WebSocket Realtime

Uses realvirtual WebSocket protocol v2, the same protocol as realvirtual for Unity’s WebSocket Realtime interface and the ctrlX bridge. CONNECT can be the server or the client.

ParameterExample
ModeServer (default) or client
Server: bind address / port127.0.0.1 / 8080
Client: address / port / path192.168.1.40 / 8080 / empty
API keyrequired before the server accepts other machines

This interface uses realvirtual WebSocket protocol v2, also used by realvirtual for Unity’s WebSocket Realtime interface and the ctrlX bridge. As a server, CONNECT listens on its own port, separate from the gateway port. As a client, it connects to a Unity scene or another server and subscribes to its signals. Signals are addressed by the name used on the wire, which may differ from the local signal name. Browse asks the connected peer for its signal list and turns the peer’s inputs into outputs here and vice versa. Name patterns can preset the direction.

  • Manually. Enter the signal name used on the wire, which may differ from the local signal name.
  • Browse. Yes. Browse asks the connected peer for its signal list and turns the peer’s inputs into outputs here and vice versa. Name patterns can preset the direction.
  • File import. No protocol-specific file import. Use Addresses → Import address table… for a prepared list.
  • From the model. When the model already has its PLC signals, Addresses → Fill from controller… in the signal-mapping section of the CONNECT panel previews matches by exact name against what Browse finds and then writes the addresses. Addresses → Import address table… takes a CSV or TSV with name;address[;dataType[;topic]] rows. New signals take direction and type from the same-named model signal; signals that already exist keep their configured type. See Configuring interfaces.

How direction, data types and write access are decided is explained in Common concepts and Configuring interfaces.