haritorax-interpreter
TypeScript icon, indicating that this package has built-in type declarations

1.7.7 • Public • Published

HaritoraX Interpreter

Showcase of the package output with debug logs on, showing the data such as tracker settings, info, and interpreted IMU data via the GX6 dongle

A node.js package that allows you to communicate and interact with the HaritoraX FBT trackers to interpret the data how you want it. No HaritoraConfigurator software needed!

Check out the Haritora-GX(6/2) proof-of-concept repository here: https://github.com/JovannMC/haritora-gx-poc

Installation

npm install haritorax-interpreter

Documentation

Will write actual documentation at some point, for now refer to the source code, examples, and JSDoc comments.

Supported devices

Device Supported Elbow/Hip support
HaritoraX Wireless Y Y
HaritoraX 1.1B ? ?
HaritoraX 1.1 ? ?
HaritoraX 1.0 ? ?
Haritora X X
Communication mode Supported
Bluetooth Y
GX6 Communication Dongle Y
GX2 Communication Dongle Y

Example

import { HaritoraXWireless } from "haritorax-interpreter";

let device = new HaritoraXWireless(2, true); // enable debug mode w/ function & line info, allow printing of processIMUData() logs (lots of spam!)
device.startConnection("gx", ["COM4", "COM5", "COM6", "COM7"]); // start connecting to dongles via GX dongles, with the ports COM4, COM5, COM6, and COM7

device.on("imu", (trackerName, rotation, gravity, ankle) => {
    // IMU data received, do stuff
});

setTimeout(() => {
    // apply the following settings to the rightAnkle tracker:
    // sensor mode: 1 (magnetometer enabled)
    // posture data transfer rate: 100FPS
    // sensor auto correction mode: accelerometer and gyroscope
    // ankle motion detection: enabled
    device.setTrackerSettings("rightAnkle", 1, 100, ['accel', 'gyro'], true);
}, 2000)

setTimeout(() => {
    device.stopConnection("gx");
}, 10000)

Projects using package

  • SlimeTora - A program that connects the HaritoraX Wireless trackers to the SlimeVR server, supporting Bluetooth and the GX6 communication dongle.

Let me know if you want to be featured here, if you are using this package in any project!

License

This package is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Package Sidebar

Install

npm i haritorax-interpreter

Weekly Downloads

338

Version

1.7.7

License

MIT

Unpacked Size

228 kB

Total Files

22

Last publish

Collaborators

  • jovannmc