Real-time api for QTM

This is a javascript implementation of the real-time protocol provided by Qualisys Track Manager (QTM).

It is used to stream data from a computer running QTM. The real-time api can also be used to start and stop measurements, setting events and more.

Installation

1. npm install qualisys-rt

Example

var Api = require('qualisys-rt').Api;

var api = new Api({ debug: true });

// Set up an event handler.
api.on('frame', function(data) {
	console.log('Received frame:'.green);
	console.log(data);
});

// Connect to host (defaults to 'localhost')
// and start streaming 3d data.
api.connect()
	.then(function() { return api.streamFrames({ components: ['3D'] }) })
	.catch(console.log)
;

Getting started

There is not much documentation yet so the best way to get started is by examining demo.js, which contains example code for common tasks.

Api methods

This api supports most commands in the QTM real-time protocol. The supported commands are accessed through methods of the Api class:

• api.byteOrder()
• api.calibrate(refine)
• api.closeMeasurement()
• api.connect(port, host, major, minor)
• api.debug(enableDebug)
• api.disconnect()
• api.discover(port)
• api.frequency()
• api.getCaptureC3d()
• api.getCaptureQtm()
• api.getCurrentFrame()
• api.getParameters()
• api.getState()
• api.led(camera, mode, color)
• api.load(filename, connect)
• api.loadProject(path)
• api.newMeasurement()
• api.qtmVersion()
• api.releaseControl()
• api.reprocess()
• api.save(filename, overwrite)
• api.setParameters(params)
• api.setQtmEvent(label)
• api.startCapture()
• api.stopCapture()
• api.stopStreaming()
• api.streamFrames(options)
• api.takeControl(password)
• api.trigger()

Additional api members

• api.isConnected
• api.isStreaming

Viewer 2D

You can view 2D data in your terminal by using the Viewer2D class.

api.connect(22223, 'localhost')
	.then(function() { return api.qtmVersion(); })
	.then(function() {
		var viewer = new Viewer2d(api);
		return viewer.render(1, { color: 'red' });
	})

For a reference of what's possible with the real-time protocol, refer to the QTM Real-time Server Protocol Documentation.