ir_telemetry 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ef0d8e19ef07ebde17c382070101cfb4ee0c1fdcde2c5eca90142015081ce10
+  data.tar.gz: 4f8153e93f0fee0b77311dddf5f4091c0b00f14d29842fff75dfe56fcbfba59c
+SHA512:
+  metadata.gz: 1492a7732612f22293c2c93d791a036b4845c9a8657f7ba900b68b762a7b874e0abfa16f0262ab005317cded94c18fa114483d2428a6ee59b040cb82ecd154e8
+  data.tar.gz: 76cd07bc6873df019c13baaaff59595c1afe181b63867be6725f1b074fcb40c1a7ef0e30bdf372c3a36ab9e59c2171cc75c257c0efc36bf3d721fa8241e890be

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.2.0] - 2023-05-30
+
+- Add dataset iteration 
+- Add test workflow 
+- Add Session string parsing
+
+## [0.1.0] - 2023-05-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ir_telemetry.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    ir_telemetry (0.2.0)
+      bindata (~> 2.4)
+      zeitwerk (~> 2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bindata (2.4.15)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.28.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  ir_telemetry!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,106 @@
+[![CI](https://github.com/virolea/ir_telemetry/actions/workflows/ci.yml/badge.svg)](https://github.com/virolea/ir_telemetry/actions/workflows/ci.yml)
+
+# iRacing Telemetry
+
+Parse and browse iRacing telemetry files with Ruby.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ir_telemetry
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ir_telemetry
+
+## Usage
+
+### Quick start
+
+```ruby
+ibt_filepath = "/path/to/telemetry/file.ibt"
+
+IRTelemetry::IBTFile.open(ibt_filepath) do |file|
+  # access session information hash 
+  session_info = file.session_info  
+  session_info['WeekendInfo']['TrackName'] # => e.g. jerez gp
+  
+  # access telemetry data
+  file.dataset.each do |data_point|
+    data_point["Speed"] # => e.g. 2432.65
+    data_point["Lap"] # => 4
+  end
+end
+```
+
+The above code is a shorthand for: 
+
+```ruby
+ibt_filepath = "/path/to/telemetry/file.ibt"
+
+ibt_file = IRTelemetry::IBTFile.new(ibt_filepath)
+
+session_info = ibt_file.session_info
+session_info["WeekendInfo"""]["'"TrackName"] # => e.g. jerez gp
+
+ibt_file.dataset.each do |data_point|
+  data_point["Speed"] # => e.g. 2432.65
+  data_point["Lap"] # => 4
+end
+
+# close the io stream
+ibt_file.close
+```
+
+### Session information
+
+The session information is accessible through the `IBTFile` object instance. It is a Hash loaded from the session YAML which schema can be found in the Appendix B of the [telemetry docs](docs/telemetry_11_23_15.pdf).
+
+```ruby
+ibt_filepath = "/path/to/telemetry/file.ibt"
+
+ibt_file = IRTelemetry::IBTFile.new(ibt_filepath)
+
+# Session info is a plain Ruby Hash.
+session_info = ibt_file.session_info
+session_info["WeekendInfo"]["TrackName"]
+```
+
+### Telemetry data
+
+The telemetry data is accessible through the `IBTFile` object instance. It is a `Dataset` object which is an `Enumerable` of `DataPoint` objects. You can then access telemetry variables on the datapoint by calling `[]` on it. For a complete list of available variables, see the Appendix A of the [telemetry docs](docs/telemetry_11_23_15.pdf)
+
+```ruby
+ibt_filepath = "/path/to/telemetry/file.ibt"
+
+ibt_file = IRTelemetry::IBTFile.new(ibt_filepath)
+
+# Telemetry data is a Dataset object
+dataset = ibt_file.dataset
+```
+
+#### Iterating over available data 
+
+```ruby
+dataset.each do |data_point|
+  puts data_point["Speed"]
+end
+```
+
+#### Accessing a data point at a particular index 
+    
+```ruby
+puts dataset[0]["Speed"]
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ir_telemetry.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/ir_telemetry/data_point.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module IRTelemetry
+  class DataPoint
+    VAR_TYPES_MAPPING = {
+      1 => {
+        size: 1,
+        type: :irsdk_bool,
+        handler: BinData::Bit8
+      },
+      2 => {
+        size: 4,
+        type: :irsdk_int,
+        handler: BinData::Int32le
+      },
+      3 => {
+        size: 4,
+        type: :irsdk_bit_field,
+        handler: BinData::Int32le
+      },
+      4 => {
+        size: 4,
+        type: :irsdk_float,
+        handler: BinData::FloatLe
+      },
+      5 => {
+        size: 8,
+        type: :irsdk_double,
+        handler: BinData::DoubleLe
+      }
+    }.freeze
+
+    def initialize(buffer, dataset)
+      @buffer = buffer
+      @dataset = dataset
+    end
+
+    def [](variable_name)
+      variable = @dataset.variables[variable_name]
+      type = VAR_TYPES_MAPPING[variable.var_type]
+
+      type[:handler].read(
+        @buffer.byteslice(variable.offset, type[:size])
+      )
+    end
+  end
+end

data/lib/ir_telemetry/dataset.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module IRTelemetry
+  class Dataset
+    extend Forwardable
+    include Enumerable
+
+    attr_reader :variables
+
+    def_delegators :@file, :header, :io
+
+    def initialize(file)
+      @file = file
+      @variables = set_variables
+    end
+
+    def [](index)
+      io.seek(buffer_offset + index * buffer_length)
+
+      buffer = io.read(buffer_length)
+      DataPoint.new(buffer, self)
+    end
+
+    def each(&block)
+      start_at_the_beginning
+
+      while (buffer = io.read(buffer_length))
+        data_point = DataPoint.new(buffer, self)
+
+        yield data_point if block
+      end
+    end
+
+    private
+
+    def set_variables
+      io.seek(header.var_header_offset)
+
+      var_buffer = io.read(IBTFile::IRSDK_VAR_HEADER_SIZE * header.num_vars)
+
+      variables = {}
+
+      (0...header.num_vars - 1).each do |i|
+        irsdk_var = Headers::IRSDKVarHeader.read(
+          var_buffer.byteslice(i * IBTFile::IRSDK_VAR_HEADER_SIZE, IBTFile::IRSDK_VAR_HEADER_SIZE)
+        )
+
+        variables[irsdk_var.name.to_s] = irsdk_var
+      end
+
+      variables
+    end
+
+    def start_at_the_beginning
+      io.seek(buffer_offset)
+    end
+
+    def buffer_offset
+      header.var_buf[0].buf_offset
+    end
+
+    def buffer_length
+      header.buf_len
+    end
+  end
+end

data/lib/ir_telemetry/headers/irsdk_header.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module IRTelemetry
+  class Headers::IRSDKHeader < BinData::Record
+    IRSDK_MAX_BUFS = 4
+
+    endian :little
+
+    int32 :version
+    int32 :status
+    int32 :tick_rate
+
+    int32 :session_info_update
+    int32 :session_info_len
+    int32 :session_info_offset
+
+    int32 :num_vars
+    int32 :var_header_offset
+
+    int32 :num_buf
+    int32 :buf_len
+    array :pad, type: :int32, initial_length: 2
+
+    array :var_buf, initial_length: IRSDK_MAX_BUFS do
+      endian :little
+
+      int32 :tick_count
+      int32 :buf_offset
+      array :pad, type: :int32, initial_length: 2
+    end
+  end
+end

data/lib/ir_telemetry/headers/irsdk_var_header.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module IRTelemetry
+  class Headers::IRSDKVarHeader < BinData::Record
+    endian :little
+
+    int32 :var_type
+    int32 :offset
+    int32 :var_count
+
+    bit8 :count_as_time
+    string :pad, length: 3
+
+    string :name, length: IBTFile::IRSDK_MAX_STRING, trim_padding: true
+    string :desc, length: IBTFile::IRSDK_MAX_DESC, trim_padding: true
+    string :unit, length: IBTFile::IRSDK_MAX_STRING, trim_padding: true
+  end
+end

data/lib/ir_telemetry/ibt_file.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "date"
+
+module IRTelemetry
+  class IBTFile
+    attr_reader :header, :io
+
+    IRSDK_HEADER_SIZE = 112
+    IRSDK_VAR_HEADER_SIZE = 144
+
+    IRSDK_MAX_STRING = 32
+    IRSDK_MAX_DESC = 64
+
+    IBT_FILE_ENCODING = "Windows-1252"
+
+    class << self
+      def open(filepath, &block)
+        io = new(filepath)
+        block.call(io)
+      ensure
+        io&.close
+      end
+    end
+
+    def initialize(filepath)
+      @io = File.open(filepath, "rb")
+      @header = Headers::IRSDKHeader.read(@io)
+    end
+
+    def close
+      @io.close
+    end
+
+    def session_info
+      @io.seek(@header.session_info_offset)
+      session_string = @io.read(@header.session_info_len)
+      session_string.force_encoding(IBT_FILE_ENCODING)
+      session_string.encode("UTF-8")
+
+      YAML.safe_load(session_string, permitted_classes: [Date])
+    end
+
+    def dataset
+      @dataset ||= Dataset.new(self)
+    end
+  end
+end

data/lib/ir_telemetry/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IRTelemetry
+  VERSION = "0.2.0"
+end

data/lib/ir_telemetry.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "bindata"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "ir_telemetry" => "IRTelemetry"
+loader.inflector.inflect "ibt_file" => "IBTFile"
+loader.inflector.inflect "irsdk_header" => "IRSDKHeader"
+loader.inflector.inflect "irsdk_var_header" => "IRSDKVarHeader"
+loader.setup
+
+module IRTelemetry
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ir_telemetry
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Vincent Rolea
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Parse and browse iRacing telemetry files with Ruby.
+email:
+- low.salt3234@fastmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/ir_telemetry.rb
+- lib/ir_telemetry/data_point.rb
+- lib/ir_telemetry/dataset.rb
+- lib/ir_telemetry/headers/irsdk_header.rb
+- lib/ir_telemetry/headers/irsdk_var_header.rb
+- lib/ir_telemetry/ibt_file.rb
+- lib/ir_telemetry/version.rb
+homepage: https://github.com/virolea/ir_telemetry
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/virolea/ir_telemetry
+  source_code_uri: https://github.com/virolea/ir_telemetry
+  changelog_uri: https://github.com/virolea/ir_telemetry/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Parse and browse iRacing telemetry files with Ruby.
+test_files: []