https://github.com/qualisys/qualisys-js-rt
JavaScript (Node.js) implementation of the real-time protocol for Qualisys Track Manager
https://github.com/qualisys/qualisys-js-rt
javascript motion-capture motion-tracking position-tracking qtm qualisys realtime
Last synced: 3 months ago
JSON representation
JavaScript (Node.js) implementation of the real-time protocol for Qualisys Track Manager
- Host: GitHub
- URL: https://github.com/qualisys/qualisys-js-rt
- Owner: qualisys
- License: mit
- Created: 2015-05-29T10:32:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T13:29:50.000Z (about 1 year ago)
- Last Synced: 2025-07-21T01:24:29.641Z (3 months ago)
- Topics: javascript, motion-capture, motion-tracking, position-tracking, qtm, qualisys, realtime
- Language: JavaScript
- Homepage:
- Size: 547 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Real-time api for QTM
This is a javascript implementation of the [real-time protocol](https://docs.qualisys.com/qtm-rt-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
```javascript
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.
```javascript
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](https://docs.qualisys.com/qtm-rt-protocol/).