apihlaja / node-irsdk Goto Github PK

Is this normal behavior or should be updated in each SessionInfo update ?
Tx

A question really. I've been writing some code using node-irsdk and electron for the past two weeks.
One thing I have been struggling is that I always manage to lose the first SessionInfo data after hooking the listerner to my browserwindow. Any tip on that?

I was looking though the telemetry event and noticed that latitude and longitude were not available. Is this because these values are not provided by iRacing themselves? Or is this value omitted from the exposed telemetry event? If these values cannot be included due to restrictions on iRacing's side, then are there any other type of coordinate systems that can be exposed?

I am aware that the current library/iRacing exposes the distance along the track since the starting line, but I am looking for something that provides a more detailed, raw, position of the vehicle.

Is it possible to install this repo also on macOS and develop everything there? Or is Windows mandatory? I get this error when installing with npm on macOS:

prebuild-install WARN install No prebuilt binaries found (target=12.10.0 runtime=node arch=x64 libc= platform=darwin)
  CXX(target) Release/obj.target/IrSdkNodeBindings/src/cpp/IrSdkNodeBindings.o
../src/cpp/IrSdkNodeBindings.cpp:1:12: warning: #pragma once in main file [-Wpragma-once-outside-header]
<U+FEFF>#pragma once
                ^
In file included from ../src/cpp/IrSdkNodeBindings.cpp:3:
In file included from ../src/cpp/IRSDKWrapper.h:3:
../src/cpp/irsdk/irsdk_defines.h:84:10: fatal error: 'tchar.h' file not found
#include <tchar.h>
         ^~~~~~~~~
1 warning and 1 error generated.
make: *** [Release/obj.target/IrSdkNodeBindings/src/cpp/IrSdkNodeBindings.o] Error 1
gyp ERR! build error 
gyp ERR! stack Error: `make` failed with exit code: 2
gyp ERR! stack     at ChildProcess.onExit (/usr/local/lib/node_modules/npm/node_modules/node-gyp/lib/build.js:196:23)
gyp ERR! stack     at ChildProcess.emit (events.js:209:13)
gyp ERR! stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:272:12)
gyp ERR! System Darwin 18.7.0
gyp ERR! command "/usr/local/bin/node" "/usr/local/lib/node_modules/npm/node_modules/node-gyp/bin/node-gyp.js" "rebuild"
gyp ERR! cwd /Users/username/Documents/Github/iracing/node_modules/node-irsdk
gyp ERR! node -v v12.10.0
gyp ERR! node-gyp -v v5.0.3
gyp ERR! not ok 
npm WARN [email protected] No description
npm WARN [email protected] No repository field.

npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] install: `prebuild-install || node-gyp rebuild`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] install script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

I have XCode and Command Line Tools installed. Running node v12.10.0 and npm v6.10.3 …

Hi guys,

it took some time for me to figure out how to create a vuejs based electron app with node-irsdk support. I hope it's ok to leave a step by step guide here, even though it's not an issue. I wasn't sure where to put it else and thought maybe it's worth the write.

npm install -g @vue/cli

vue create myapp

cd into your app

vue add electron-builder
Latest version as of writing is electron 11

npm install --save https://github.com/sabifa/node-irsdk
I selected this fork, as it already fixed the import of the compiled source. If there is any better out there, let me know.

npm install --save-dev electron-rebuild

.\node-modules\.bin\electron-rebuild.cmd
This will rebuild the node-irsdk to be compatible with the electron version you selected - at least on windows.

Add a vue.config.js file to your project root with the following content

module.exports = {
    pluginOptions: {
        electronBuilder: {
            externals: ['node-irsdk'],
            nodeIntegration: true
        }
    }
}

This was the most crucial part to figure out - at least for me.

Now you can run your node-irsdk code in background.js as you would in every other electron app.

....
import * as irsdk from 'node-irsdk'
....
const iracing = irsdk.init({telemetryUpdateInterval: 500, sessionInfoUpdateInterval: 2000})
iracing.on('Connected', function() {
  console.log('iRacing connected..')
})
iracing.on('Disconnected', function() {
  console.log('iRacing disconnected..')
})

*edit: as this is way outdated and as of 30/12/2022 I couldn't get a solution with existing forks, I tried to come up with my own solution. So, if you want to give it a try, you can find it here.

I have been thinking about providing pre-build binaries. Without prebuild-ci, it would have been pretty complicated. And I found the module only yesterday. Apparently it have been there for 2 years. Doh.

Pre-build binaries would mean that node-irsdk can be used without node-gyp: no need to go thru this to get started. Much easier..

So, that's on todo-list now. I´ll work on it soon™.

Other thing holding back this, is to figure out Node.js ABI versioning..

package.json should have os: win32 and arch: x64 defined. Then it's possible to define this as optional dependency in your project. And maybe npm gives more meaning full error messages in other situations as well.

First of all, thanks for making this.

But it seems that special chars like é, ä etc. are not encoded corretly in the sessioninfo. I get driver names with unreadable chars. I've backtracked the sessioninfo and the call to IrSdkWrapper.getSessionInfo() in JsIrSdk.js doesn't return a propper utf8 encoded yaml string.

It seems Node.js have new API for native addons, should take a look if it makes sense to port: https://github.com/nodejs/node-addon-api

package.json has only node.js version defined at the moment. But Electron binaries are available too. Should figure out which versions of Electron actually work.

Hey, I recently got everything working with node-irsdk in electron. So far, so good. I first thought I set up my computer somewhat wrong (wrong MSVS version, missing an SDK, or so) but it seems to be another problem.

I have the reproducable error that happens when iRacing hasn't been started once on the machine.

The iRacing service is running after a fresh start / reboot, but the app immediately crashes without a stack trace or message and with exit status 3221225477.

After starting iRacing once, this issue doesn't occur anymore. I can even close iRacing and the app will start (but receive no data).

My wild guess: could it be that trying to access the shared memory map file (which doesn't exist if the sim hasn't been started at least once) let the library fail?

I've seen that Kutu does a little check on a local webserver whether the sim is running or not and only accesses the file if it is running. Maybe you could address this issue the same?

• https://github.com/kutu/pyirsdk/blob/master/irsdk.py#L19
• https://github.com/kutu/pyirsdk/blob/master/irsdk.py#L378

My C/C#/C++/Whatever skills are too bad thus I can't fix that myself :(

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

The dependency prebuild-install was updated from 5.3.3 to 5.3.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

prebuild-install is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

v1.1.1 had all other commands, except FFBCommand.

The implementation actually exist: https://github.com/apihlaja/node-irsdk/compare/feature/ffb-cmd?expand=1

The problem is, I have no idea what the command is supposed to do. If I cant come up with use-case, I cant test it and I don't release untested code. So.. if you actually need such command, poke me.

Hi,

First of all let me thank you for your awesome work, it's brilliant!

I have a question regarding incidents, is there a way to gather the number of incidents for each car?

Regards,

Jean-Philippe.

It's same problem as #4 and I have fix ready too but I haven't tested it yet.

Any ideas on how to get this to compile?

I installed node-gyp as well. no luck

Can you provide an example for sending commands such as initiating replays, changing the camera, etc?

The dependency prebuild-install was updated from 5.2.4 to 5.2.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

prebuild-install is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

• development dependencies are mess
  • figure out working versions
  • reduce deps, use Jest?
• update Node.js / Electron support details (active LTS-versions for now?)

I'm trying to install the modules. I tried by installing with the command, with and without the --save param and also tried including the module as a dependency in my package.json, but none of the options worked.
I installed the latest versions of python and visual studio but i still get this error:

npm ERR! File "binding.gyp", line 1 npm ERR! \ufeff{ npm ERR! ^ npm ERR! SyntaxError: invalid non-printable character U+FEFF

What should I do to install it?
Thanks for any info

Version 3.3.0 of mocha just got published.

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Your Greenkeeper Bot 🌴

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

The dependency js-yaml was updated from 3.13.1 to 3.14.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

js-yaml is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

When trying to install on Node v14, the build process errors.

> [email protected] install C:\Users\jacen\Documents\kandagawa\node_modules\node-irsdk
> prebuild-install || node-gyp rebuild

prebuild-install WARN install No prebuilt binaries found (target=14.15.1 runtime=node arch=x64 libc= platform=win32)

C:\Users\jacen\Documents\kandagawa\node_modules\node-irsdk>if not defined npm_config_node_gyp (node "C:\Program Files\nodejs\node_modules\npm\node_modules\npm-lifecycle\node-gyp-bin\\..\..\node_modules\node-gyp\bin\node-gyp.js" rebuild )  else (node "C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\bin\node-gyp.js" rebuild )
Building the projects in this solution one at a time. To enable parallel build, please add the "/m" switch.
  IrSdkNodeBindings.cpp
  IrSdkCommand.cpp
  IRSDKWrapper.cpp
  IrSdkBindingHelpers.cpp
  win_delay_load_hook.cc
c:\users\jacen\documents\kandagawa\node_modules\node-irsdk\src\cpp\irsdknodebindings.h(39): warning C4996: 'node::AtExi
t': was declared deprecated (compiling source file ..\src\cpp\IrSdkNodeBindings.cpp) [C:\Users\jacen\Documents\kandagaw
a\node_modules\node-irsdk\build\IrSdkNodeBindings.vcxproj]
  c:\users\jacen\appdata\local\node-gyp\cache\14.15.1\include\node\node.h(852): note: see declaration of 'node::AtExit'
   (compiling source file ..\src\cpp\IrSdkNodeBindings.cpp)
c:\users\jacen\documents\kandagawa\node_modules\node-irsdk\src\cpp\irsdkbindinghelpers.cpp(52): error C2661: 'v8::Objec
t::Set': no overloaded function takes 2 arguments [C:\Users\jacen\Documents\kandagawa\node_modules\node-irsdk\build\IrS
dkNodeBindings.vcxproj]
gyp ERR! build error
gyp ERR! stack Error: `C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\MSBuild\15.0\Bin\MSBuild.exe` failed with exit code: 1
gyp ERR! stack     at ChildProcess.onExit (C:\Program Files\nodejs\node_modules\npm\node_modules\node-gyp\lib\build.js:194:23)
gyp ERR! stack     at ChildProcess.emit (events.js:315:20)
gyp ERR! stack     at Process.ChildProcess._handle.onexit (internal/child_process.js:277:12)
gyp ERR! System Windows_NT 10.0.18363
gyp ERR! command "C:\\Program Files\\nodejs\\node.exe" "C:\\Program Files\\nodejs\\node_modules\\npm\\node_modules\\node-gyp\\bin\\node-gyp.js" "rebuild"
gyp ERR! cwd C:\Users\jacen\Documents\kandagawa\node_modules\node-irsdk
gyp ERR! node -v v14.15.1
gyp ERR! node-gyp -v v5.1.0
gyp ERR! not ok
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] install: `prebuild-install || node-gyp rebuild`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] install script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\jacen\AppData\Roaming\npm-cache\_logs\2020-11-30T00_37_05_432Z-debug.log

I tested on a fresh Windows installation, and the build process completes without issue on Node v8, but errors once upgraded to Node v14.

At the moment, each data update have a little bit different payload. I think I'll add new update event which uses same structure for all events, something like:

{
  timestamp: new Date(),
  type: 'Disconnected',
  data: null
}

Version 2.19.2 of moment was just published.

This version is covered by your current version range and after updating it in your project the build failed.

moment is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

I'm a bit of a noob so this may be a basic question. I've been trying to get this installed, and I am unable to troubleshoot this warning when doing npm i node-irsdk

npm WARN install Usage of the --dev option is deprecated. Use --include=dev instead.
npm ERR! code 1
npm ERR! path C:\Users\Nick\Desktop\irtest\node_modules\node-irsdk
npm ERR! command failed
npm ERR! command C:\Windows\system32\cmd.exe /d /s /c prebuild-install || node-gyp rebuild
npm ERR! gyp info it worked if it ends with ok
npm ERR! gyp info using [email protected]
npm ERR! gyp info using [email protected] | win32 | x64
npm ERR! gyp info find Python using Python version 3.9.6 found at "C:\Users\Nick\AppData\Local\Programs\Python\Python39\python.exe"
npm ERR! gyp info find VS using VS2017 (15.9.28307.1759) found at:
npm ERR! gyp info find VS "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools"
npm ERR! gyp info find VS run with --verbose for detailed information
npm ERR! gyp info spawn C:\Users\Nick\AppData\Local\Programs\Python\Python39\python.exe
npm ERR! gyp info spawn args [
npm ERR! gyp info spawn args 'C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\gyp_main.py',
npm ERR! gyp info spawn args 'binding.gyp',
npm ERR! gyp info spawn args '-f',
npm ERR! gyp info spawn args 'msvs',
npm ERR! gyp info spawn args '-I',
npm ERR! gyp info spawn args 'C:\Users\Nick\Desktop\irtest\node_modules\node-irsdk\build\config.gypi',
npm ERR! gyp info spawn args '-I',
npm ERR! gyp info spawn args 'C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\addon.gypi',
npm ERR! gyp info spawn args '-I',
npm ERR! gyp info spawn args 'C:\Users\Nick\AppData\Local\node-gyp\Cache\16.13.1\include\node\common.gypi',
npm ERR! gyp info spawn args '-Dlibrary=shared_library',
npm ERR! gyp info spawn args '-Dvisibility=default',
npm ERR! gyp info spawn args '-Dnode_root_dir=C:\Users\Nick\AppData\Local\node-gyp\Cache\16.13.1',
npm ERR! gyp info spawn args '-Dnode_gyp_dir=C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp',
npm ERR! gyp info spawn args '-Dnode_lib_file=C:\\Users\\Nick\\AppData\\Local\\node-gyp\\Cache\\16.13.1\\<(target_arch)\\node.lib',
npm ERR! gyp info spawn args '-Dmodule_root_dir=C:\Users\Nick\Desktop\irtest\node_modules\node-irsdk',
npm ERR! gyp info spawn args '-Dnode_engine=v8',
npm ERR! gyp info spawn args '--depth=.',
npm ERR! gyp info spawn args '--no-parallel',
npm ERR! gyp info spawn args '--generator-output',
npm ERR! gyp info spawn args 'C:\Users\Nick\Desktop\irtest\node_modules\node-irsdk\build',
npm ERR! gyp info spawn args '-Goutput_dir=.'
npm ERR! gyp info spawn args ]
npm ERR! Traceback (most recent call last):
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\gyp_main.py", line 45, in
npm ERR! sys.exit(gyp.script_main())
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp_init_.py", line 662, in script_mainnpm ERR! return main(sys.argv[1:])
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp_init_.py", line 654, in main
npm ERR! return gyp_main(args)
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp_init_.py", line 621, in gyp_main
npm ERR! [generator, flat_list, targets, data] = Load(
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp_init_.py", line 142, in Load
npm ERR! result = gyp.input.Load(
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp\input.py", line 3009, in Load
npm ERR! LoadTargetBuildFile(
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp\input.py", line 400, in LoadTargetBuildFile
npm ERR! build_file_data = LoadOneBuildFile(
npm ERR! File "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\gyp\pylib\gyp\input.py", line 237, in LoadOneBuildFile
npm ERR! build_file_data = eval(build_file_contents, {"builtins": {}}, None)
npm ERR! File "binding.gyp", line 1
npm ERR! \ufeff{
npm ERR! ^
npm ERR! SyntaxError: invalid non-printable character U+FEFF
npm ERR! gyp ERR! configure error
npm ERR! gyp ERR! stack Error: gyp failed with exit code: 1
npm ERR! gyp ERR! stack at ChildProcess.onCpExit (C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\lib\configure.js:259:16)
npm ERR! gyp ERR! stack at ChildProcess.emit (node:events:390:28)
npm ERR! gyp ERR! stack at Process.ChildProcess._handle.onexit (node:internal/child_process:290:12)
npm ERR! gyp ERR! System Windows_NT 10.0.19042
npm ERR! gyp ERR! command "C:\Program Files\nodejs\node.exe" "C:\Users\Nick\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\bin\node-gyp.js" "rebuild"
npm ERR! gyp ERR! cwd C:\Users\Nick\Desktop\irtest\node_modules\node-irsdk
npm ERR! gyp ERR! node -v v16.13.1
npm ERR! gyp ERR! node-gyp -v v8.4.1
npm ERR! gyp ERR! not ok

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\Nick\AppData\Local\npm-cache_logs\2022-01-02T01_49_11_284Z-debug-0.log

Thank you for any insight!

I'd assume this is issue still: patrickmoore/Mu#3 (comment)

I guess it's yet another unescaped string, should take a look.

node-irsdk uses YAML parser for session info but session info is not following YAML spec strictly. Thus there is random issues.

Only issue Im aware of at the moment is team names, for example: output and input. Part of team name is missing because # is comment character in Yaml. There may be some other glitches too.

Also, ' in driver and team names are simply replaced by . Thats done by iRacing, thus its impossible match names you see on screen in iRacing.

During a session, the tyre temps are not updated on the fly like the engine RPMs

EnergyMGU_KLapDeployPct
EnergyBatteryToMGU_KLap
EnergyERSBatteryPct

these values are not yet ported to this library.

I recently discovered that my Electron app starts hanging (doesn't respond anymore) when I switch for Practice to Race in game (it doesn't happend when I close iRacing and click on "Join" in the browser to join the race). I also don't get any error messages, the IRSDK seems to get a hiccup.

Since my software hangs, I have no debug trace or something alike. Its also hard to test because you have to join a Race and risk losing SR/IR if you only join to test that behavior :-/

The devDependency sinon was updated from 7.4.1 to 7.4.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

sinon is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Hi there!

I'm very extremely happy to have this package open sourced.
It would be great if we developers could contribute to your project, but unfortunately there is no description about how to set up a development environment, and how to compile everything to check if things are working properly.

For example I'm having problems with node version, because in some c headers there is still the old node reference and so it cannot be used with other version of nodes.

Would be great if you can extend the readme for some developer support! I'd love to join and help you out.

The licence color value returning in a format that I couldn't figure out how to get a color out of it.
Licence colors as we have now:
87003
50946
16706564

How i suppose to convert these to actual colors?

I am trying to get info about current positions and deltas from a replay.
I have this code running:
`iracing.on('Telemetry', function (data) {
console.log('got Telemetry')

for(var i = 0;i<drivers.length;i++){
    var driver = drivers[i];
    //console.log(driver.UserName + " Num: " + driver.CarNumber + " Idx " + driver.CarIdx);
}

var tel = data.values;
//console.log(tel);


var carPositions = tel.CarIdxPosition;
var delta = tel.CarIdxF2Time;


for(var i =1;i<carPositions.length;i++){
    if(carPositions[i] != 0){
        var driver = drivers[carPositions[i]];
        console.log(driver.UserName + " Delta: " + delta[i-1]);
    }
}
console.log("----------------------------------------------------");

})`

The update interval is set to 1000 so every second it outputs the data however I notice it's always the same.
Only when the leader crosses the line, the data is updated.

Version 3.0.1 of jsdoc-to-markdown was just published.

This version is covered by your current version range and after updating it in your project the build failed.

jsdoc-to-markdown is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

js-irsdk: yaml error:
YAMLException: the stream contains non-printable characters at line 822, column 29:
UserName: Emircan Co�kun
^
(anonymous) @ JsIrSdk.js:421
processImmediate @ internal/timers.js:439
JsIrSdk.js:421