Skip to content

Commit

Permalink
v2.0.0
Browse files Browse the repository at this point in the history
+ Overhaul most of the code
+ Add support for HaritoraX Wired trackers
  + 1.1b, 1.1, and 1.0 now supported
  + Most functions implemented (tracker settings, button, mag status, and battery - ankle needs further testing)
  - Per-tracker settings for wired impossible to add
+ Add "heartbeatInterval" for wired
+ Rename "GX" to "COM"
+ Add ability to emulate a "data" event  from COM port
+ Update JSDoc (still haven't made actual docs lol)
+ Some bug fixes and optimizations
  • Loading branch information
JovannMC committed Jun 22, 2024
1 parent e52a088 commit ed8feae
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![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](showcase.png)

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!
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 (mostly)!

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

Expand All @@ -19,23 +19,24 @@ Will write actual documentation at some point, for now refer to the source code,
| Device | Supported | Elbow/Hip support |
|--------------------|-----------|-------------------|
| HaritoraX Wireless | Y | Y |
| HaritoraX 1.1B | ? | ? |
| HaritoraX 1.1 | ? | ? |
| HaritoraX 1.0 | ? | ? |
| HaritoraX 1.1B | Y | Y |
| HaritoraX 1.1 | Y | Y |
| HaritoraX 1.0 | Y | Y |
| Haritora | X | X |

| Communication mode | Supported |
|---------------------------|-----------|
| Bluetooth | Y |
| Bluetooth (Low Energy) | Y |
| Bluetooth Classic (COM) | Y |
| GX6 Communication Dongle | Y |
| GX2 Communication Dongle | Y |

## Example
```js
import { HaritoraXWireless } from "haritorax-interpreter";
import { HaritoraX } 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
let device = new HaritoraX("wireless", 2, true); // connect to haritorax wireless, 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 (COM connection), with the ports COM4, COM5, COM6, and COM7

device.on("imu", (trackerName, rotation, gravity, ankle) => {
// IMU data received, do stuff
Expand All @@ -51,7 +52,7 @@ setTimeout(() => {
}, 2000)

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

Expand All @@ -68,5 +69,5 @@ This package is licensed under the [MIT](https://opensource.org/license/mit/) Li
## Acknowledgements

- [haritorax-slimevr-bridge](https://github.com/sim1222/haritorax-slimevr-bridge) - sim1222 - math for decoding the IMU packet data
- [SlimeTora](https://github.com/OCSYT/SlimeTora/) - BracketProto - code for fixing drifting from incorrect acceleration (gravity) values
- [ShiftAll Discord](https://discord.gg/vqXmAFy5RC) - community - helping with testing the package
- [SlimeTora](https://github.com/OCSYT/SlimeTora/) - BracketProto - code for fixing drifting from incorrect acceleration (gravity) values and original inspiration for project
- [ShiftAll Discord](https://discord.gg/vqXmAFy5RC) - community - helping with testing the package (via [SlimeTora](https://github.com/OCSYT/SlimeTora/))
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "haritorax-interpreter",
"version": "1.8.3",
"version": "2.0.0",
"homepage": "https://github.com/JovannMC/haritorax-interpreter",
"repository": "https://github.com/JovannMC/haritorax-interpreter",
"bugs": {
Expand Down

0 comments on commit ed8feae

Please sign in to comment.