Merge pull request #24 from SlimeVR/feat/tracker-emulation/user-actions

fix(firmware-protocol): Add missing user action packet

.changeset/six-cherries-visit.md

@@ -0,0 +1,5 @@
+---
+'@slimevr/firmware-protocol': patch
+---
+
+added missing UserAction (21) packet

.changeset/wise-hornets-rescue.md

@@ -0,0 +1,5 @@
+---
+'@slimevr/tracker-emulation': patch
+---
+
+add the ability to send the UserAction (21) packet

packages/firmware-protocol/src/packets/PacketParser.ts

@@ -22,6 +22,7 @@ import { ServerBoundSensorInfoPacket } from './ServerBoundSensorInfoPacket';
 import { ServerBoundSignalStrengthPacket } from './ServerBoundSignalStrengthPacket';
 import { ServerBoundTapPacket } from './ServerBoundTapPacket';
 import { ServerBoundTemperaturePacket } from './ServerBoundTemperaturePacket';
+import { ServerBoundUserActionPacket } from './ServerBoundUserActionPacket';
 import { InspectionPacketParser } from './inspection/PacketParser';
 
 const bundle = (num: bigint, packet: Packet | null) => [num, packet] as const;
@@ -118,6 +119,9 @@ export const parse = (data: Buffer, isDeviceBound: boolean, isInBundle = false)
       case ServerBoundTemperaturePacket.type:
         return bundle(num, ServerBoundTemperaturePacket.fromBuffer(data));
 
+      case ServerBoundUserActionPacket.type:
+        return bundle(num, ServerBoundUserActionPacket.fromBuffer(data));
+
       case InspectionPacketParser.type:
         return bundle(num, InspectionPacketParser.parseRawDataPacket(data));
 

packages/firmware-protocol/src/packets/ServerBoundUserActionPacket.ts

@@ -0,0 +1,40 @@
+import { Packet } from './Packet';
+
+export const UserAction = {
+  RESET_FULL: 2,
+  RESET_YAW: 3,
+  RESET_MOUNTING: 4,
+  PAUSE_TRACKING: 5
+} as const;
+export type UserAction = (typeof UserAction)[keyof typeof UserAction];
+
+export class ServerBoundUserActionPacket extends Packet {
+  constructor(readonly action: number) {
+    super(ServerBoundUserActionPacket.type);
+  }
+
+  static fromBuffer(data: Buffer) {
+    const action = data.readUIntBE(0, 1) & (0xff as UserAction);
+
+    return new ServerBoundUserActionPacket(action);
+  }
+
+  static get type() {
+    return 21;
+  }
+
+  override toString() {
+    return `ServerBoundUserActionPacket{action: ${this.action}}`;
+  }
+
+  encode(num: bigint): Buffer {
+    const buf = Buffer.alloc(4 + 8 + 1);
+
+    buf.writeInt32BE(ServerBoundUserActionPacket.type, 0);
+    buf.writeBigInt64BE(num, 4);
+
+    buf.writeInt8(this.action, 12);
+
+    return buf;
+  }
+}

packages/firmware-protocol/src/packets/index.ts

@@ -3,6 +3,7 @@ export * from './DeviceBoundHandshakePacket';
 export * from './DeviceBoundHeartbeatPacket';
 export * from './DeviceBoundPingPacket';
 export * from './DeviceBoundSensorInfoPacket';
+export * from './inspection';
 export * from './Packet';
 export * from './PacketParser';
 export * from './ServerBoundAccelPacket';
@@ -23,4 +24,4 @@ export * from './ServerBoundSensorInfoPacket';
 export * from './ServerBoundSignalStrengthPacket';
 export * from './ServerBoundTapPacket';
 export * from './ServerBoundTemperaturePacket';
-export * from './inspection';
+export * from './ServerBoundUserActionPacket';

packages/tracker-emulation/src/EmulatedTracker.ts

@@ -22,7 +22,9 @@ import {
   ServerBoundRotationDataPacket,
   ServerBoundSignalStrengthPacket,
   ServerBoundTemperaturePacket,
-  ServerFeatureFlags
+  ServerBoundUserActionPacket,
+  ServerFeatureFlags,
+  UserAction
 } from '@slimevr/firmware-protocol';
 import { createSocket, RemoteInfo, Socket } from 'dgram';
 import EventEmitter from 'events';
@@ -166,6 +168,10 @@ export class EmulatedTracker extends (EventEmitter as {
     await this.sendPacketToServer(new ServerBoundSignalStrengthPacket(sensorId, signalStrength));
   }
 
+  async sendUserAction(action: UserAction) {
+    await this.sendPacketToServer(new ServerBoundUserActionPacket(action));
+  }
+
   async sendPacketToServer(packet: Packet) {
     if (this.state.status !== 'connected-to-server') return;