SVappsLAB.iRacingTelemetrySDK 0.6.3

iRacingTelemetrySDK

iRacingTelemetrySDK is a .Net SDK tailored for C# developers aiming to incorporate telemetry data from the iRacing simulator into their software projects.

Features

• Live Telemetry Data: facilitates easy retrieval of telemetry information generated during iRacing sessions, including vehicle speed, engine RPM, tire temperatures, and more.

• Playback of saved IBT Telemetry Data: In addition to live data access, the SDK can read previously saved iRacing IBT files and play them back as if it were live data, using the same API. This allows you to analyze and process historical telemetry data, the same way you would with live data.

• Optimized Performance: The SDK uses techniques such as asynchronous Task's, ref struct's and ReadOnlySpan's to minimize memory allocations and maximize performance. When processing IBT files for example, the SDK is able to process 1 hour of saved telemetry data in under 1/2 second. A rate of over 300,000 telemetry records/sec.

• Strongly Typed Telemetry Data: Source Generation is used to create a strongly typed TelemetryData struct, with the iRacing variables you choose.

Telemetry Variables

The iRacing simulator produces extensive telemetry data. This SDK allows you to select the variables to track in your program and generates a strongly-typed TelemetryData struct with those variables.

Availability

iRacing outputs different variables depending on the context. Some variables available in live sessions might not be available in offline IBT files, and vice versa.

To check variable availability, use the ./Samples/DumpVariables_DumpSessionInfo utility. This will generate a CSV file listing available variables and a YAML file with complete session info.

Once you know what variables are available and you have the list of which ones you want to use, you're ready to start using the SDK.

Getting Started

To incorporate iRacingTelemetrySDK into your projects, follow these steps:

1. Install the Package: Add the iRacingTelemetrySDK NuGet package to your project using your preferred package manager.

   dotnet add package SVappsLAB.iRacingTelemetrySDK
   

2. Add the RequiredTelemetryVars attribute to the main class of your project

   The attribute takes an array of strings. The string values, are the name of the iRacing variables you want to use in your program.

   // these are the telemetry variables we want to track
   [RequiredTelemetryVars(["gear", "isOnTrackCar", "rpm", "speed"])]
   
   internal class Program
   {
     ...
   }
   

   A source generator will be leveraged to create a new .Net TelemetryData type you can use in your code. For the attribute above, the created type will look like

   public record struct TelemetryData(Int32 Gear,Boolean IsOnTrackCar,Single RPM,Single Speed);
   

3. Create an instance of the TelemetryClient

   The TelemetryClient runs in one of two modes: Live or IBT file playback.

   For live telemetry, you only need to provide a logger.

    // live telemetry
    using var tc = TelemetryClient<TelemetryData>.Create(logger);
   

   For IBT playback, provide the path to the IBT file and an optional playback speed multiplier. The speed multiplier will speed up or slow down the playback of the IBT file.<br/> A speed of 1 will play the IBT file at the normal speed iRacing output the file (60 records/sec). A speed of 20 will playback the file at 20x speed (20*60=1200 records/rec).<br/> To play the file at maximum speed, use int.MaxValue as the multiplier value.

    // process the IBT file at 10x speed
   var ibtOptions = new IBTOptions(@"C:\path\to\file.ibt", 10);
    using var tc = TelemetryClient<TelemetryData>.Create(logger, ibtOptions);
   

4. Add an event handler

   The event handler will be called with the latest telemetry data.

   // event handler
   void OnTelemetryUpdate(object? _sender, TelemetryData e)
   {
       // do something with the telemetry data
       logger.LogInformation("gear: {gear}, rpm: {rpm}, speed: {speed}", e.Gear, e.RPM, e.Speed);
   }
   

5. Monitor for telemetry data changes

   Once monitoring is initiated, the events will fire and your event handlers will be called.<br> Monitoring is stopped, when the CancellationToken is cancelled, or the when the end-of-file is reached when processing a IBT file.

   CancellationTokenSource cts = new new CancellationTokenSource();
   
   // start monitoring the telemetry
   await tc.Monitor(cts.Token);
   

Samples

See ./Samples/README.md for a list of example projects using the SDK

Event Sequence Diagram

The following shows how the events are

sequenceDiagram
    participant C as Client
    create participant S as SDK

    C--)S: created
    C->>S: startup()
 
    create participant R as monitoring telemetry
    S--)R: 
    note over R: events start to fire
    activate R
    R-->>C: EVENT: "connected"
 
    loop sessionInfo
        note right of S: when sessionInfo changes
        R-->>C: EVENT: "sessionInfo"
    end
 
    loop telemetry
        note right of S: when telemetry updates
        R-->>C: EVENT: "telemetry"
    end
 
    R-->C: EVENT: "disconnected"
    C->>S: shutdown()
    deactivate R
    note over R: events stop
    destroy R
 
    R--)S: 
    destroy S
    C--)S: destroyed

License

This project is licensed under the Apache License. Refer to the LICENSE file for details.