Analog VRPN Server

Summary

Doc_BoxAlgorithm_AnalogVRPNServer.png
  • Plugin name : Analog VRPN Server
  • Version : 1.0
  • Author : Bruno Renier/Yann Renard
  • Company : INRIA
  • Short description : Creates VRPN analog servers (one per input).
  • Documentation template generation date : Nov 2 2017

Description

Creates VRPN analog servers to make data from the plugin's inputs available to VRPN client applications.

This plugin exposes several Doc_Streams_StreamedMatrix streams to an external application thanks to the VRPN protocol. VRPN stands for Virtual Reality Peripheral Network (http://www.cs.unc.edu/Research/vrpn/). It consists in a library that abstracts most used VR peripherals as an aggregation of basic components such as analogic data, buttons or trackers (localisation and orientation in space).

The way §OpenViBE§ exposes Doc_Streams_StreamedMatrix streams to external applications consists in emulating an multi-channel analogic device. The number of elements contained in the buffers of the stream will fix the number of channels of the emulated device. Given this behavior, any VRPN ready application is able to get parameters from §OpenViBE§ and to provide feedback to the user as visual information or whatever way the feedback should be done.

Inputs

This box accepts unlimited number of inputs. Initial box only has a single input but you can add as many Doc_Streams_StreamedMatrix derived inputs as you want to the box.

Note that in case you add inputs, the total number of channels of the emulated device will be the sum of the number of elements of each buffer.

1. Input 1

This input will receive the matrices from preceding boxes and update the multi-analog device according to the matrix buffer.

  • Type identifier : Streamed matrix (0x544a003e, 0x6dcba5f6)

Settings

1. Peripheral name

This setting contains the name of the emulated peripheral. This will be used by the external application in order to connect to this peripheral. If this setting is openvibe-vrpn and the machine running §OpenViBE§ is openvibe-machine, then the complete VRPN peripheral name is openvibe-vrpn@openvibe-machine.

  • Type identifier : String (0x79a9edeb, 0x245d83fc)
  • Default value : [ openvibe-vrpn ]

Examples

Miscellaneous

This box lacks an additional setting to specify the connection port. Default VRPN connection port is 3883. But it may be possible that you want to expose §OpenViBE§ on another port. This is not currently possible.

Note that if the box receives no input header or data, the clients will see a channel count of 0 until header has been processed by the box.

For buttons emulation, you way want to look at the Button VRPN Server documentation that does almost the same as this box but transcoding stimulations to button states.