A new proof-of-concept GitHub repository with updated information for all the HaritoraX trackers will be coming soon!
People wanted a way to communicate with the GX6 and GX2 Communication Dongles for the HaritoraX Wireless trackers, so after a couple days of work here is a proof-of-concept script that does just that!
Check out the haritorax-interpreter NPM package to communicate with any of the HaritoraX trackers!
https://github.com/JovannMC/haritorax-interpreter
The SlimeTora project allows you to connect the HaritoraX Wireless trackers to the SlimeVR server software, which many people found to be more stable. Unfortunately it only supported Bluetooth at the time, with people who use the GX6/GX2 Communication Dongles left out.. until now.
This project allows you to interface with the GX6 Communication Dongle to grab the IMU's tracking data and even detect button presses on the trackers themselves. The script runs a local server which, with the use of software like RealTerm to capture and echo the serial data to the server, allows for it to interpret the tracking data for use in software like the SlimeVR Server and even detect button presses (with how many times they were pressed). The script rounds the tracking data to 5 decimal places when printing, it is untouched.
- Interpret the IMU's tracking data
- Interpret trackers' buttons - detect which button was pressed and how many times
- Get raw ankle tracking ToF sensor data
- Get battery info of trackers (when turning on tracker w/ script on)
- Debug mode - print out raw data and print to a log file
- Directly communicate with serial ports, instead of relying on software to echo to server
- Add more data - as per sim1222's project, there is a lot more data I should see if I can grab from the trackers.
- or, request any data from trackers at any time (eg battery) - needs more experimenting
- Investigate any unknown labels (eg
o) - Interpret calibration data(?)
The GX6 Communication Dongle is a 2.4GHz dongle that uses a proprietary protocol to communicate with the HaritoraX Wireless trackers to skip bluetooth to be more stable, lower latency, allowing more bluetooth devices, etc.
The dongle works by acting as a Generic USB Hub and within it, three USB Serial Devices are plugged in. These serial devices communicate with two trackers each (with a total of all 6 trackers split between the three) which allows the HaritoraConfigurator software to communicate with the trackers.
When first opening a connection to the serial port, the dongle reports its own, and the trackers' model number, firmware version, and serial number under the i(id) label followed by the o(id) labels for settings. The dongle is constantly finding its two trackers under the a(id) labels, outputting the value of 7f7f7f7f7f7f. After a tracker is connected to a port, the tracker reports its battery status under the v(id) label - battery voltage, percentage remaining, and charge status (discharging, charging, or charged). Then, it starts reporting the IMU tracking data under the x(id) label which is encoded in base64. When either the main or sub button is pressed on the tracker (or the tracker turns on/off), a r(id) label is used which tracks how many times both buttons have been pressed using hexadecimal under the same 12 bits of data (bit 7 for main, bit 10 for sub), up until 15 (which is f, and is 0-indexed) to which it resets back to 0. Also within the r(id) labels is a way to identify the tracker (bit 5), read the table below:
| Tracker name | Bit 5 value |
|---|---|
| Chest | 1 |
| Left knee | 2 |
| Left ankle | 3 |
| Right knee | 4 |
| Right ankle | 5 |
| Hip | 6 |
| Left elbow | 7 |
| Right elbow | 8 |
To set the settings on the tracker, we see o(id) identifiers being used. It uses 14 bits and certain bits are used to represent a setting which are as follows:
| Setting | Bit | Options | Value |
|---|---|---|---|
| Posture data transfer rate | 6 | 50FPS | 0 |
| 100FPS | 1 | ||
| Sensor mode | 7 | Mode 1 | 1 |
| Mode 2 | 0 | ||
| Sensor auto correction | 11 | Accel(erometer) | 1 |
| Gyro(scope) | 2 | ||
| Mag(netometer) | 4 | ||
| Ankle motion detection | 14 | Disabled | 0 |
| Enabled | 1 |
To calculate the "sensor auto correction" (aka "dynamic calibration") setting, get the number(s) of the sensors you want to use and add them together - bitwise operations. (Accel + Mag = 1 + 4 = 5)
Examples for values of each label I found (all mostly for tracker 0, however same thing for tracker 1):
i:{"version":"1.0.19","model":"GX6","serial no":"SERIAL"}- dongle firmware version, model, and seriali0:{"version":"1.0.22","model":"mc3s","serial no":"SERIAL"}- tracker firmware version, model, and serialo0:00000110107000- the settings for the tracker. 100fps, sensor mode 1, accel+gyro+mag sensor auto correction, and ankle motion detection disabledo:3050- unknown value for dongle, but seems to correspond to what COM port/order it is? (bit 3)a0:7f7f7f7f7f7f- searching for/unable to find tracker 0 (for that COM port)v0:{"battery voltage":4107,"battery remaining":94,"charge status":"Discharging"}- battery voltage, percentage remaining, and status for tracker 0 (for that COM port)X0:0Ayb3u7+DzWeBxoDVQMAAA==- raw IMU tracking data for tracker 0, encoded in base64. The last two bits represent the ankle motion data,==means nothing (not an ankle tracker). Bit 20 represents the magnetometer status- A = green
- B = yellow
- C/D = red
r0:110060800a00- raw button data for tracker 0 - main button pressed 7 times, sub button pressed 9 times (0-indexed, a = 10 in hex). Tracker is left ankle (bit 5 = 6, 6 = left ankle)
It is currently unknown what else a labels are used for other, they report seemingly random data every second. Any help is appreciated!
- SlimeTora - inspiration of project
- Haritora SlimeVR Bridge - the math for interpreting the tracking data
- ChatGPT - because I'm bad at coding