node-irsdk-mjo

v1.0.1

Published

7 months ago

iRacing SDK implementation for nodejs

Downloads

0High
0Medium
0Low

manu.overa

irsdk iRacing SDK iRacing

node-irsdk-mjo

Unofficial iRacing SDK implementation for Node.js.

Other iRSDK implementations:

Disclaimer

This is a fork of node-irsdk by apihlaja. The original project is no longer maintained and I have made some changes to the code to make it work with the latest version of iRacing.

Pre-requisites

For compiling this package you need node-gyp@^9.0.0.

npm install -g node-gyp

You also need a current version of Python3 and Microsoft Visual Studio Build Tools installed. More information regarding the topic can be found here. I haven't tried this myself (as I already had msbuild installed), but according to the documentation, you could easily run:

npm install -g windows-build-tools

Installing

Make sure you have Node.js v19 x64 or later.

npm install --save node-irsdk-mjo

API documentation

irsdk

irsdk
- .init([opts]) ⇒ iracing
- .getInstance() ⇒ iracing

irsdk.init([opts]) ⇒ iracing

Initialize JsIrSdk, can be done once before using getInstance first time.

Kind: static method of irsdk
Returns: iracing - Running instance of JsIrSdk

| Param | Type | Default | Description | | -------------------------------- | ------------------------------------------------------------- | -------------- | ----------------------------------------- | | [opts] | Object | | Options | | [opts.telemetryUpdateInterval] | Integer | 0 | Telemetry update interval, milliseconds | | [opts.sessionInfoUpdateInterval] | Integer | 0 | SessionInfo update interval, milliseconds | | [opts.sessionInfoParser] | sessionInfoParser | | Custom parser for session info |

var irsdk = require("node-irsdk");
// look for telemetry updates only once per 100 ms
var iracing = irsdk.init({ telemetryUpdateInterval: 100 });

irsdk.getInstance() ⇒ iracing

Get initialized instance of JsIrSdk

Kind: static method of irsdk
Returns: iracing - Running instance of JsIrSdk

var irsdk = require("node-irsdk");
var iracing = irsdk.getInstance();

iracing ⇐ events.EventEmitter

Kind: global class
Extends: events.EventEmitter
Emits: Connected, Disconnected, Telemetry, TelemetryDescription, SessionInfo
See: EventEmitter API

iracing ⇐ events.EventEmitter

new JsIrSdk()

JsIrSdk is javascript implementation of iRacing SDK.

Don't use constructor directly, use getInstance.

var iracing = require("node-irsdk").getInstance();

iracing.Consts : IrSdkConsts

iRacing SDK related constants

Kind: instance property of iracing

iracing.camControls : Object

Camera controls

Kind: instance property of iracing

.camControls : Object

camControls.setState(state)

Change camera tool state

Kind: static method of camControls

| Param | Type | Description | | ----- | ---------------------------------------------------- | ----------- | | state | CameraState | new state |

// hide UI and enable mouse aim
var States = iracing.Consts.CameraState;
var state = States.CamToolActive | States.UIHidden | States.UseMouseAimMode;
iracing.camControls.setState(state);

camControls.switchToCar(carNum, [camGroupNum], [camNum])

Switch camera, focus on car

Kind: static method of camControls

| Param | Type | Description | | ------------- | ------------------------------------------------------------------------------------------------- | ------------------- | | carNum | Integer | String | CamFocusAt | Car to focus on | | [camGroupNum] | Integer | Select camera group | | [camNum] | Integer | Select camera |

// show car #2
iracing.camControls.switchToCar(2);

// show car #02
iracing.camControls.switchToCar("02");

// show leader
iracing.camControls.switchToCar("leader");

// show car #2 using cam group 3
iracing.camControls.switchToCar(2, 3);

camControls.switchToPos(position, [camGroupNum], [camNum])

Switch camera, focus on position

Kind: static method of camControls

| Param | Type | Description | | ------------- | -------------------------------------------------------------------------- | -------------------- | | position | Integer | CamFocusAt | Position to focus on | | [camGroupNum] | Integer | Select camera group | | [camNum] | Integer | Select camera |

iracing.camControls.switchToPos(2); // show P2

iracing.playbackControls : Object

Replay and playback controls

Kind: instance property of iracing

.playbackControls : Object

playbackControls.play()

Play replay

Kind: static method of playbackControls

iracing.playbackControls.play();

playbackControls.pause()

Pause replay

Kind: static method of playbackControls

iracing.playbackControls.pause();

playbackControls.fastForward([speed])

fast-forward replay

Kind: static method of playbackControls

| Param | Type | Default | Description | | ------- | -------------------- | -------------- | -------------------------------------- | | [speed] | Integer | 2 | FF speed, something between 2-16 works |

iracing.playbackControls.fastForward(); // double speed FF

playbackControls.rewind([speed])

rewind replay

Kind: static method of playbackControls

| Param | Type | Default | Description | | ------- | -------------------- | -------------- | -------------------------------------- | | [speed] | Integer | 2 | RW speed, something between 2-16 works |

iracing.playbackControls.rewind(); // double speed RW

playbackControls.slowForward([divider])

slow-forward replay, slow motion

Kind: static method of playbackControls

| Param | Type | Default | Description | | --------- | -------------------- | -------------- | ---------------------------------------------- | | [divider] | Integer | 2 | divider of speed, something between 2-17 works |

iracing.playbackControls.slowForward(2); // half speed

playbackControls.slowBackward([divider])

slow-backward replay, reverse slow motion

Kind: static method of playbackControls

iracing.playbackControls.slowBackward(2); // half speed RW

playbackControls.search(searchMode)

Search things from replay

Kind: static method of playbackControls

| Param | Type | Description | | ---------- | ---------------------------------------------------- | -------------- | | searchMode | RpySrchMode | what to search |

iracing.playbackControls.search("nextIncident");

playbackControls.searchTs(sessionNum, sessionTimeMS)

Search timestamp

Kind: static method of playbackControls

| Param | Type | Description | | ------------- | -------------------- | ---------------------------- | | sessionNum | Integer | Session number | | sessionTimeMS | Integer | Session time in milliseconds |

// jump to 2nd minute of 3rd session
iracing.playbackControls.searchTs(2, 2 * 60 * 1000);

playbackControls.searchFrame(frameNum, rpyPosMode)

Go to frame. Frame counting can be relative to begin, end or current.

Kind: static method of playbackControls

| Param | Type | Description | | ---------- | -------------------------------------------------- | ------------------------------------------------------- | | frameNum | Integer | Frame number | | rpyPosMode | RpyPosMode | Is frame number relative to begin, end or current frame |

iracing.playbackControls.searchFrame(1, "current"); // go to 1 frame forward

iracing.telemetry

Latest telemetry, may be null or undefined

Kind: instance property of iracing

iracing.telemetryDescription

Latest telemetry, may be null or undefined

Kind: instance property of iracing

iracing.sessionInfo

Latest telemetry, may be null or undefined

Kind: instance property of iracing

iracing.execCmd(msgId, [arg1], [arg2], [arg3])

Execute any of available commands, excl. FFB command

Kind: instance method of iracing

| Param | Type | Description | | ------ | -------------------- | ------------ | | msgId | Integer | Message id | | [arg1] | Integer | 1st argument | | [arg2] | Integer | 2nd argument | | [arg3] | Integer | 3rd argument |

iracing.reloadTextures()

Reload all car textures

Kind: instance method of iracing

iracing.reloadTextures(); // reload all paints

iracing.reloadTexture(carIdx)

Reload car's texture

Kind: instance method of iracing

| Param | Type | Description | | ------ | -------------------- | ------------- | | carIdx | Integer | car to reload |

iracing.reloadTexture(1); // reload paint of carIdx=1

iracing.execChatCmd(cmd, [arg])

Execute chat command

Kind: instance method of iracing

| Param | Type | Description | | ----- | ---------------------------------------------------- | --------------------------- | | cmd | ChatCommand | | | [arg] | Integer | Command argument, if needed |

iracing.execChatCmd("cancel"); // close chat window

iracing.execChatMacro(num)

Execute chat macro

Kind: instance method of iracing

| Param | Type | Description | | ----- | -------------------- | --------------------- | | num | Integer | Macro's number (0-15) |

iracing.execChatMacro(1); // macro 1

iracing.execPitCmd(cmd, [arg])

Execute pit command

Kind: instance method of iracing

| Param | Type | Description | | ----- | -------------------------------------------------- | --------------------------- | | cmd | PitCommand | | | [arg] | Integer | Command argument, if needed |

// full tank, no tires, no tear off
iracing.execPitCmd("clear");
iracing.execPitCmd("fuel", 999); // 999 liters
iracing.execPitCmd("lf"); // new left front
iracing.execPitCmd("lr", 200); // new left rear, 200 kPa

iracing.execTelemetryCmd(cmd)

Control telemetry logging (ibt file)

Kind: instance method of iracing

| Param | Type | Description | | ----- | ------------------------------------------------------ | --------------------------- | | cmd | TelemCommand | Command: start/stop/restart |

iracing.execTelemetryCmd("restart");

"Connected"

iRacing, sim, is started

Kind: event emitted by iracing

iracing.on("Connected", function (evt) {
    console.log(evt);
});

"Disconnected"

iRacing, sim, was closed

Kind: event emitted by iracing

iracing.on("Disconnected", function (evt) {
    console.log(evt);
});

"TelemetryDescription"

Telemetry description, contains description of available telemetry values

Kind: event emitted by iracing

iracing.on("TelemetryDescription", function (data) {
    console.log(evt);
});

"Telemetry"

Telemetry update

Kind: event emitted by iracing

iracing.on("Telemetry", function (evt) {
    console.log(evt);
});

"SessionInfo"

SessionInfo update

Kind: event emitted by iracing

iracing.on("SessionInfo", function (evt) {
    console.log(evt);
});

"update"

any update event

Kind: event emitted by iracing

iracing.on("update", function (evt) {
    console.log(evt);
});

iracing~sessionInfoParser ⇒ Object

Parser for SessionInfo YAML

Kind: inner typedef of iracing
Returns: Object - parsed session info

| Param | Type | Description | | ----------- | ------------------- | ---------------- | | sessionInfo | String | SessionInfo YAML |

IrSdkConsts

IrSdkConsts, iRacing SDK constants/enums.

Kind: global constant

var IrSdkConsts = require("node-irsdk").getInstance().Consts;

IrSdkConsts