iracing-sdk-js

v1.3.0

Published

8 months ago

iRacing SDK implementation for Node.js

Downloads

0High
0Medium
0Low

friss

iracing

iracing-sdk-js

(Another) Unofficial iRacing SDK implementation for Node.js.

iracing-sdk-js provides data access (live telemetry and session info) and most of the available commands. You can find some usage examples in the examples directory, and there are some data samples too.

Installing

Make sure you are running Node.js v21 x64 or later. (Currently requires Node 21 for latest node test runner implementation, but should work with Node 20 too.)

npm install --save iracing-sdk-js

yarn add iracing-sdk-js --save

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 |

const irsdk = require('iracing-sdk-js')
// look for telemetry updates only once per 100 ms
const iracing = irsdk.init({telemetryUpdateInterval: 100})

irsdk.getInstance() ⇒ iracing

Get initialized instance of JsIrSdk

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

const irsdk = require('iracing-sdk-js')
const iracing = irsdk.getInstance()

iracing ⇐ events.EventEmitter

JsIrSdk is javascript implementation of iRacing SDK.

Don't use constructor directly, use getInstance.

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

iracing ⇐ events.EventEmitter
- instance
- inner
  - ~sessionInfoParser ⇒ Object

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.Consts : IrSdkConsts

iRacing SDK related constants

Kind: instance property of iracing

iracing.camControls : Object

Camera controls

Kind: instance property of iracing

iracing.playbackControls : Object

Replay and playback controls

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')

"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)
})

"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)
})

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