Susi Server

VRPN Output

Node ID: vrpnOutput · Role: Sink · Realtime config: no

Description

Exposes fused pose as a VRPN tracker, letting any VRPN client (e.g. Unity, Unreal, MotionBuilder) receive FusionHub tracking data over the network.

Inputs / Outputs

Config aliases

VrpnSink, vrpnSink, vrpnOutput, VRPN

Properties

Each row shows the setting’s label in the node’s Properties panel and, in code, its key in the node’s settings object in the config file. A setting omitted from the config file uses the default shown here.

PropertyTypeDefaultDescription
Port portnumber3883TCP port the VRPN server listens on.
Device Name deviceNamestringFusionHubDevice name announced by the VRPN server; clients connect as ‘@host:port’.
Orientation Axis Convention axisConventionstring-z+x-ySix-character remap for the output orientation quaternion xyz components, e.g. ‘-z+x-y’. w is always passed through.
Position Axis Convention posAxisConventionstring+z-x+ySix-character remap for the output position xyz components, e.g. ‘+z-x+y’.
Position Scaler positionScalernumber1.0Scalar multiplier applied to the reported position (e.g. 1000 to convert meters to millimeters).
Tracker 0 Object Name tracker0stringtracker0Optical senderId routed to VRPN sensor slot 0 (defaults to ‘tracker0’). OpticalData frames whose senderId matches are forwarded to this sensor.
Tracker 1 Object Name tracker1stringtracker1Optical senderId routed to VRPN sensor slot 1.
Tracker 2 Object Name tracker2stringtracker2Optical senderId routed to VRPN sensor slot 2.
Tracker 3 Object Name tracker3stringtracker3Optical senderId routed to VRPN sensor slot 3.
Tracker 4 Object Name tracker4stringtracker4Optical senderId routed to VRPN sensor slot 4.
Tracker 5 Object Name tracker5stringtracker5Optical senderId routed to VRPN sensor slot 5.
Tracker 6 Object Name tracker6stringtracker6Optical senderId routed to VRPN sensor slot 6.
Tracker 7 Object Name tracker7stringtracker7Optical senderId routed to VRPN sensor slot 7.
Tracker 8 Object Name tracker8stringtracker8Optical senderId routed to VRPN sensor slot 8.
Tracker 9 Object Name tracker9stringtracker9Optical senderId routed to VRPN sensor slot 9.

Example node definition

A minimal entry in config.json looks like the block below. Paste it under the sinks key, keyed by an instance name of your choice. All settings are optional: anything not listed under settings uses the default from the Properties table above. See The configuration file for how the sections and endpoint wiring work.

{
  "sinks": {
    "vrpnOutput": {
      "inputEndpoints": [
        "inproc://fusedPose_data"
      ],
      "inputDataFilter": [
        "FusedPose"
      ],
      "settings": {}
    }
  }
}
Loading documentation…