node-irsdk v2.1.6

node-irsdk

Unofficial iRacing SDK implementation for Node.js.

node-irsdk provides data access (live telemetry and session info) and most of available commands. You can find some usage examples from utils directory, and there is some data samples too.

• GitHub repo
• documentation
• forum thread

Other iRSDK implementations:

• Official C/C++ SDK
• iRacingSdkWrapper (C#)
• pyirsdk (python3)
• iRacingSDK.Net

Installing

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

npm install --save node-irsdk

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

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()
  • instance
    • .Consts : IrSdkConsts
    • .camControls : Object
      • .setState(state)
      • .switchToCar(carNum, [camGroupNum], [camNum])
      • .switchToPos(position, [camGroupNum], [camNum])
    • .playbackControls : Object
      • .play()
      • .pause()
      • .fastForward([speed])
      • .rewind([speed])
      • .slowForward([divider])
      • .slowBackward([divider])
      • .search(searchMode)
      • .searchTs(sessionNum, sessionTimeMS)
      • .searchFrame(frameNum, rpyPosMode)
    • .telemetry
    • .telemetryDescription
    • .sessionInfo
    • .execCmd(msgId, [arg1], [arg2], [arg3])
    • .reloadTextures()
    • .reloadTexture(carIdx)
    • .execChatCmd(cmd, [arg])
    • .execChatMacro(num)
    • .execPitCmd(cmd, [arg])
    • .execTelemetryCmd(cmd)
    • "Connected"
    • "Disconnected"
    • "TelemetryDescription"
    • "Telemetry"
    • "SessionInfo"
    • "update"
  • inner
    • ~sessionInfoParser ⇒ Object

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
  • .setState(state)
  • .switchToCar(carNum, [camGroupNum], [camNum])
  • .switchToPos(position, [camGroupNum], [camNum])

camControls.setState(state)

Change camera tool state

Kind: static method of camControls

// 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

// 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

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

iracing.playbackControls : Object

Replay and playback controls

Kind: instance property of iracing

• .playbackControls : Object
  • .play()
  • .pause()
  • .fastForward([speed])
  • .rewind([speed])
  • .slowForward([divider])
  • .slowBackward([divider])
  • .search(searchMode)
  • .searchTs(sessionNum, sessionTimeMS)
  • .searchFrame(frameNum, rpyPosMode)

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

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

playbackControls.rewind(speed)

rewind replay

Kind: static method of playbackControls

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

playbackControls.slowForward(divider)

slow-forward replay, slow motion

Kind: static method of playbackControls

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

iracing.playbackControls.search('nextIncident')

playbackControls.searchTs(sessionNum, sessionTimeMS)

Search timestamp

Kind: static method of playbackControls

// 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

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

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

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

iracing.execChatCmd(cmd, arg)

Execute chat command

Kind: instance method of iracing

iracing.execChatCmd('cancel') // close chat window

iracing.execChatMacro(num)

Execute chat macro

Kind: instance method of iracing

iracing.execChatMacro(1) // macro 1

iracing.execPitCmd(cmd, arg)

Execute pit command

Kind: instance method of iracing

// 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

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

IrSdkConsts

IrSdkConsts, iRacing SDK constants/enums.

Kind: global constant

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

• IrSdkConsts
  • .BroadcastMsg
  • .CameraState
  • .RpyPosMode
  • .RpySrchMode
  • .RpyStateMode
  • .ReloadTexturesMode
  • .ChatCommand
  • .PitCommand
  • .TelemCommand
  • .CamFocusAt

IrSdkConsts.BroadcastMsg

Available command messages.

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.CameraState

Camera state Camera state is bitfield; use these values to compose a new state.

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.RpyPosMode

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.RpySrchMode

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.RpyStateMode

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.ReloadTexturesMode

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.ChatCommand

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.PitCommand

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.TelemCommand

Kind: static enum of IrSdkConsts
Properties

IrSdkConsts.CamFocusAt

When switching camera, these can be used instead of car number / position

Kind: static enum of IrSdkConsts
Properties

Development

To develop node-irsdk itself, you need working working installation of node-gyp.

Useful commands:

• npm install builds binary addon
• npm run ready runs tests and updates docs

Making a new release

1. Check if license file needs updating
2. npm run ready
3. Tag new version using npm version, push to Github
4. Wait for Appveyor to upload binaries
5. npm publish
6. Add release notes to Github, helper npm run release-notes.

License

Released under the MIT License.

Credits

Parts of original irsdk used, license available here: https://github.com/apihlaja/node-irsdk/blob/master/src/cpp/irsdk/irsdk_defines.h (BSD-3-Clause)