Parse EngineWarnings

.gitignore

@@ -1,2 +1,2 @@
-coverage*
+coverage*
-*.txt
+*.txt

Makefile

@@ -1,3 +1,3 @@
-test:
+test:
-	go test -coverprofile=coverage.out ./... -cover -bench=
+	go test -coverprofile=coverage.out ./... -cover -bench=
-	go tool cover -html=coverage.out -o coverage.html
+	go tool cover -html=coverage.out -o coverage.html

README.md

@@ -1,17 +1,118 @@
-# About
+# TODO
-This project will be able to parse `.ibt` files, read live data from races and
+- [x] Read live telemetry (from a live session or replay)
-broadcast messages to the service. Its still not very mature at all, but after
+- [x] Read data from a stored `.ibt` file
-this commit I will turn it into a package instead and give it a stable API.
+- [x] Allow to export the data to an `.ibt` file
-Will also put some examples then.
+- [x] Allow to export the session info data to a `.yaml` file
-
+- [ ] Make sure variables with multiple counts are correctly parsed and stored
-
+- [ ] Correctly support and implement the bitFields data
-## The SDK
+- [ ] Add the message broadcasting system
-I used various sources to develop and understand how `iRacing` works, and learn
+- [ ] Explore a more convenient API for fetching the data for the SDK user
-a lot with it. Once I have matured this project a bit I will document its
+- [ ] Change the pattern in which the data is fetched from the telemetry and
-inner workings too.
+how it is exported into `.ibt` files
-
+
-
+
-## SharedMem
+# About
-I vendored in the code from [hidez8891/shm](https://github.com/hidez8891/shm) 
+This project is a simple Go SDK for the popular iRacing racing simulator.
-since the repo has been archived. I took the opportunity to update some of its
+It has the capabilites to:
-code.
+- Read live data (live session or replay)
+- Read data from a `.ibt` telemetry file
+
+It should run on Linux, MacOS and Windows. With the caveat that live sessions
+only happen on Windows (that I know about), therefore Linux and MacOS can only
+read data from telemetry files.
+
+
+## Usage
+The SDK instance is created by calling `goirsdk.Init(Reader, exportTelem, exportYAML)`
+- `Reader` is a variable that implements the interface:
+```go
+type Reader interface {
+	io.Reader
+	io.ReaderAt
+	io.ReadCloser
+}
+```
+To read data from a `.ibt` file, the user should pass the `*os.File` of it, and
+to read live telemetry the user should pass nil
+
+- `exportTelem` should be an empty string if the user doesn't want to export
+the data, otherwise pass a string with the path for the destination telemetry
+file
+
+- `exportYAML` is just like the exportTelem but for the session info `yaml` data
+
+### Example
+```go
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"time"
+
+	"github.com/ESilva15/goirsdk"
+)
+
+func msToKph(v float32) int {
+	return int((3600 * v) / 1000)
+}
+
+func main() {
+	// Open the data source file
+	file, err := os.Open("/path/to/ibtFile")
+	if err != nil {
+		log.Fatalf("Failed to open IBT file: %v", err)
+	}
+
+	// Instantiate our iRacing SDK instance
+	irsdk, err := goirsdk.Init(file, "", "")
+	if err != nil {
+		log.Fatalf("Failed to create iRacing interface: %v", err)
+	}
+	defer irsdk.Close()
+
+	// Set up a loop to iterate our data
+	mainLoopTicker := time.NewTicker(time.Second / 60)
+	defer mainLoopTicker.Stop()
+
+	for {
+		// Update the data that the SDK is holding with the next tick
+		_, err := irsdk.Update(100 * time.Millisecond)
+		if err != nil {
+			log.Printf("could not update data: %v", err)
+			continue
+		}
+
+		// Vehicle Movement data gathered from the names we can find on the
+		// telemetry_docs.pdf file
+		// - I wish to make this less verbose if possible
+		if _, ok := irsdk.Vars.Vars["Gear"]; !ok {
+			log.Fatal("Field `Gear` doesn't exist")
+		}
+
+		if _, ok := irsdk.Vars.Vars["RPM"]; !ok {
+			log.Fatal("Field `RPM` doesn't exist")
+		}
+
+		if _, ok := irsdk.Vars.Vars["Speed"]; !ok {
+			log.Fatal("Field `Speed` doesn't exist")
+		}
+
+		gear := int32(irsdk.Vars.Vars["Gear"].Value.(int))
+		rpm := int32(irsdk.Vars.Vars["RPM"].Value.(float32))
+		speed := int32(msToKph(irsdk.Vars.Vars["Speed"].Value.(float32)))
+
+		fmt.Printf("\033[?25l\033[2J\033[H")
+		fmt.Printf("Gear: %d, RPM: %d, Speed: %d", gear, rpm, speed)
+
+		<-mainLoopTicker.C
+	}
+}
+```
+
+
+## SharedMem
+I vendored in the code from [hidez8891/shm](https://github.com/hidez8891/shm) 
+since the repo has been archived. I took the opportunity to update some of its
+code.

constants.go

@@ -119,7 +119,25 @@ const (
 
 // Some other constants that I need to get trough
 // // bit fields
-// enum irsdk_EngineWarnings 
+
+type bitfieldValue struct {
+	Value int
+	Name  string
+}
+
+// EngineWarnings const
+var (
+	irsdkWaterTempWarning    = bitfieldValue{0x01, "irsdk_waterTempWarning"}
+	irsdkFuelPressureWarning = bitfieldValue{0x02, "irsdk_fueldPressureWarning"}
+	irsdkOilPressureWarning  = bitfieldValue{0x04, "irsdk_oilPressureWarning"}
+	irsdkEngineStalled       = bitfieldValue{0x08, "irsdk_engineStalled"}
+	irsdkPitSpeedLimiter     = bitfieldValue{0x10, "irsdk_pitSpeedLimiter"}
+	irsdkRevLimiterActive    = bitfieldValue{0x20, "irsdk_revLimiterActive"}
+	irsdkEngineWarnings      = []bitfieldValue{irsdkWaterTempWarning, irsdkFuelPressureWarning,
+		irsdkOilPressureWarning, irsdkEngineStalled, irsdkPitSpeedLimiter, irsdkRevLimiterActive}
+)
+
+// enum irsdk_EngineWarnings
 // {
 // 	irsdk_waterTempWarning		= 0x01,
 // 	irsdk_fuelPressureWarning	= 0x02,

diskSubHeader.go

@@ -1,6 +1,8 @@
 package goirsdk
 
 import (
+	"github.com/ESilva15/goirsdk/logger"
+
 	"bytes"
 	"encoding/binary"
 	"fmt"
@@ -19,6 +21,31 @@ type DiskSubHeader struct {
 	RecordCount int32   // RecordCount holds the number of data frames
 }
 
+// readSubheader will read the subheader contents out of the telemetry data
+func (i *IBT) readSubheader() error {
+	log := logger.GetInstance()
+
+	var subheaderRaw [SubHeaderSize]byte
+	_, err := i.File.ReadAt(subheaderRaw[:], HeaderSize)
+	if err != nil {
+		return fmt.Errorf("Failed to read disk subheaders from file: %v", err)
+	}
+	i.SubHeaders, err = parseTelemetrySubHeader(subheaderRaw)
+	if err != nil {
+		return fmt.Errorf("Unable to parse disk subheaders from file: %v", err)
+	}
+
+	// Write to the output file - TODO add the check
+	if i.IBTExport != nil {
+    err = i.exportIBT(subheaderRaw[:], HeaderSize)
+		if err != nil {
+      log.Printf("Failed to export subheaders: %v\n", err)
+		}
+	}
+
+	return nil
+}
+
 // parseTelemetrySubHeader will return a pointer to a DiskSubHeader variable
 // or nil if an error occurs. In which case the error return value is more
 // valuable

diskSubHeader_whitebox_test.go

@@ -1,38 +1,38 @@
-package goirsdk
+package goirsdk
-
+
-import (
+import (
-	"testing"
+	"testing"
-
+
-	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp"
-)
+)
-
+
-// TestParseTelemetrySubHeader_WithGoodBuffer
+// TestParseTelemetrySubHeader_WithGoodBuffer
-// Given a well structured buffer it will output the expected
+// Given a well structured buffer it will output the expected
-// DiskSubHeader struct
+// DiskSubHeader struct
-func TestParseTelemetrySubHeader_WithGoodBuffer(t *testing.T) {
+func TestParseTelemetrySubHeader_WithGoodBuffer(t *testing.T) {
-	// Arrange
+	// Arrange
-	header := [32]byte{
+	header := [32]byte{
-		0x54, 0x1e, 0x14, 0x67, 0x00, 0x00, 0x00, 0x00, 0x54, 0x09, 0x00, 0xf0,
+		0x54, 0x1e, 0x14, 0x67, 0x00, 0x00, 0x00, 0x00, 0x54, 0x09, 0x00, 0xf0,
-		0xee, 0x7e, 0x6b, 0x40, 0x53, 0x74, 0x88, 0x44, 0x44, 0x86, 0x8f, 0x40,
+		0xee, 0x7e, 0x6b, 0x40, 0x53, 0x74, 0x88, 0x44, 0x44, 0x86, 0x8f, 0x40,
-		0x08, 0x00, 0x00, 0x00, 0xe1, 0xb8, 0x00, 0x00,
+		0x08, 0x00, 0x00, 0x00, 0xe1, 0xb8, 0x00, 0x00,
-	}
+	}
-
+
-	expectedHeader := DiskSubHeader{
+	expectedHeader := DiskSubHeader{
-		StartDate:   1729371732,
+		StartDate:   1729371732,
-		StartTime:   219.96666717536084,
+		StartTime:   219.96666717536084,
-		EndTime:     1008.7833338413715,
+		EndTime:     1008.7833338413715,
-		LapCount:    8,
+		LapCount:    8,
-		RecordCount: 47329,
+		RecordCount: 47329,
-	}
+	}
-
+
-	// Act
+	// Act
-	headers, err := parseTelemetrySubHeader(header)
+	headers, err := parseTelemetrySubHeader(header)
-
+
-	// Assert
+	// Assert
-	if err != nil {
+	if err != nil {
-		t.Fatalf("Error parsing buffer: %v", err)
+		t.Fatalf("Error parsing buffer: %v", err)
-	}
+	}
-	if !cmp.Equal(&expectedHeader, headers) {
+	if !cmp.Equal(&expectedHeader, headers) {
-		t.Fatalf("Expected:\n%#v\nGot:\n%#v\n", expectedHeader, headers)
+		t.Fatalf("Expected:\n%#v\nGot:\n%#v\n", expectedHeader, headers)
-	}
+	}
-}
+}

examples/example.go

@@ -0,0 +1,66 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"time"
+
+	"github.com/ESilva15/goirsdk"
+)
+
+func msToKph(v float32) int {
+	return int((3600 * v) / 1000)
+}
+
+func main() {
+	// Open the data source file
+	file, err := os.Open("/path/to/ibtFile")
+	if err != nil {
+		log.Fatalf("Failed to open IBT file: %v", err)
+	}
+
+	// Instantiate our iRacing SDK instance
+	irsdk, err := goirsdk.Init(file, "", "")
+	if err != nil {
+		log.Fatalf("Failed to create iRacing interface: %v", err)
+	}
+	defer irsdk.Close()
+
+	// Set up a loop to iterate our data
+	mainLoopTicker := time.NewTicker(time.Second / 60)
+	defer mainLoopTicker.Stop()
+
+	for {
+		// Update the data that the SDK is holding with the next tick
+		_, err := irsdk.Update(100 * time.Millisecond)
+		if err != nil {
+			log.Printf("could not update data: %v", err)
+			continue
+		}
+
+		// Vehicle Movement data gathered from the names we can find on the
+		// telemetry_docs.pdf file
+		// - I wish to make this less verbose if possible
+		if _, ok := irsdk.Vars.Vars["Gear"]; !ok {
+			log.Fatal("Field `Gear` doesn't exist")
+		}
+
+		if _, ok := irsdk.Vars.Vars["RPM"]; !ok {
+			log.Fatal("Field `RPM` doesn't exist")
+		}
+
+		if _, ok := irsdk.Vars.Vars["Speed"]; !ok {
+			log.Fatal("Field `Speed` doesn't exist")
+		}
+
+		gear := int32(irsdk.Vars.Vars["Gear"].Value.(int))
+		rpm := int32(irsdk.Vars.Vars["RPM"].Value.(float32))
+		speed := int32(msToKph(irsdk.Vars.Vars["Speed"].Value.(float32)))
+
+		fmt.Printf("\033[?25l\033[2J\033[H")
+		fmt.Printf("Gear: %d, RPM: %d, Speed: %d", gear, rpm, speed)
+
+		<-mainLoopTicker.C
+	}
+}

go.mod

@@ -4,7 +4,7 @@ go 1.23.2
 
 require (
 	github.com/google/go-cmp v0.6.0
-	golang.org/x/sys v0.26.0
+	golang.org/x/sys v0.29.0
 	golang.org/x/text v0.19.0
 	gopkg.in/yaml.v3 v3.0.1
 )

go.sum

@@ -1,7 +1,7 @@
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
+golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
-golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
 golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=

headers.go

@@ -1,6 +1,8 @@
 package goirsdk
 
 import (
+	"github.com/ESilva15/goirsdk/logger"
+
 	"bytes"
 	"encoding/binary"
 	"fmt"
@@ -39,6 +41,47 @@ type TelemetryHeaders struct {
 	BufOffset int32
 }
 
+// readHeader will read the header out of the telemetry data
+func (i *IBT) readHeader() error {
+	log := logger.GetInstance()
+
+	var headerRaw [FileHeaderSize]byte
+	_, err := i.File.ReadAt(headerRaw[:], 0)
+	if err != nil {
+		return fmt.Errorf("Failed to read headers from file: %v", err)
+	}
+	i.Headers, err = parseTelemetryHeader(headerRaw)
+	if err != nil {
+		return fmt.Errorf("Unable to read headers from file: %v", err)
+	}
+
+	// Write to the output file - TODO: this should only write if necessary
+	if i.IBTExport != nil {
+    err = i.exportIBT(headerRaw[:], 0)
+		if err != nil {
+      log.Printf("Failed to export headers: %v\n", err)
+		}
+	}
+
+	return nil
+}
+
+// parseTelemetryHeader will read the IBT file headers from a correctly sized
+// buffer.
+// You need to pass a the first FILE_HEADER_SIZE bytes of the buffer
+func parseTelemetryHeader(buf [FileHeaderSize]byte) (*TelemetryHeaders, error) {
+	// utils.HexDump(buf[:])
+	// fmt.Printf("Len: %d\n", len(buf))
+
+	dst := TelemetryHeaders{}
+	err := binary.Read(bytes.NewBuffer(buf[:]), binary.LittleEndian, &dst)
+	if err != nil {
+		return nil, fmt.Errorf("unable to unpack data: %v", err)
+	}
+
+	return &dst, nil
+}
+
 // ToString renders a string showing the values of the struct
 func (th *TelemetryHeaders) ToString() string {
 	return fmt.Sprintf(
@@ -61,19 +104,3 @@ func (th *TelemetryHeaders) ToString() string {
 		th.NumBuf, th.NumBuf, th.BufLen, th.BufLen, th.BufOffset, th.BufOffset,
 	)
 }
-
-// parseTelemetryHeader will read the IBT file headers from a correctly sized
-// buffer.
-// You need to pass a the first FILE_HEADER_SIZE bytes of the buffer
-func parseTelemetryHeader(buf [FileHeaderSize]byte) (*TelemetryHeaders, error) {
-	// utils.HexDump(buf[:])
-	// fmt.Printf("Len: %d\n", len(buf))
-
-	dst := TelemetryHeaders{}
-	err := binary.Read(bytes.NewBuffer(buf[:]), binary.LittleEndian, &dst)
-	if err != nil {
-		return nil, fmt.Errorf("unable to unpack data: %v", err)
-	}
-
-	return &dst, nil
-}

headers_whitebox_test.go

@@ -1,52 +1,52 @@
-package goirsdk
+package goirsdk
-
+
-import (
+import (
-	"testing"
+	"testing"
-
+
-	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp"
-)
+)
-
+
-// TestParseTelemetryHeader_WithGoodBuffer
+// TestParseTelemetryHeader_WithGoodBuffer
-// Given a well structured buffer it will output the expected
+// Given a well structured buffer it will output the expected
-// TelemetryHeaders struct
+// TelemetryHeaders struct
-func TestParseTelemetryHeader_WithGoodBuffer(t *testing.T) {
+func TestParseTelemetryHeader_WithGoodBuffer(t *testing.T) {
-	// Arrange
+	// Arrange
-	header := [112]byte{
+	header := [112]byte{
-		0x02, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x00,
+		0x02, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x00,
-		0x00, 0x00, 0x00, 0x00, 0x05, 0x3f, 0x00, 0x00, 0x90, 0x99, 0x00, 0x00,
+		0x00, 0x00, 0x00, 0x00, 0x05, 0x3f, 0x00, 0x00, 0x90, 0x99, 0x00, 0x00,
-		0x10, 0x01, 0x00, 0x00, 0x90, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
+		0x10, 0x01, 0x00, 0x00, 0x90, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
-		0x1d, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x1d, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-		0x60, 0x2b, 0x00, 0x00, 0x95, 0xd8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x60, 0x2b, 0x00, 0x00, 0x95, 0xd8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-		0x00, 0x00, 0x00, 0x00,
+		0x00, 0x00, 0x00, 0x00,
-	}
+	}
-
+
-	expectedHeader := TelemetryHeaders{
+	expectedHeader := TelemetryHeaders{
-		Version:           2,
+		Version:           2,
-		Status:            1,
+		Status:            1,
-		TickRate:          60,
+		TickRate:          60,
-		SessionInfoUpdate: 0,
+		SessionInfoUpdate: 0,
-		SessionInfoLength: 16133,
+		SessionInfoLength: 16133,
-		SessionInfoOffset: 39312,
+		SessionInfoOffset: 39312,
-		NumVars:           272,
+		NumVars:           272,
-		VarHeaderOffset:   144,
+		VarHeaderOffset:   144,
-		NumBuf:            1,
+		NumBuf:            1,
-		BufLen:            1053,
+		BufLen:            1053,
-		Padding:           [12]byte{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x60, 0x2b, 0x0, 0x0},
+		Padding:           [12]byte{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x60, 0x2b, 0x0, 0x0},
-		BufOffset:         55445,
+		BufOffset:         55445,
-	}
+	}
-
+
-	// Act
+	// Act
-	headers, err := parseTelemetryHeader(header)
+	headers, err := parseTelemetryHeader(header)
-
+
-	// Assert
+	// Assert
-	if err != nil {
+	if err != nil {
-		t.Fatalf("Error parsing buffer: %v", err)
+		t.Fatalf("Error parsing buffer: %v", err)
-	}
+	}
-	if !cmp.Equal(&expectedHeader, headers) {
+	if !cmp.Equal(&expectedHeader, headers) {
-		t.Fatalf("Expected:\n%#v\nGot:\n%#v\n", expectedHeader, headers)
+		t.Fatalf("Expected:\n%#v\nGot:\n%#v\n", expectedHeader, headers)
-	}
+	}
-}
+}

irsdk.go

@@ -3,21 +3,23 @@ package goirsdk
 
 import (
 	"fmt"
-	"log"
 	"os"
-	// "os"
-	"io"
-	// "log"
-	// "time"
 
-	// conv "ibtReader/conversions"
+	"io"
+
+	"github.com/ESilva15/goirsdk/logger"
 	"github.com/ESilva15/goirsdk/winutils"
+	"gopkg.in/yaml.v3"
 )
 
 const (
 	ibtFile = "./telemetryFiles/mx5_2016Okayama_full_2024_10_19_22_02_12.ibt"
 )
 
+func msToKph(v float32) int {
+	return int((3600 * v) / 1000)
+}
+
 // Reader is an interface to represent the readable data that can be either
 // a .ibt file (or live data, hopefully)
 type Reader interface {
@@ -28,13 +30,16 @@ type Reader interface {
 
 // IBT struct will hold the relevant data for a given IBT file
 type IBT struct {
-	File         Reader                    // Source of the data
+	File           Reader                    // Source of the data
-	FileToExport string                    // If set, it will export the IBT data to the file
+	IBTExport      *os.File                  // If set, it will export the IBT data to the file
-	Headers      *TelemetryHeaders         // IBT file Headers
+	IBTExportPath  string                    // Path for IBT export
-	SubHeaders   *DiskSubHeader            // IBT file Sub Headers
+	YAMLExport     *os.File                  // If set, it will export the session YAML to the file
-	SessionInfo  *SessionInfoYAML          // IBT file Session Info
+	YAMLExportPath string                    // Path for YAML export
-	Vars         *TelemetryVars            // Vars will hold the telemetry data
+	Headers        *TelemetryHeaders         // IBT file Headers
-	winUtils     *winutils.IRacingWinUtils // WinUtils gives access to the system utilities
+	SubHeaders     *DiskSubHeader            // IBT file Sub Headers
+	SessionInfo    *SessionInfoYAML          // IBT file Session Info
+	Vars           *TelemetryVars            // Vars will hold the telemetry data
+	winUtils       *winutils.IRacingWinUtils // WinUtils gives access to the system utilities
 }
 
 func (i *IBT) IsConnected() bool {
@@ -50,28 +55,70 @@ func (i *IBT) IsConnected() bool {
 	return false
 }
 
-func (i *IBT) ExportToIBT(filepath string) {
+func (i *IBT) exportYAML() error {
-	rbuf := make([]byte, fileMapSize)
+	log := logger.GetInstance()
 
-	_, err := i.File.ReadAt(rbuf, 0)
+	file, err := os.OpenFile(i.YAMLExportPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
 	if err != nil {
-		log.Fatal(err)
+		log.Printf("Failed to open file for YAML export: %v\n", err)
+		return fmt.Errorf("failed to open output file for YAML: %v", err)
+	}
+	defer file.Close()
+
+	enc := yaml.NewEncoder(file)
+
+	err = enc.Encode(i.SessionInfo)
+	if err != nil {
+		log.Printf("Failed to write into file for YAML export: %v\n", err)
+		return fmt.Errorf("failed to write YAML contents to file: %v", err)
 	}
 
-	err = os.WriteFile(filepath, rbuf, 0644)
+	return nil
+}
+
+func (i *IBT) exportIBT(data []byte, offset int64) error {
+	log := logger.GetInstance()
+
+	_, err := i.IBTExport.WriteAt(data, offset)
+
 	if err != nil {
-		log.Fatal(err)
+		i.IBTExport.Close()
+		i.IBTExport = nil
+		log.Println("Won't attempt to export anymore")
+		return err
 	}
+
+	return nil
 }
 
 // Init serves to initialize and get a hold of a IBT struct
-func Init(f Reader) (*IBT, error) {
+// f -> is the source data, pass nil for the SDK to read live data or a
+// *os.File to read from a file
+// exportTelem -> is a string with the path to export the telemetry data, pass
+// an empty string to not export any data
+// exportTelem -> is a string with the path to export the session info data, pass
+// an empty string to not export any data
+func Init(f Reader, exportTelem string, exportYAML string) (*IBT, error) {
+	// log := logger.GetInstance()
+
 	// Read the header of the file
 	var err error
 	ibt := IBT{
-		File:     f,
+		File:           f,
-		Vars:     &TelemetryVars{},
+		IBTExport:      nil,
-		winUtils: nil,
+		IBTExportPath:  exportTelem,
+		YAMLExport:     nil,
+		YAMLExportPath: exportYAML,
+		Vars:           &TelemetryVars{},
+		winUtils:       nil,
+	}
+
+	// If requested to output to a telemetry file
+	if exportTelem != "" {
+		ibt.IBTExport, err = os.OpenFile(exportTelem, os.O_CREATE|os.O_RDWR, 0644)
+		if err != nil {
+			return nil, fmt.Errorf("failed to open ibt export file: %v", err)
+		}
 	}
 
 	if ibt.File == nil {
@@ -103,36 +150,21 @@ func Init(f Reader) (*IBT, error) {
 	}
 
 	// Read the file headers
-	var headerRaw [FileHeaderSize]byte
+	err = ibt.readHeader()
-	_, err = ibt.File.ReadAt(headerRaw[:], 0)
 	if err != nil {
-		return nil, fmt.Errorf("Failed to read headers from file: %v", err)
+		return nil, err
-	}
-	ibt.Headers, err = parseTelemetryHeader(headerRaw)
-	if err != nil {
-		return nil, fmt.Errorf("Unable to read headers from file: %v", err)
 	}
 
 	// Read the disk sub headers
-	var subheaderRaw [SubHeaderSize]byte
+	err = ibt.readSubheader()
-	_, err = ibt.File.ReadAt(subheaderRaw[:], 112)
 	if err != nil {
-		return nil, fmt.Errorf("Failed to read disk subheaders from file: %v", err)
+		return nil, err
-	}
-	ibt.SubHeaders, err = parseTelemetrySubHeader(subheaderRaw)
-	if err != nil {
-		return nil, fmt.Errorf("Unable to parse disk subheaders from file: %v", err)
 	}
 
 	// Read session info string
-	sessionInfoStringRaw := make([]byte, ibt.Headers.SessionInfoLength)
+	err = ibt.readSessionInfo()
-	_, err = ibt.File.ReadAt(sessionInfoStringRaw, int64(ibt.Headers.SessionInfoOffset))
 	if err != nil {
-		return nil, fmt.Errorf("Failed to read sessionInfoString from file: %v", err)
+		return nil, err
-	}
-	ibt.SessionInfo, err = parseSessionInfo(sessionInfoStringRaw, ibt.Headers.SessionInfoLength)
-	if err != nil {
-		return nil, fmt.Errorf("Unable to parse SessionInfoString from file: %v", err)
 	}
 
 	// Read the telemetry vars info
@@ -144,6 +176,7 @@ func Init(f Reader) (*IBT, error) {
 	return &ibt, nil
 }
 
+// Close cleans up our irsdk instance
 func (i *IBT) Close() {
 	if i.winUtils != nil {
 		// If its not live data, the user is the one with ownership of the handle
@@ -151,69 +184,3 @@ func (i *IBT) Close() {
 		i.winUtils.Close()
 	}
 }
-
-// func main() {
-// 	fmt.Println("================== IBT FILE PARSER ==================")
-//
-// 	file, err := os.Open(ibtFile)
-// 	if err != nil {
-// 		log.Fatalf("Failed to open IBT file: %v", err)
-// 	}
-//
-// 	ibt, err := Init(file)
-// 	if err != nil {
-// 		log.Fatalf("Failed to create irsdk instance: %v", err)
-// 	}
-// 	// fmt.Printf("%s\n", ibt.Headers.ToString())
-// 	// fmt.Printf("%s\n", ibt.SubHeaders.ToString())
-// 	// fmt.Printf("%s\n", ibt.SessionInfo.ToString())
-//
-// 	// Display the human readable start date
-// 	// unixStartDate := time.Unix(ibt.SubHeaders.StartDate, 0)
-// 	// startDate := unixStartDate.Format("2006/01/02 15:04:05 -0700 MST")
-// 	// fmt.Println("StartDate:", startDate)
-//
-// 	// Display the human readable version of start time
-// 	// unixStartTime := time.Unix(ibt.SubHeaders.StartDate+int64(ibt.SubHeaders.StartTime), 0)
-// 	// startTime := unixStartTime.Format("2006/01/02 15:04:05 -0700 MST")
-// 	// fmt.Println("StartTime:", startTime)
-//
-// 	// Display the human readable version of end time
-// 	// unixEndTime := time.Unix(ibt.SubHeaders.StartDate+int64(ibt.SubHeaders.EndTime), 0)
-// 	// endTime := unixEndTime.Format("2006/01/02 15:04:05 -0700 MST")
-// 	// fmt.Println("EndTime:  ", endTime)
-//
-// 	last := time.Now().UnixMilli()
-// 	for {
-// 		time.Sleep(time.Second / 60)
-// 		res, err := ibt.Update(100 * time.Millisecond)
-// 		if res == Unknown {
-// 			log.Fatalf("Some unknown error occurred: %v\n", err)
-// 		}
-//
-// 		if res == Paused {
-// 			fmt.Printf("\r                                                                    \r")
-// 			fmt.Println("GAME IS PAUSED")
-// 			continue
-// 		}
-//
-// 		curTime := time.Now().UnixMilli()
-//
-// 		if curTime-last > 250 {
-// 			fmt.Printf("                                                           \r")
-// 			if val, ok := ibt.Vars.Vars["Speed"]; ok {
-// 				fmt.Printf("\r%d %d", ibt.Vars.Tick/60, conv.MsToKph(val.Value.(float32)))
-// 			} else {
-// 				fmt.Printf("\r%d %s", ibt.Vars.Tick/60, "KEY DOESN'T EXIST")
-// 			}
-// 		}
-//
-// 		if res == Ended {
-// 			fmt.Println("\nEnd of file found...")
-// 			break
-// 		}
-// 	}
-// 	fmt.Printf("%d\n", ibt.Vars.Tick)
-//
-// 	ibt.Close()
-// }

irsdk_test.go

@@ -0,0 +1,101 @@
+package goirsdk
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"sort"
+	"testing"
+	"time"
+)
+
+type StandingsLine struct {
+	CarIdx     int
+	LapPct     float32
+	Lap        int32
+	DriverName string
+	EstTime    float32
+	TimeBehind float32
+}
+
+func lapTimeRepresentation(t float32) string {
+	if t < 0 {
+		t = 0
+	}
+
+	wholeSeconds := int64(t)
+	lapTime := time.Unix(wholeSeconds, int64((t-float32(wholeSeconds))*1e9))
+
+	return lapTime.Format("04:05.000")
+}
+
+func TestFunctionality(t *testing.T) {
+	input, err := os.Open("../testTelemetry/supercars_race_watkins_glenn.ibt")
+	if err != nil {
+		t.Fatal("Was unable to prepare telemetry file for testing.")
+	}
+
+	i, _ := Init(input, "", "")
+	defer i.Close()
+
+	// Set up a loop to iterate our data
+	mainLoopTicker := time.NewTicker(time.Second / 60)
+	defer mainLoopTicker.Stop()
+
+	for {
+		// Update the data that the SDK is holding with the next tick
+		_, err := i.Update(100 * time.Millisecond)
+		if err != nil {
+			log.Printf("could not update data: %v", err)
+			continue
+		}
+
+		// Vehicle Movement data gathered from the names we can find on the
+		// telemetry_docs.pdf file
+		// - I wish to make this less verbose if possible
+		if _, ok := i.Vars.Vars["CarIdxPosition"]; !ok {
+			log.Fatal("Field `CarIdxPosition` doesn't exist")
+		}
+		driversLapDistPct := i.Vars.Vars["CarIdxLapDistPct"].Value.([]float32)
+		driversEstTime := i.Vars.Vars["CarIdxEstTime"].Value.([]float32)
+		driversLap := i.Vars.Vars["CarIdxLap"].Value.([]int32)
+		// driversBehind := i.Vars.Vars["CarIdxF2Time"].Value.([]float32)
+
+		drivers := i.SessionInfo.DriverInfo.Drivers
+    myIdx := i.SessionInfo.DriverInfo.DriverCarIdx
+
+		standings := make([]StandingsLine, len(drivers))
+
+		fmt.Printf("\033[?25l\033[2J\033[H")
+		for k := range len(drivers) {
+			if drivers[k].CarIsPaceCar == 1 || drivers[k].IsSpectator == 1 {
+				continue
+			}
+
+			standings[k] = StandingsLine{
+				CarIdx:     k,
+				LapPct:     driversLapDistPct[k],
+				DriverName: drivers[k].UserName,
+				EstTime:    driversEstTime[k],
+				Lap:        driversLap[k],
+				TimeBehind: driversEstTime[myIdx],
+			}
+		}
+
+		sort.Slice(standings, func(i int, j int) bool {
+			if standings[i].Lap > int32(standings[j].Lap) {
+				return true
+			}
+
+			return standings[i].LapPct >= standings[j].LapPct
+		})
+
+    fmt.Printf("%v\n", driversEstTime)
+		// for p, v := range standings {
+		// 	fmt.Printf("[%2d] %-30s %13f %13f\n",
+		// 		p+1, v.DriverName, v.LapPct, driversEstTime[p] - driversEstTime[myIdx])
+		// }
+
+		<-mainLoopTicker.C
+	}
+}

logger/logger.go

@@ -0,0 +1,23 @@
+package logger
+
+import (
+	"log"
+	"os"
+	"sync"
+)
+
+var l *log.Logger
+var once sync.Once
+
+func createLogger() {
+  l = log.New(os.Stdout, "[ibtReader] ", log.LstdFlags | log.Lshortfile)
+}
+
+func GetInstance() *log.Logger {
+	once.Do(func() {
+    createLogger() 
+	})
+
+  return l
+}
+

sessionInfo.go

@@ -1,7 +1,10 @@
 package goirsdk
 
 import (
+	"github.com/ESilva15/goirsdk/logger"
+
 	"encoding/json"
+	"fmt"
 	"log"
 	"strings"
 
@@ -307,6 +310,40 @@ type Driver struct {
 	TeamIncidentCount       int     `yaml:"TeamIncidentCount"`
 }
 
+// readSessionInfo will read the session info yaml out of the telemetry data
+func (i *IBT) readSessionInfo() error {
+	log := logger.GetInstance()
+
+	sessionInfoStringRaw := make([]byte, i.Headers.SessionInfoLength)
+	_, err := i.File.ReadAt(sessionInfoStringRaw, int64(i.Headers.SessionInfoOffset))
+	if err != nil {
+		return fmt.Errorf("Failed to read sessionInfoString from file: %v", err)
+	}
+
+	// Write to the output file
+	if i.IBTExport != nil {
+		err := i.exportIBT(sessionInfoStringRaw[:], int64(i.Headers.SessionInfoOffset))
+		if err != nil {
+			log.Printf("Failed to export offline telemetry data: %v", err)
+		}
+	}
+
+	i.SessionInfo, err = parseSessionInfo(sessionInfoStringRaw, i.Headers.SessionInfoLength)
+	if err != nil {
+		return fmt.Errorf("Unable to parse SessionInfoString from file: %v", err)
+	}
+
+	// Write to YAML output file
+	if i.YAMLExportPath != "" {
+		err := i.exportYAML()
+		if err != nil {
+			log.Printf("Failed to export YAML string: %v\n", err)
+		}
+	}
+
+	return nil
+}
+
 // parseSessionInfo will parse the sessionInfo buffer into the SessionInfoYAML
 // struct
 func parseSessionInfo(buf []byte, len int32) (*SessionInfoYAML, error) {

variables.go

@@ -7,6 +7,7 @@ import (
 	"io"
 	"log"
 	"math"
+	"strconv"
 	"strings"
 	"time"
 )
@@ -71,6 +72,20 @@ type Var struct {
 	Value interface{}
 }
 
+func (v *Var) ToString() string {
+	return fmt.Sprintf(
+		"Type:        %5d (0x%08x)\n"+
+			"Offset:      %5d (0x%08x)\n"+
+			"Count:       %5d (0x%08x)\n"+
+			"CountAsTime: %5t\n"+
+			"Name:        %s\n"+
+			"Description: %s\n"+
+			"Unit:        %s",
+		v.Type, v.Type, v.Offset, v.Offset, v.Count, v.Count,
+		v.CountAsTime, v.Name, v.Description, v.Unit,
+	)
+}
+
 func (v *IBTVar) ToString() string {
 	return fmt.Sprintf(
 		"Type:        %5d (0x%08x)\n"+
@@ -91,8 +106,9 @@ type varBuffer struct {
 }
 
 type TelemetryVars struct {
-	Tick int32
+	Tick         int32          // Keeps track of the current data buffer tick
-	Vars map[string]Var
+	RecorderTick int32          // Counts from 0 when creating a telemetry file from a replay or live data
+	Vars         map[string]Var // Variables content
 }
 
 func (i *IBT) readVariablerHeaders() error {
@@ -107,6 +123,14 @@ func (i *IBT) readVariablerHeaders() error {
 			return err
 		}
 
+		if i.IBTExport != nil {
+			err = i.exportIBT(rbuf, int64(i.Headers.VarHeaderOffset+k*VarHeaderSize))
+			if err != nil {
+				// Don't outright kill it here - maybe nowhere else
+				log.Printf("Failed to export variable contents: %v\n", err)
+			}
+		}
+
 		var dst IBTVar
 		err = binary.Read(bytes.NewBuffer(rbuf[:]), binary.LittleEndian, &dst)
 		if err != nil {
@@ -130,6 +154,38 @@ func (i *IBT) readVariablerHeaders() error {
 	return nil
 }
 
+func (i *IBT) parseEngineWarnings() {
+	val, ok := i.Vars.Vars["EngineWarnings"]
+	if !ok {
+		log.Fatal("no engine warnings")
+	}
+
+	bitfield, err := strconv.ParseInt(val.Value.(string), 0, 64)
+	if err != nil {
+		log.Fatal("Unable to get engine warnings: " + err.Error())
+	}
+
+	for _, ew := range irsdkEngineWarnings {
+		result := (int(bitfield) & ew.Value) != 0
+		i.Vars.Vars[ew.Name] = Var{Value: result}
+	}
+}
+
+// parseBitfieldVariables will parse the variables:
+// - irsdk_CameraState "CamCameraState"
+// - irsdk_EngineWarnings "EngineWarnings"
+// - irsdk_PitSvFlags "PitSvFlags"
+// - irsdk_Flags "SessionFlags"
+// - irsdk_SessionState "SessionState"
+// - irsdk_TrkLoc "CarIdxTrackSurface"
+//
+// The approach for now will be to create unique entries in the data map for
+// the fields in these variables
+func (i *IBT) parseBitfieldVariables() {
+	// Parse the EngineWarnings variables - its the only one for now
+	i.parseEngineWarnings()
+}
+
 func (i *IBT) readData(buf []byte) error {
 	for k, v := range i.Vars.Vars {
 		// Slice of the variable value in the buffer
@@ -138,26 +194,117 @@ func (i *IBT) readData(buf []byte) error {
 		// Read the value
 		switch v.Type {
 		case IRSDK_char:
-			v.Value = string(rbuf[0])
+			if v.Count > 1 {
+				// Array of data
+				data := make([]string, v.Count)
+				for entry := 0; entry < int(v.Count); entry++ {
+					entryOffset := v.Offset + int32(entry)*int32(VarTypes[int(v.Type)].Size)
+					rbuf := buf[entryOffset : entryOffset+int32(VarTypes[int(v.Type)].Size)]
+
+					newValue := string(rbuf[0])
+					data[entry] = newValue
+				}
+
+				v.Value = data
+			} else {
+				// Single value
+				v.Value = string(rbuf[0])
+			}
 		case IRSDK_bool:
-			v.Value = int(rbuf[0]) > 0
+			if v.Count > 1 {
+				// Array of data
+				data := make([]bool, v.Count)
+				for entry := 0; entry < int(v.Count); entry++ {
+					entryOffset := v.Offset + int32(entry)*int32(VarTypes[int(v.Type)].Size)
+					rbuf := buf[entryOffset : entryOffset+int32(VarTypes[int(v.Type)].Size)]
+
+					newValue := int(rbuf[0]) > 0
+					data[entry] = newValue
+				}
+
+				v.Value = data
+			} else {
+				// Single value
+				v.Value = int(rbuf[0]) > 0
+			}
 		case IRSDK_int:
-			v.Value = int(binary.LittleEndian.Uint32(rbuf))
+			if v.Count > 1 {
+				// Array of data
+				data := make([]int32, v.Count)
+				for entry := 0; entry < int(v.Count); entry++ {
+					entryOffset := v.Offset + int32(entry)*int32(VarTypes[int(v.Type)].Size)
+					rbuf := buf[entryOffset : entryOffset+int32(VarTypes[int(v.Type)].Size)]
+					newValue := int32(binary.LittleEndian.Uint32(rbuf))
+					data[entry] = newValue
+				}
+
+				v.Value = data
+			} else {
+				// Single value
+				v.Value = int(binary.LittleEndian.Uint32(rbuf))
+			}
 		case IRSDK_bitField:
-			v.Value = fmt.Sprintf("0x%x", int(binary.LittleEndian.Uint32(rbuf)))
+			if v.Count > 1 {
+				// Array of data
+				data := make([]string, v.Count)
+				for entry := 0; entry < int(v.Count); entry++ {
+					entryOffset := v.Offset + int32(entry)*int32(VarTypes[int(v.Type)].Size)
+					rbuf := buf[entryOffset : entryOffset+int32(VarTypes[int(v.Type)].Size)]
+					newValue := fmt.Sprintf("0x%x", int(binary.LittleEndian.Uint32(rbuf)))
+					data[entry] = newValue
+				}
+
+				v.Value = data
+			} else {
+				// Single value
+				v.Value = fmt.Sprintf("0x%x", int(binary.LittleEndian.Uint32(rbuf)))
+			}
 		case IRSDK_float:
-			v.Value = math.Float32frombits(uint32(binary.LittleEndian.Uint32(rbuf)))
+			if v.Count > 1 {
+				// Array of data
+				data := make([]float32, v.Count)
+				for entry := 0; entry < int(v.Count); entry++ {
+					entryOffset := v.Offset + int32(entry)*int32(VarTypes[int(v.Type)].Size)
+					rbuf := buf[entryOffset : entryOffset+int32(VarTypes[int(v.Type)].Size)]
+					newValue := math.Float32frombits(uint32(binary.LittleEndian.Uint32(rbuf)))
+					data[entry] = newValue
+				}
+
+				v.Value = data
+			} else {
+				// Single value
+				v.Value = math.Float32frombits(uint32(binary.LittleEndian.Uint32(rbuf)))
+			}
 		case IRSDK_double:
-			v.Value = math.Float64frombits(uint64(binary.LittleEndian.Uint64(rbuf)))
+			if v.Count > 1 {
+				// Array of data
+				data := make([]float64, v.Count)
+				for entry := 0; entry < int(v.Count); entry++ {
+					entryOffset := v.Offset + int32(entry)*int32(VarTypes[int(v.Type)].Size)
+					rbuf := buf[entryOffset : entryOffset+int32(VarTypes[int(v.Type)].Size)]
+					newValue := math.Float64frombits(uint64(binary.LittleEndian.Uint64(rbuf)))
+					data[entry] = newValue
+				}
+
+				v.Value = data
+			} else {
+				// Single value
+				v.Value = math.Float64frombits(uint64(binary.LittleEndian.Uint64(rbuf)))
+			}
 		}
 		// --------------
 
 		i.Vars.Vars[k] = v
 	}
 
+	// Parse the bitfield variables here
+	i.parseBitfieldVariables()
+
 	return nil
 }
 
+// Update will read the next data chunk from the telemetry data, works for both the
+// live and offline data
 func (i *IBT) Update(timeout time.Duration) (IRacingState, error) {
 	if i.winUtils != nil {
 		// Put a way to check if the sim is active here
@@ -197,6 +344,13 @@ func (i *IBT) Update(timeout time.Duration) (IRacingState, error) {
 			return Failed, err
 		}
 
+		if i.IBTExport != nil {
+			err = i.exportIBT(buf, int64(i.Headers.BufOffset+i.Vars.RecorderTick*i.Headers.BufLen))
+			if err != nil {
+				log.Printf("Failed to export live telemetry data: %v", err)
+			}
+		}
+
 		err = i.readData(buf)
 		if err != nil && err != io.EOF {
 			return Unknown, err
@@ -205,11 +359,24 @@ func (i *IBT) Update(timeout time.Duration) (IRacingState, error) {
 		if err == io.EOF {
 			return Ended, nil
 		}
+
+		// Document why this is here, I don't remember the exact words right now
+		i.Vars.RecorderTick++
 	} else {
-		// This will get the dataframe corresponding to a give tick
+		// This will get the dataframe corresponding to a given tick
 		start := i.Headers.BufOffset + i.Vars.Tick*i.Headers.BufLen
 		buf := make([]byte, i.Headers.BufLen)
 		_, err := i.File.ReadAt(buf, int64(start))
+
+		// Make this happen in a different thread, or have this send to a queue that has a thread
+		// writing to a file
+		if i.IBTExport != nil {
+			err = i.exportIBT(buf, int64(start))
+			if err != nil {
+				log.Printf("Failed to export offline telemetry data: %v", err)
+			}
+		}
+
 		if err == io.EOF {
 			return Ended, nil
 		}
@@ -226,11 +393,5 @@ func (i *IBT) Update(timeout time.Duration) (IRacingState, error) {
 		i.Vars.Tick++
 	}
 
-	// Make this happen in a different thread, or have this send to a queue that has a thread
-	// writing to a file
-	if i.FileToExport != "" {
-		i.ExportToIBT(i.FileToExport)
-	}
-
 	return Running, nil
 }

winutils/winutils_linux.go

@@ -1,53 +1,53 @@
-//go:build (linux && cgo) || (darwin && cgo)
+//go:build (linux && cgo) || (darwin && cgo)
-// +build linux,cgo darwin,cgo
+// +build linux,cgo darwin,cgo
-
+
-package winutils
+package winutils
-
+
-import (
+import (
-	"errors"
+	"errors"
-	"sync"
+	"sync"
-	"time"
+	"time"
-)
+)
-
+
-const (
+const (
-	WAIT_OBJECT_0 = 0
+	WAIT_OBJECT_0 = 0
-	WAIT_TIMEOUT  = 258
+	WAIT_TIMEOUT  = 258
-)
+)
-
+
-var (
+var (
-	once             sync.Once
+	once             sync.Once
-	ErrUnsupportedOS = errors.New("not found")
+	ErrUnsupportedOS = errors.New("not found")
-)
+)
-
+
-type utils struct {
+type utils struct {
-}
+}
-
+
-// INITIALIZATION
+// INITIALIZATION
-func newUtils() (*utils, error) {
+func newUtils() (*utils, error) {
-	return nil, ErrUnsupportedOS
+	return nil, ErrUnsupportedOS
-}
+}
-
+
-func (u *utils) Close() {
+func (u *utils) Close() {
-}
+}
-
+
-// openEvent opens a windows.Handle for a given event
+// openEvent opens a windows.Handle for a given event
-func (u *utils) OpenEvent(eventName string) error {
+func (u *utils) OpenEvent(eventName string) error {
-	return ErrUnsupportedOS
+	return ErrUnsupportedOS
-}
+}
-
+
-// OpenBroadcastChannel opens up a broadcast channel to send commands to iracing
+// OpenBroadcastChannel opens up a broadcast channel to send commands to iracing
-func (u *utils) OpenBroadcastChannel(name string) error {
+func (u *utils) OpenBroadcastChannel(name string) error {
-	return ErrUnsupportedOS
+	return ErrUnsupportedOS
-}
+}
-
+
-// INITIALIZATION
+// INITIALIZATION
-
+
-// openEvent waits for a good response for some given time
+// openEvent waits for a good response for some given time
-func (u *utils) CheckValidDataEvent(timeout time.Duration) bool {
+func (u *utils) CheckValidDataEvent(timeout time.Duration) bool {
-	return false
+	return false
-}
+}
-
+
-// SendBroadcastMessage sends a message trough the broadcast channel
+// SendBroadcastMessage sends a message trough the broadcast channel
-func (u *utils) SendBroadcastMessage(id, p1, p2 uintptr) error {
+func (u *utils) SendBroadcastMessage(id, p1, p2 uintptr) error {
-  return ErrUnsupportedOS
+  return ErrUnsupportedOS
-}
+}