Expand description

iracing-telem is a rust port of the iRacing provided c++ SDK.

It allows for access to telemetetry data from a running instance of the iRacing simulator As well as the ability to send certain control messages to the simulator (e.g to change Pitstop settings)

The iRacing data is exposed through a memory mapped file. Because of this, and the potential issue for the data to not be in the expected locations almost all methods are marked as unsafe.

Details of the c++ SDK are available on the iRacing forums. Note you will need an active iRacing subsription to access these.

https://forums.iracing.com/discussion/62/iracing-sdk

Modules

flags contains definitions for the Bitfield and Enum values that are returned as variable values.

Structs

Client is main entry point into the library. Create a client and then you can access Sessions that have the telemetry data in then.

A Session is used to access data from iRacing.

Var is a handle to a variable or telemetry data point.

Enums

The outcome of trying to read a row of telemetery data.

These errors can be returned when accessing variable values and there is a mismatch between the type of the variable, and the type of value asked for.

An instance of a value for a variable.

The different types of variables or datapoints available.

Constants

define markers for unlimited session laps

define markers for unlimited session time (in seconds)