Merge pull request #24 from tcavenezuela/feat/new-simulator-offsets

chore: add new misc offsets (simulator related)

.changeset/wise-yaks-teach.md

@@ -0,0 +1,8 @@
+---
+'@fsuipc.js/api': patch
+---
+
+add offset 0x3308: sim version currently in use.
+add offset 0x3d00: aircraft name currently in use.
+add exclusive X-Plane offset 0x6fff: flag to indicate if the fsuipc version is currently running in X-Plane (XPUIPC).
+add exclusive X-Plane offset 0x6f03: XPUIPC version string.

packages/api/src/shared/offset-category.ts

@@ -17,5 +17,6 @@ export enum OffsetCategory {
   RADIOS = 'radios',
   RUNWAY = 'runway',
   SIMULATION = 'simulation',
-  WEATHER = 'weather'
+  WEATHER = 'weather',
+  MISC = 'misc'
 }

packages/api/src/utils/offsets/index.ts

@@ -18,6 +18,7 @@ import { engines } from './plane/engines';
 import { autopilot } from './plane/autopilot';
 import { failure } from './failure/failure';
 import { electric } from './plane/electric';
+import { simulator } from './misc/simulator';
 
 export const OFFSETS: OffsetList = {
   // Position and Attitude
@@ -48,7 +49,10 @@ export const OFFSETS: OffsetList = {
   ...icing,
   ...engines,
   ...autopilot,
-  ...electric
+  ...electric,
+
+  // Misc
+  ...simulator
 };
 
 export * from './airport/runway';
@@ -68,3 +72,4 @@ export * from './plane/engines';
 export * from './plane/autopilot';
 export * from './simulation/simulation';
 export * from './plane/electric';
+export * from './misc/simulator';

packages/api/src/utils/offsets/misc/simulator.ts

@@ -0,0 +1,43 @@
+import { Type } from 'fsuipc.js';
+
+import { OffsetCategory } from '@shared/offset-category';
+import { OffsetList } from '@shared/offset-list';
+import { Offset } from '@shared/offset';
+
+export const simulator: OffsetList = {
+  fsVersion: new Offset({
+    value: 0x3308,
+    name: 'fsVersion',
+    category: OffsetCategory.MISC,
+    description: 'sim version currently in use',
+    type: Type.UInt16,
+    permission: 'r'
+  }),
+  aircraftTitle: new Offset({
+    value: 0x3d00,
+    name: 'aircraftTitle',
+    category: OffsetCategory.MISC,
+    description: 'aircraft name currently in use',
+    type: Type.String,
+    length: 256,
+    permission: 'r'
+  }),
+  /* XPUIPC offsets */
+  xplaneFlag: new Offset({
+    value: 0x6fff,
+    name: 'xplaneFlag',
+    category: OffsetCategory.MISC,
+    description: 'flag to indicate if the fsuipc version is currently running in X-Plane (XPUIPC)',
+    type: Type.Byte,
+    permission: 'r'
+  }),
+  xpuipcVersion: new Offset({
+    value: 0x6f03,
+    name: 'xpuipcVersion',
+    category: OffsetCategory.MISC,
+    description: 'XPUIPC version string',
+    type: Type.String,
+    length: 256,
+    permission: 'r'
+  })
+};