@irsdk-node/native 4.1.0 → 5.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021 Matthew Bengston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,46 +1,115 @@
 # @irsdk-node/native
 
-This is the native bindings package for irsdk-node. This provides near 1:1 bindings to the C++ iRacing SDK, and is consumed as an optional dependency of [irsdk-node](../irsdk-node), which provides a handy little wrapper around the API to make it nicer to use and avoid boilerplating.
+_Currently using **iRacing SDK v1.19**. You can see the latest version of the SDK [on the forums](https://forums.iracing.com/discussion/62/iracing-sdk/p1)._
 
-While you can use this package directly, it is highly recommended to use the [irsdk-node](../irsdk-node) package instead.
+This is the native bindings package for irsdk-node. This provides near 1:1 bindings to the C++ iRacing SDK, and is consumed as a dependency of [irsdk-node](https://github.com/bengsfort/irsdk-node/tree/main/packages/irsdk-node), which provides a handy little wrapper around the API to make it nicer to use and avoid boilerplating.
 
-## Why an optional dependency?
+While you can use this package directly, it is highly recommended to use the [irsdk-node](https://github.com/bengsfort/irsdk-node/tree/main/packages/irsdk-node) package instead. Types for the data exposed via this package can be used independently via [@irsdk-node/types](https://github.com/bengsfort/irsdk-node/tree/main/packages/irsdk-node-native) as well.
 
-The [irsdk-node](../irsdk-node) package was split up in to separate packages to solve the issue that this SDK is windows-only, which means that the package wasn't able to be used in any other environment. For most cases this is fine, however it becomes a big issue if you want to do something as simple as use the types in a webview or in an electron renderer process. As an optional dependency, the types and rest of the SDK can be imported as needed wherever.
+## Usage
+Install as a dependency.
 
-## Debugging
+```sh
+# Via npm..
+$ npm install @irsdk-node/types
 
-- `yarn build-cpp:debug`: Builds the native module in debug mode.
+# Or yarn..
+$ yarn add @irsdk-node/types
 
-In debug mode, you are going to need to swap to using the `DebugSDK` rather than `NativeSDK`. This uses the debug build rather than the release build, which allows debugging/breakpoints via vscode (you can use the `Debug bridge` run task in vscode to do this). For example:
+# Or pnpm..
+$ pnpm add @irsdk-node/types
+```
 
-```diff
-// In `src/irsdk-node.ts`
-+ import { DebugSDK } from '@irsdk-node/native';
-- import { NativeSDK } from '@irsdk-node/native';
+Then you can use the SDK bindings directly.
+
+```ts
+import { NativeSDK } from '@irsdk-node/native';
+import {
+    SessionData,
+    TelemetryVarList,
+    TelemetryVariable,
+    BroadcastMessages,
+    TelemetryCommand,
+    } from '@irsdk-node/types';
+
+const sdk = new NativeSDK();
+
+// Try to start the SDK. This will return false if an iRacing session is not active.
+//
+// In cases where the SDK is not running, you would likely want to poll this fn
+// so you can start grabbing data once a session starts.
+if (!sdk.startSDK()) {
+    console.log('iRacing not running');
+    process.exit(0);
+}
+
+// Start telemetry.
+sdk.broadcast(BroadcastMessages.TelemCommand, TelemetryCommand.Start);
+
+// Grab data from the SDK.
+const TICK_RATE = 1 / 60; // 60fps, the max
+if (sdk.waitForData(TICK_RATE)) {
+    // This is a YAML string of more static data. Every time this changes,
+    // sdk.currDataVersion will be incremented by 1. -1 is the default value.
+    //
+    // This object is BIG. It is recommended to only fetch when currDataVersion
+    // changes to avoid performance issues.
+    const sessionData: SessionData = sdk.getSessionData();
+
+    // Telemetry needs to be massaged using var.varType to their correct types,
+    // for example, varType 4 (float32) should be parsed as Float32Array.
+    //
+    // See irsdk-node codebase for examples.
+
+    // Returns ALL telemetry variables as a big object.
+    const allTelemetry: TelemetryVarList = sdk.getTelemetryData();
+
+    // Get just one telemetry variable by name or index. Usually by name.
+    const incidentCount: TelemetryVariable<number[]> = sdk.getTelemetryVariable('PlayerCarMyIncidentCount');
+}
+
+// Close the SDK once you are done.
+sdk.stopSDK();
 ```
 
-## Generating types
+## Distribution
+
+To ensure cross-compat between platforms, a mock SDK api is provided for non-windows platforms. This gets built on all supported platforms automatically during deployment via [github actions](../../.github/workflows/do-release.yaml). [Node-gyp](https://www.npmjs.com/package/node-gyp) is used under the hood for building the node.js C++ module, with pre-build functionality provided by [prebuildify](https://www.npmjs.com/package/prebuildify).
+
+Prebuildify also will automatically detect the platform and import the correct native module for the platform. If it doesn't exist, during installation it will attempt to build it.
+
+## Contributing
 
-This package contains a utility script for generating Typescript types based on the actual Telemetry values present during runtime. To do so you can run `yarn generate-types` while you have iRacing running and connected to a server. This will generate a new .ts types file in the [@irsdk-node/types](../irsdk-node-types) package.
+### SDK
+
+The SDK in its entirety lives in [lib](./lib/) along with the node.js bindings class. Technically it is always at the 'latest version' of the sdk with regards to the telemetry and session data since those are just pure data, but for other API updates the latest sdk files can just be replaced within that directory to update to the latest (for example `irsdk_client.h`, `irsdk_defines.h`, etc.)
+
+### Generating types
+
+This package contains a utility script for generating Typescript types based on the actual Telemetry values present during runtime. To do so you can run `pnpm generate-types` while you have iRacing running and connected to a server. This will generate a new .ts types file in the [@irsdk-node/types](../irsdk-node-types) package.
 
 Please refer to the readme in the types package for more info.
 
-## Commands
+### Commands
+
+These are the primary commands for package development.
 
 ```sh
-# Build the module.
-$ yarn build
+# Build the package.
+$ pnpm build
+
+# Build only the typescript.
+$ pnpm build:ts
 
-# Build either the release or debug build.
-$ yarn build-cpp:[release|debug]
+# Build the C++ module.
+$ pnpm build:cpp
 
 # Run util script for generating typescript types
-$ yarn generate-types
+$ pnpm generate-types
 
 # Clean the build directories
-$ yarn clean
+$ pnpm clean
 
 # Lint package
-$ yarn lint
+$ pnpm lint
 ```