Merge pull request 'remove old logger. We use actual loggers now' (#10) from remove-old-logger into master

Reviewed-on: #10

README.md

@@ -21,30 +21,42 @@ or to view the live data:
 Games implemented so far:
 - [iRacing](https://www.iracing.com/) using the [goirsdk](https://github.com/ESilva15/goirsdk)
 
-Games being implemented:
+<!-- Games being implemented: -->
-- [BeamNG.drive](https://www.beamng.com/game/) using the [gobngsdk](https://github.com/ESilva15/gobngsdk)
+<!-- - [BeamNG.drive](https://www.beamng.com/game/) using the [gobngsdk](https://github.com/ESilva15/gobngsdk) -->
-
+<!---->
-Games to be implemented:
+<!-- Games to be implemented: -->
-- [Assetto Corsa](https://assettocorsa.gg/)
+<!-- - [Assetto Corsa](https://assettocorsa.gg/) -->
 
 
 ## Roadmap
-- [ ] Implement the interface for a data source
+- [X] Implement the interface for a data source
-- [ ] Finish implementing BeamNG
 - [ ] Configuration of the peripherals via ESDI
 - [ ] Detection of the display
-- [ ] Fuel Calculator
 - [ ] LapTime Calculator
 - [ ] A very long list useful stuff like flags, position, more info about
 other drivers, track conditions and so on so forth
-- [ ] Dynamic data packets
-- [ ] More roadmap entries
 - [ ] Telemetry analysis tool
 - [ ] Better user interface
 
 
-## Debugging
+## Development
-### Freezes:
+### Mockservers
+To mock [BeamNG.drive](https://www.beamng.com/game/), I built 
+[BeaMNGMockOg](https://github.com/ESilva15/BeamNGMockOg) (should have though longer
+about the name).
+You create a recording by launching the BeamNG and then launching the mockserver with:
+`BeamNGMockOg record -a 127.0.0.1 -p 4443 -o output.bin`.
+
+To replay the recording: 
+`BeamNGMockOg replay [--loop] -a 127.0.0.1 -p 4443 -i input.bin`
+
+### Troubleshooting
+#### Can't see BeamNG data coming through
+Use, for example, `tcpdump -i any udp port <port> -X` to check if any data is available.
+
+
+### Debugging
+#### Freezes:
 Using delve:
 - Launch Terminal1 with `dlv debug . --headless --listen=:2345 -- tui`
 - Launch Terminal2 and connect to with with `dlv connect :2345`
@@ -59,7 +71,7 @@ pprof:
   - type `web` to view a graph version
 
 
-### Shameless begging
+## Shameless begging
 Hey, doesn't hurt to try, its free either way:
 [Buy me a coffee!](buymeacoffee.com/ESilva_15)
 

go.mod

@@ -4,8 +4,8 @@ go 1.25.5
 
 require (
 	github.com/ESilva15/ESgoRepl v0.1.0
-	github.com/ESilva15/gobngsdk v0.0.2
+	github.com/ESilva15/gobngsdk v1.1.3
-	github.com/ESilva15/goirsdk v0.2.11
+	github.com/ESilva15/goirsdk v0.3.0
 	github.com/arl/statsviz v0.8.0
 	github.com/gdamore/tcell/v2 v2.8.1
 	github.com/rivo/tview v0.42.0

go.sum

@@ -1,9 +1,9 @@
 github.com/ESilva15/ESgoRepl v0.1.0 h1:hOVcRBfdP8Yw1kLr2tFoM3SetV7vxFswKjzfAtq8UgM=
 github.com/ESilva15/ESgoRepl v0.1.0/go.mod h1:O2JQMyEgHy0zf9UvzvLNvp2w95T2uazc3torrzRmG9Y=
-github.com/ESilva15/gobngsdk v0.0.2 h1:N6stNOE14Wg80BAZMFu/Qd9Qa/J0DmExCfdPoDf7lco=
+github.com/ESilva15/gobngsdk v1.1.3 h1:CFaz2KjHKnBLrQuEN1QHOd1761cWM/rmTwLpSLrgbe4=
-github.com/ESilva15/gobngsdk v0.0.2/go.mod h1:cKLaZRgM0tGGXDvosaSjHnxeyC5Y6rg7zCLqEUJnOzw=
+github.com/ESilva15/gobngsdk v1.1.3/go.mod h1:cKLaZRgM0tGGXDvosaSjHnxeyC5Y6rg7zCLqEUJnOzw=
-github.com/ESilva15/goirsdk v0.2.11 h1:C/HuO9xGmRJ01vMR0KRjrhcMEfq1Mea1rQK0CICaOU4=
+github.com/ESilva15/goirsdk v0.3.0 h1:6D95Avq7chikGHwEUKh7Y/HaLHOWQ75Qxaz8oMDSfrw=
-github.com/ESilva15/goirsdk v0.2.11/go.mod h1:5borQbw+L4fe9b58JFHRHZwrzz0sMVAteuYbRnFOc0Q=
+github.com/ESilva15/goirsdk v0.3.0/go.mod h1:5borQbw+L4fe9b58JFHRHZwrzz0sMVAteuYbRnFOc0Q=
 github.com/arl/statsviz v0.8.0 h1:O6GjjVxEDxcByAucOSl29HaGYLXsuwA3ujJw8H9E7/U=
 github.com/arl/statsviz v0.8.0/go.mod h1:XlrbiT7xYT03xaW9JMMfD8KFUhBOESJwfyNJu83PbB0=
 github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=

layouts/beamng.yaml

@@ -1,5 +1,53 @@
 Windows:
+    1:
+        uiwindow:
+            Dims:
+                X0: 170
+                Y0: 136
+                Width: 40
+                Height: 55
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 4
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: '>'
+            Title: ->
+        uidata:
+            WID: 1
+            TelemetryField: Right Indicator
     2:
+        uiwindow:
+            Dims:
+                X0: 341
+                Y0: 417
+                Width: 40
+                Height: 55
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 4
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: A
+            Title: ABS
+        uidata:
+            WID: 2
+            TelemetryField: ABS Dash Light
+    3:
         uiwindow:
             Dims:
                 X0: 470
@@ -21,81 +69,9 @@ Windows:
                 PreviewValue: "9999"
             Title: Dig Tacho
         uidata:
-            WID: 2
+            WID: 3
             TelemetryField: RPM
     4:
-        uiwindow:
-            Dims:
-                X0: 321
-                Y0: 195
-                Width: 134
-                Height: 80
-            Decor:
-                BGColour: 4161
-                FGColour: 65535
-                TitleColour: 65535
-                BorderColour: 63488
-                TitleSize: 2
-                TextSize: 7
-                HasBorder: 1
-                Padding: 0
-            Opts:
-                ShowID: 0
-                WinType: 2
-                PreviewValue: "234"
-            Title: SPEEDO
-        uidata:
-            WID: 4
-            TelemetryField: Speed
-    5:
-        uiwindow:
-            Dims:
-                X0: 590
-                Y0: 367
-                Width: 100
-                Height: 50
-            Decor:
-                BGColour: 4161
-                FGColour: 65535
-                TitleColour: 65535
-                BorderColour: 63488
-                TitleSize: 2
-                TextSize: 3
-                HasBorder: 1
-                Padding: 0
-            Opts:
-                ShowID: 0
-                WinType: 2
-                PreviewValue: "101.5"
-            Title: Water T
-        uidata:
-            WID: 5
-            TelemetryField: Water Temperature
-    10:
-        uiwindow:
-            Dims:
-                X0: 470
-                Y0: 132
-                Width: 169
-                Height: 50
-            Decor:
-                BGColour: 4161
-                FGColour: 65535
-                TitleColour: 65535
-                BorderColour: 63488
-                TitleSize: 2
-                TextSize: 3
-                HasBorder: 1
-                Padding: 0
-            Opts:
-                ShowID: 0
-                WinType: 2
-                PreviewValue: "123.4"
-            Title: Fuel Level
-        uidata:
-            WID: 10
-            TelemetryField: Fuel Level
-    11:
         uiwindow:
             Dims:
                 X0: 321
@@ -117,33 +93,33 @@ Windows:
                 PreviewValue: R
             Title: Box
         uidata:
-            WID: 11
+            WID: 4
             TelemetryField: Gear
-    16:
+    5:
         uiwindow:
             Dims:
-                X0: 694
+                X0: 80
-                Y0: 423
+                Y0: 136
-                Width: 100
+                Width: 40
-                Height: 50
+                Height: 55
             Decor:
                 BGColour: 4161
                 FGColour: 65535
                 TitleColour: 65535
                 BorderColour: 63488
                 TitleSize: 2
-                TextSize: 3
+                TextSize: 4
                 HasBorder: 1
                 Padding: 0
             Opts:
                 ShowID: 0
                 WinType: 2
-                PreviewValue: "4.56"
+                PreviewValue: <
-            Title: Oil P
+            Title: <-
         uidata:
-            WID: 16
+            WID: 5
-            TelemetryField: Oil Pressure
+            TelemetryField: Left Indicator
-    17:
+    6:
         uiwindow:
             Dims:
                 X0: 694
@@ -165,9 +141,177 @@ Windows:
                 PreviewValue: "101.4"
             Title: Oil T
         uidata:
-            WID: 17
+            WID: 6
             TelemetryField: Oil Temperature
-    20:
+    7:
+        uiwindow:
+            Dims:
+                X0: 386
+                Y0: 417
+                Width: 40
+                Height: 55
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 4
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: T
+            Title: TC
+        uidata:
+            WID: 7
+            TelemetryField: Traction Control Light
+    8:
+        uiwindow:
+            Dims:
+                X0: 431
+                Y0: 417
+                Width: 40
+                Height: 55
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 4
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: B
+            Title: Bat
+        uidata:
+            WID: 8
+            TelemetryField: Battery Light
+    9:
+        uiwindow:
+            Dims:
+                X0: 321
+                Y0: 195
+                Width: 134
+                Height: 80
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 7
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: "234"
+            Title: SPEEDO
+        uidata:
+            WID: 9
+            TelemetryField: Speed
+    10:
+        uiwindow:
+            Dims:
+                X0: 590
+                Y0: 367
+                Width: 100
+                Height: 50
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 3
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: "101.5"
+            Title: Water T
+        uidata:
+            WID: 10
+            TelemetryField: Water Temperature
+    11:
+        uiwindow:
+            Dims:
+                X0: 470
+                Y0: 132
+                Width: 169
+                Height: 50
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 3
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: "123.4"
+            Title: Fuel Level
+        uidata:
+            WID: 11
+            TelemetryField: Fuel Level
+    12:
+        uiwindow:
+            Dims:
+                X0: 694
+                Y0: 423
+                Width: 100
+                Height: 50
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 3
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: "4.56"
+            Title: Oil P
+        uidata:
+            WID: 12
+            TelemetryField: Oil Pressure
+    13:
+        uiwindow:
+            Dims:
+                X0: 296
+                Y0: 417
+                Width: 40
+                Height: 55
+            Decor:
+                BGColour: 4161
+                FGColour: 65535
+                TitleColour: 65535
+                BorderColour: 63488
+                TitleSize: 2
+                TextSize: 4
+                HasBorder: 1
+                Padding: 0
+            Opts:
+                ShowID: 0
+                WinType: 2
+                PreviewValue: P
+            Title: HB
+        uidata:
+            WID: 13
+            TelemetryField: Parking Brake Dash Light
+    14:
         uiwindow:
             Dims:
                 X0: 142
@@ -189,5 +333,5 @@ Windows:
                 PreviewValue: "5678"
             Title: TACHO
         uidata:
-            WID: 20
+            WID: 14
             TelemetryField: RPM

logger/logger.go

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

main.go

@@ -15,7 +15,12 @@ import (
 	"github.com/arl/statsviz"
 )
 
+// NOTE: in go we have the init() function. Its a function that runs before
+// everything else in a package. Make use of that
+
 func initApplication() {
+	fmt.Fprint(os.Stdout, "\x1b]0;ESDI\x07")
+
 	// 1. This is the first initialization setup we do so we can log
 	err := setupLogger()
 	if err != nil {

oldEsdi/esdi.go

@@ -54,7 +54,7 @@ func RunLiveTelemetry(port string, output string, session string) {
 	// 	log.Fatalf("Failed to create iRacing interface: %v", err)
 	// }
 
-	irsdk, err := goirsdk.Init(nil, output, session)
+	irsdk, err := goirsdk.Init(goirsdk.Options{})
 	if err != nil {
 		log.Fatalf("Failed to create irsdk instance: %v\n", err)
 	}

providers/beamng/beamng.go

@@ -1,43 +1,211 @@
+// Package beamng is the BeamNG.drive data provider
 package beamng
 
 import (
+	"context"
 	"fmt"
+	"log/slog"
+	"sync"
+	"time"
+
+	"esdi/telemetry"
 
 	bngsdk "github.com/ESilva15/gobngsdk"
 )
 
+// BeamNG is the concrete implementation of the TelemetryProvider interface
+// for BeamNG.drive
+// NOTE: document this please. What is a TelemetryData????
 type BeamNG struct {
-	SDK *bngsdk.BNGSDK
+	SDK *bngsdk.BeamNGSDK
+
+	// data handling
+	mut      sync.Mutex
+	data     *telemetry.TelemetryData
+	updaters [telemetry.MaxFields]func(*telemetry.TelemetryField)
+
+	// stream control
+	streamCh     chan telemetry.TelemetryData
+	streamCancel context.CancelFunc
+
+	// timing
+	ticker *time.Ticker
 }
 
 const (
 	NAME = "BeamNG.drive"
 )
 
-func Init(ip string, port int) (BeamNG, error) {
+func NewBeamNGProvider(ip string, port int) (*BeamNG, error) {
-	var err error
+	beam, err := bngsdk.Init(ip, port)
-
-	sdk, err := bngsdk.Init(ip, port)
 	if err != nil {
-		return BeamNG{}, err
+		return &BeamNG{}, err
 	}
 
-	return BeamNG{SDK: &sdk}, nil
+	provider := &BeamNG{
-}
+		streamCh: make(chan telemetry.TelemetryData, 1),
-
+		data:     telemetry.NewTelemetryData(),
-// GetData will retrieve a given field by its name from the OutGauge data
+		SDK:      &beam,
-func (b *BeamNG) GetData(fieldName string) (interface{}, error) {
+		ticker:   time.NewTicker(time.Second / 60),
-	if val, ok := b.SDK.DataDict[fieldName]; ok {
-		return val, nil
 	}
 
-	return nil, fmt.Errorf("key `%s` doesn't exist", fieldName)
+	provider.updaters = [telemetry.MaxFields]func(*telemetry.TelemetryField){
+		telemetry.Speed:     provider.updateSpeed,
+		telemetry.Gear:      provider.updateGear,
+		telemetry.RPM:       provider.updateRPM,
+		telemetry.FuelLevel: provider.fuelLevel,
+		// Engine Data
+		telemetry.OilPress:  provider.oilPressure,
+		telemetry.OilTemp:   provider.oilTemp,
+		telemetry.WaterTemp: provider.engTemp,
+		// Electrics (dash lights and so on)
+		telemetry.PitSpeedLimiter:   provider.pitSpeedLimiter,
+		telemetry.LeftIndicator:     provider.leftIndicator,
+		telemetry.RightIndicator:    provider.rightIndicator,
+		telemetry.Hazards:           provider.unused,
+		telemetry.ABSWarningLight:   provider.absLight,
+		telemetry.ParkingBrakeLight: provider.handbrakeLight,
+		telemetry.TCLight:           provider.tcLight,
+		telemetry.BatteryLight:      provider.batteryLight,
+	}
+
+	// Set the unset telemetry fields on the updaters as unused fields
+	for k := range int(telemetry.MaxFields) {
+		if provider.updaters[k] == nil {
+			provider.updaters[k] = provider.unused
+		}
+	}
+
+	return provider, nil
 }
 
-func (b *BeamNG) UpdateData() error {
+func (b *BeamNG) StopStream() {
-	return b.SDK.ReadData()
+	if b.streamCancel == nil {
+		return
+	}
+
+	b.streamCancel()
 }
 
-func (b *BeamNG) GetSessionInfo() (interface{}, error) {
+func (b *BeamNG) Stream() (<-chan telemetry.TelemetryData, error) {
-	return nil, fmt.Errorf("Not implemented")
+	var ctx context.Context
+	ctx, b.streamCancel = context.WithCancel(context.Background())
+
+	// Start the stream
+	b.stream(ctx)
+
+	return b.streamCh, nil
+}
+
+func (b *BeamNG) Subscribe(requestFields map[int16]telemetry.FieldID) {
+	// NOTE: document how the Subscribe funtion works
+	slog.Debug(fmt.Sprintf("Len Req: %d\n", len(requestFields)))
+
+	b.data.ActiveBinds = make([]telemetry.BoundField, 0, len(requestFields))
+
+	// First we must add the virtual fields
+	// we will add their dependencies and the primitives to a slice
+	pendingBinds := make([]telemetry.FieldID, telemetry.MaxFields)
+
+	for winID, id := range requestFields {
+		b.data.Values[id].IDs = append(b.data.Values[id].IDs, winID)
+
+		switch id {
+		case telemetry.RPMStateColour:
+			b.data.VirtualBinds = append(b.data.VirtualBinds, telemetry.NewRPMLights())
+		case telemetry.FCCurrentLap:
+			b.data.VirtualBinds = append(b.data.VirtualBinds,
+				telemetry.NewFuelCalculator(slog.Default().WithGroup("FUEL CALC")))
+		default:
+			// primitive telemetry field
+			pendingBinds = append(pendingBinds, id)
+		}
+	}
+
+	boundCheck := make(map[telemetry.FieldID]bool)
+
+	// Now that we know all the fields we need to bind we follow the binding procedure
+	for _, id := range pendingBinds {
+		// Check if we already bound this FieldID
+		if boundCheck[id] {
+			continue
+		}
+
+		binding := telemetry.BoundField{
+			ID: id,
+		}
+
+		b.data.ActiveBinds = append(b.data.ActiveBinds, binding)
+		boundCheck[id] = true
+	}
+
+	slog.Debug(fmt.Sprintf("Subscribed: %+v\n", b.data.ActiveBinds))
+}
+
+// Internal
+
+func (b *BeamNG) readData() {
+	slog.Debug("READING THIS DATA")
+	// BUG: getting stuck in here
+	err := b.SDK.ReadData()
+	slog.Debug("THE DATA WAS READ")
+	if err != nil {
+		slog.Error("Error getting data", "error", err)
+		return
+	}
+
+	b.mut.Lock()
+	defer b.mut.Unlock()
+
+	// Read 1 to 1 data
+	slog.Debug("Reading normal data binds")
+	for _, bind := range b.data.ActiveBinds {
+		slog.Debug("Current bind: ", "id", bind.ID)
+		b.updaters[bind.ID](&b.data.Values[bind.ID])
+	}
+
+	// Set up virtual binds
+	slog.Debug("Entering virtual binds loop")
+	for _, vBind := range b.data.VirtualBinds {
+		// NOTE: delete the logs here, they are really bad
+		slog.Debug("Processing virtual binds")
+		vBind.Process(b.data)
+	}
+
+	b.data.PenultimateDataPoll = b.data.LastDataPoll
+	b.data.LastDataPoll = time.Now()
+}
+
+func (b *BeamNG) stream(ctx context.Context) {
+	b.data.InitialTime = time.Now()
+
+	go func() {
+		for {
+			// Explicitly intercept cancellation
+			select {
+			case <-ctx.Done():
+				return
+			default:
+			}
+
+			// NOTE: add a method to check if there's data available, or make this happen
+
+			select {
+			case <-ctx.Done():
+				return
+			case <-b.ticker.C:
+				slog.Debug("READING DATA")
+				b.readData()
+				slog.Debug("READ DATA")
+
+				// Publish data
+				select {
+				case b.streamCh <- *b.data:
+					slog.Debug("PUBLISHED DATA")
+				default:
+					// skip this data, don't allow publishers to lag behind
+				}
+			}
+		}
+	}()
 }

providers/beamng/transforms.go

@@ -0,0 +1,113 @@
+package beamng
+
+import (
+	"strconv"
+
+	conv "esdi/conversions"
+
+	"esdi/telemetry"
+)
+
+const (
+	LapTimeFormatStr = "04:05.000"
+)
+
+func (b *BeamNG) unused(out *telemetry.TelemetryField) {
+	out.Unused()
+}
+
+func (b *BeamNG) updateSpeed(out *telemetry.TelemetryField) {
+	out.Type = telemetry.DataTypeUINT16
+	out.Raw = uint64(conv.MsToKph(b.SDK.Data.Speed))
+}
+
+func (b *BeamNG) updateGear(out *telemetry.TelemetryField) {
+	out.Type = telemetry.DataTypeSTRING
+	// NOTE: stupid idea but we can cache these values
+	out.Str = strconv.Itoa(int(b.SDK.Data.Gear))
+}
+
+func (b *BeamNG) updateRPM(out *telemetry.TelemetryField) {
+	out.Type = telemetry.DataTypeUINT16
+	out.Raw = uint64(uint16(b.SDK.Data.RPM))
+}
+
+func (b *BeamNG) fuelLevel(out *telemetry.TelemetryField) {
+	telemetry.FloatToStringTransform(b.SDK.Data.Fuel, out)
+}
+
+func (b *BeamNG) oilPressure(out *telemetry.TelemetryField) {
+	telemetry.FloatToStringTransform(b.SDK.Data.OilPressure, out)
+}
+
+func (b *BeamNG) oilTemp(out *telemetry.TelemetryField) {
+	telemetry.FloatToStringTransform(b.SDK.Data.OilTemp, out)
+}
+
+func (b *BeamNG) engTemp(out *telemetry.TelemetryField) {
+	telemetry.FloatToStringTransform(b.SDK.Data.EngTemp, out)
+}
+
+// NOTE: find how to empty this
+func (b *BeamNG) pitSpeedLimiter(out *telemetry.TelemetryField) {
+}
+
+func (b *BeamNG) leftIndicator(out *telemetry.TelemetryField) {
+	chr := ' '
+	if b.SDK.LeftIndicator() {
+		chr = '<'
+	}
+
+	out.Type = telemetry.DataTypeCHAR
+	out.Raw = uint64(chr)
+}
+
+func (b *BeamNG) rightIndicator(out *telemetry.TelemetryField) {
+	chr := ' '
+	if b.SDK.RightIndicator() {
+		chr = '>'
+	}
+
+	out.Type = telemetry.DataTypeCHAR
+	out.Raw = uint64(chr)
+}
+
+func (b *BeamNG) absLight(out *telemetry.TelemetryField) {
+	chr := ' '
+	if b.SDK.ABS() {
+		chr = 'A'
+	}
+
+	out.Type = telemetry.DataTypeCHAR
+	out.Raw = uint64(chr)
+}
+
+func (b *BeamNG) handbrakeLight(out *telemetry.TelemetryField) {
+	chr := ' '
+	if b.SDK.Handbrake() {
+		chr = 'P'
+	}
+
+	out.Type = telemetry.DataTypeCHAR
+	out.Raw = uint64(chr)
+}
+
+func (b *BeamNG) tcLight(out *telemetry.TelemetryField) {
+	chr := ' '
+	if b.SDK.TractionControl() {
+		chr = 'T'
+	}
+
+	out.Type = telemetry.DataTypeCHAR
+	out.Raw = uint64(chr)
+}
+
+func (b *BeamNG) batteryLight(out *telemetry.TelemetryField) {
+	chr := ' '
+	if b.SDK.BatteryLight() {
+		chr = 'B'
+	}
+
+	out.Type = telemetry.DataTypeCHAR
+	out.Raw = uint64(chr)
+}

providers/iracing/commonTransforms.go

@@ -1,72 +0,0 @@
-package iracing
-
-import (
-	telem "esdi/telemetry"
-	"strconv"
-	"time"
-)
-
-const (
-	LapTimeFormatStr = "04:05.000"
-)
-
-func LapTimeTransform(v any, out *telem.TelemetryField) {
-	lapTimeInSeconds := v.(float32)
-
-	if lapTimeInSeconds < 0 {
-		lapTimeInSeconds = 0
-	}
-
-	wholeSeconds := int64(lapTimeInSeconds)
-	lapTime := time.Unix(wholeSeconds, int64((lapTimeInSeconds-float32(wholeSeconds))*1e9))
-
-	out.Type = telem.DataTypeSTRING
-	out.Str = lapTime.Format(LapTimeFormatStr)
-}
-
-func EmptyTransform(v any, out *telem.TelemetryField) {
-	out.Type = telem.DataTypeCHAR
-	out.Raw = uint64('-')
-}
-
-func PitSpeedLimiterTransform(v any, out *telem.TelemetryField) {
-	out.Type = telem.DataTypeSTRING
-	if v.(bool) {
-		out.Str = "PIT"
-	} else {
-		out.Str = "   "
-	}
-}
-
-func UInt8Transform(v any, out *telem.TelemetryField) {
-	out.Type = telem.DataTypeUINT8
-
-	if v == nil {
-		out.Raw = 0
-		return
-	}
-
-	out.Raw = uint64(v.(int))
-}
-
-func FloatToStringTransform(v any, out *telem.TelemetryField) {
-	out.Type = telem.DataTypeSTRING
-
-	if v == nil {
-		out.Str = "inv"
-		return
-	}
-
-	out.Str = strconv.FormatFloat(float64(v.(float32)), 'f', 1, 32)
-}
-
-func FloatToUInt8Transform(v any, out *telem.TelemetryField) {
-	out.Type = telem.DataTypeUINT8
-
-	if v == nil {
-		out.Raw = uint64(0)
-		return
-	}
-
-	out.Raw = uint64(v.(float32))
-}

providers/iracing/iracing.go

@@ -7,13 +7,12 @@ import (
 	"context"
 	"fmt"
 	"log/slog"
-	"os"
 	"strconv"
 	"sync"
 	"time"
 
 	conv "esdi/conversions"
-	telem "esdi/telemetry"
+	"esdi/telemetry"
 
 	"github.com/ESilva15/goirsdk"
 )
@@ -28,51 +27,42 @@ type IRacing struct {
 	SDK    *goirsdk.IBT
 
 	// Data Handling
-	mut  sync.Mutex
+	mut      sync.Mutex
-	data *telem.TelemetryData
+	data     *telemetry.TelemetryData
+	updaters [telemetry.MaxFields]func(*telemetry.TelemetryField)
 
 	// Timing information
 	ticker *time.Ticker // ticker will keep polling intervals constant
 
 	// Stream
-	streamCh     chan telem.TelemetryData
+	streamCh     chan telemetry.TelemetryData
 	streamCancel context.CancelFunc
 }
 
 func NewIRacingProvider(
 	logger *slog.Logger,
-	source string,
+	opts goirsdk.Options,
-	telemOut string,
-	yamlOut string,
 ) (*IRacing, error) {
 	var err error
 
-	// Open the input file if provided - otherwise live telemetry was requested
+	sdk, err := goirsdk.Init(opts)
-	// Maybe this can be changed so we don't have to run it with these ifs but by configuring our
-	// provider
-	var file goirsdk.Reader = nil
-	if source != "" {
-		file, err = os.Open(source)
-		if err != nil {
-			return &IRacing{}, err
-			// log.Fatalf("Failed to open IBT file: %v", err)
-		}
-	}
-
-	sdk, err := goirsdk.Init(file, telemOut, yamlOut)
 	if err != nil {
 		logger.Error("failed to open the IRSDK instance")
 		return &IRacing{}, err
 	}
 
-	return &IRacing{
+	provider := &IRacing{
 		logger:   logger,
 		SDK:      sdk,
-		data:     telem.NewTelemetryData(),
+		data:     telemetry.NewTelemetryData(),
-		streamCh: make(chan telem.TelemetryData, 1),
+		streamCh: make(chan telemetry.TelemetryData, 1),
 		// NOTE: This is because I stupidly recorded a test IBT file in 240
 		ticker: time.NewTicker(time.Second / 240),
-	}, nil
+	}
+
+	// provider.updaters = [telemetry.MaxFields]func(*telemetry.TelemetryField){}
+
+	return provider, nil
 }
 
 func (i *IRacing) isDataAvailable() bool {
@@ -157,7 +147,7 @@ func (i *IRacing) readData() {
 
 // Stream returns a channel that we will use to funnel the telemetry data back to the
 // UI, which then should broadcast it to the devices
-func (i *IRacing) Stream() (<-chan telem.TelemetryData, error) {
+func (i *IRacing) Stream() (<-chan telemetry.TelemetryData, error) {
 	var ctx context.Context
 	ctx, i.streamCancel = context.WithCancel(context.Background())
 
@@ -176,31 +166,31 @@ func (i *IRacing) StopStream() {
 	i.streamCancel = nil
 }
 
-func (i *IRacing) Subscribe(requestFields map[int16]telem.FieldID) {
+func (i *IRacing) Subscribe(requestFields map[int16]telemetry.FieldID) {
 	i.logger.Debug(fmt.Sprintf("Len Req: %d\n", len(requestFields)))
 
-	i.data.ActiveBinds = make([]telem.BoundField, 0, len(requestFields))
+	i.data.ActiveBinds = make([]telemetry.BoundField, 0, len(requestFields))
 
 	// First we must add the virtual fields
 	// we will add their dependencies and the primitives to a slice
-	pendingBinds := make([]telem.FieldID, telem.MaxFields)
+	pendingBinds := make([]telemetry.FieldID, telemetry.MaxFields)
 
 	for winID, id := range requestFields {
 		i.data.Values[id].IDs = append(i.data.Values[id].IDs, winID)
 
 		switch id {
-		case telem.RPMStateColour:
+		case telemetry.RPMStateColour:
-			i.data.VirtualBinds = append(i.data.VirtualBinds, telem.NewRPMLights())
+			i.data.VirtualBinds = append(i.data.VirtualBinds, telemetry.NewRPMLights())
-		case telem.FCCurrentLap:
+		case telemetry.FCCurrentLap:
 			i.data.VirtualBinds = append(i.data.VirtualBinds,
-				telem.NewFuelCalculator(i.logger.WithGroup("FUEL CALC")))
+				telemetry.NewFuelCalculator(i.logger.WithGroup("FUEL CALC")))
 		default:
 			// primitive telemetry field
 			pendingBinds = append(pendingBinds, id)
 		}
 	}
 
-	boundCheck := make(map[telem.FieldID]bool)
+	boundCheck := make(map[telemetry.FieldID]bool)
 
 	// Now that we know all the fields we need to bind we follow the binding procedure
 	for _, id := range pendingBinds {
@@ -217,20 +207,20 @@ func (i *IRacing) Subscribe(requestFields map[int16]telem.FieldID) {
 			continue
 		}
 
-		binding := telem.BoundField{
+		binding := telemetry.BoundField{
 			Key: sdkKey,
 			ID:  id,
 		}
 
 		switch id {
-		case telem.Speed:
+		case telemetry.Speed:
-			binding.Transform = func(v any, out *telem.TelemetryField) {
+			binding.Transform = func(v any, out *telemetry.TelemetryField) {
-				out.Type = telem.DataTypeUINT16
+				out.Type = telemetry.DataTypeUINT16
 				out.Raw = uint64(conv.MsToKph(v.(float32)))
 			}
-		case telem.Gear:
+		case telemetry.Gear:
-			binding.Transform = func(v any, out *telem.TelemetryField) {
+			binding.Transform = func(v any, out *telemetry.TelemetryField) {
-				out.Type = telem.DataTypeCHAR
+				out.Type = telemetry.DataTypeCHAR
 				// out.Raw = uint64(v.(int))
 
 				gear := 0
@@ -253,53 +243,53 @@ func (i *IRacing) Subscribe(requestFields map[int16]telem.FieldID) {
 					out.Raw = uint64('?') // Fallback
 				}
 			}
-		case telem.RPM:
+		case telemetry.RPM:
-			binding.Transform = func(v any, out *telem.TelemetryField) {
+			binding.Transform = func(v any, out *telemetry.TelemetryField) {
-				out.Type = telem.DataTypeUINT16
+				out.Type = telemetry.DataTypeUINT16
 				out.Raw = uint64(uint16(v.(float32)))
 			}
-		case telem.FuelLevel:
+		case telemetry.FuelLevel:
-			binding.Transform = FloatToStringTransform
+			binding.Transform = telemetry.FloatToStringTransformDEPRECATE
 		// Engine Data
-		case telem.OilPress:
+		case telemetry.OilPress:
-			binding.Transform = FloatToStringTransform
+			binding.Transform = telemetry.FloatToStringTransformDEPRECATE
-		case telem.OilTemp:
+		case telemetry.OilTemp:
-			binding.Transform = FloatToStringTransform
+			binding.Transform = telemetry.FloatToStringTransformDEPRECATE
-		case telem.WaterTemp:
+		case telemetry.WaterTemp:
-			binding.Transform = FloatToStringTransform
+			binding.Transform = telemetry.FloatToStringTransformDEPRECATE
 		// Something else
-		case telem.PitSpeedLimiter:
+		case telemetry.PitSpeedLimiter:
 			binding.Transform = PitSpeedLimiterTransform
 		// Adjustements
-		case telem.BrakeBias:
+		case telemetry.BrakeBias:
-			binding.Transform = FloatToStringTransform
+			binding.Transform = telemetry.FloatToStringTransformDEPRECATE
-		case telem.ABSSetting:
+		case telemetry.ABSSetting:
-			binding.Transform = FloatToUInt8Transform
+			binding.Transform = telemetry.FloatToUInt8TransformDEPRECATE
-		case telem.TCSetting:
+		case telemetry.TCSetting:
-			binding.Transform = FloatToUInt8Transform
+			binding.Transform = telemetry.FloatToUInt8TransformDEPRECATE
-		case telem.ThrottleSetting:
+		case telemetry.ThrottleSetting:
-			binding.Transform = FloatToUInt8Transform
+			binding.Transform = telemetry.FloatToUInt8TransformDEPRECATE
-		case telem.LFtempM:
+		case telemetry.LFtempM:
-			binding.Transform = func(v any, out *telem.TelemetryField) {
+			binding.Transform = func(v any, out *telemetry.TelemetryField) {
-				out.Type = telem.DataTypeSTRING
+				out.Type = telemetry.DataTypeSTRING
 				out.Str = strconv.FormatFloat(float64(v.(float32)), 'f', 1, 32)
 			}
-		case telem.SessionTime:
+		case telemetry.SessionTime:
-			binding.Transform = func(v any, out *telem.TelemetryField) {
+			binding.Transform = func(v any, out *telemetry.TelemetryField) {
-				out.Type = telem.DataTypeSTRING
+				out.Type = telemetry.DataTypeSTRING
 				out.Str = strconv.FormatFloat(v.(float64), 'f', 1, 32)
 			}
-		case telem.ReplaySessionTime:
+		case telemetry.ReplaySessionTime:
-			binding.Transform = func(v any, out *telem.TelemetryField) {
+			binding.Transform = func(v any, out *telemetry.TelemetryField) {
-				out.Type = telem.DataTypeSTRING
+				out.Type = telemetry.DataTypeSTRING
 				out.Str = strconv.FormatFloat(v.(float64), 'f', 1, 32)
 			}
-		case telem.Empty:
+		case telemetry.Empty:
-			binding.Transform = EmptyTransform
+			binding.Transform = telemetry.EmptyTransform
-		case telem.LapLastLapTime:
+		case telemetry.LapLastLapTime:
 			binding.Transform = LapTimeTransform
-		case telem.LapNumber:
+		case telemetry.LapNumber:
-			binding.Transform = UInt8Transform
+			binding.Transform = telemetry.UInt8Transform
 		}
 
 		i.data.ActiveBinds = append(i.data.ActiveBinds, binding)

providers/iracing/transforms.go

@@ -0,0 +1,34 @@
+package iracing
+
+import (
+	"time"
+
+	"esdi/telemetry"
+)
+
+const (
+	LapTimeFormatStr = "04:05.000"
+)
+
+func LapTimeTransform(v any, out *telemetry.TelemetryField) {
+	lapTimeInSeconds := v.(float32)
+
+	if lapTimeInSeconds < 0 {
+		lapTimeInSeconds = 0
+	}
+
+	wholeSeconds := int64(lapTimeInSeconds)
+	lapTime := time.Unix(wholeSeconds, int64((lapTimeInSeconds-float32(wholeSeconds))*1e9))
+
+	out.Type = telemetry.DataTypeSTRING
+	out.Str = lapTime.Format(LapTimeFormatStr)
+}
+
+func PitSpeedLimiterTransform(v any, out *telemetry.TelemetryField) {
+	out.Type = telemetry.DataTypeSTRING
+	if v.(bool) {
+		out.Str = "PIT"
+	} else {
+		out.Str = "   "
+	}
+}

providers/providers.go

@@ -7,6 +7,8 @@ import (
 	"esdi/providers/beamng"
 	"esdi/providers/iracing"
 	"esdi/telemetry"
+
+	"github.com/ESilva15/goirsdk"
 )
 
 // Make this be some kind of struct where we can access a function that returns
@@ -25,10 +27,15 @@ var Providers = map[string]Provider{
 	},
 }
 
-func NewIRacingProvider(logger *slog.Logger, source string,
+func NewIRacingProvider(logger *slog.Logger, opts goirsdk.Options,
-	telemOut string, yamlOut string,
 ) telemetry.TelemetryProvider {
-	provider, _ := iracing.NewIRacingProvider(logger, source, "", "")
+	provider, _ := iracing.NewIRacingProvider(logger, opts)
+
+	return provider
+}
+
+func NewBeamNGProvider(ip string, port int) telemetry.TelemetryProvider {
+	provider, _ := beamng.NewBeamNGProvider(ip, port)
 
 	return provider
 }

services/telemetry.go

@@ -7,6 +7,8 @@ import (
 
 	"esdi/providers"
 	telem "esdi/telemetry"
+
+	"github.com/ESilva15/goirsdk"
 )
 
 // TelemetryService will be our base struct to handle telemetry data
@@ -19,7 +21,6 @@ type TelemetryService struct {
 	ativeProvider telem.TelemetryProvider
 	// Channel for the UI
 	listeners     map[string]chan telem.TelemetryData
-	uiOutCh       chan telem.TelemetryData
 	cancelForward context.CancelFunc
 }
 
@@ -27,22 +28,21 @@ func NewTelemetryService(logger *slog.Logger, cdash *CDashService) *TelemetrySer
 	newService := &TelemetryService{
 		logger:    logger,
 		cdash:     cdash,
-		uiOutCh:   make(chan telem.TelemetryData, 5),
 		listeners: make(map[string]chan telem.TelemetryData),
 	}
 
 	// Need to instantiate a default provider here
-	source := "/home/esilva/Desktop/projetos/simracing_peripherals/testTelemetry/gt3_mustang_bathurst.ibt"
+	// source := "/home/esilva/Desktop/projetos/simracing_peripherals/testTelemetry/gt3_mustang_bathurst.ibt"
-	firstProvider := providers.NewIRacingProvider(slog.Default(), source, "", "")
+	firstProvider := providers.NewIRacingProvider(slog.Default(), goirsdk.Options{
+		SourceType: goirsdk.SharedMemoryFile,
+	})
+	// firstProvider := providers.NewBeamNGProvider("127.0.0.1", 4443)
+
 	newService.SwitchProvider(firstProvider)
 
 	return newService
 }
 
-// func (t *TelemetryService) GetUIStream() <-chan telem.TelemetryData {
-// 	return t.uiOutCh
-// }
-
 func (t *TelemetryService) SwitchProvider(newProvider telem.TelemetryProvider) error {
 	t.mut.Lock()
 	defer t.mut.Unlock()

telemetry/commonTransforms.go

@@ -0,0 +1,46 @@
+package telemetry
+
+import "strconv"
+
+func EmptyTransform(v any, out *TelemetryField) {
+	out.Type = DataTypeCHAR
+	out.Raw = uint64('-')
+}
+
+func UInt8Transform(v any, out *TelemetryField) {
+	out.Type = DataTypeUINT8
+
+	if v == nil {
+		out.Raw = 0
+		return
+	}
+
+	out.Raw = uint64(v.(int))
+}
+
+func FloatToStringTransform(v float32, out *TelemetryField) {
+	out.Type = DataTypeSTRING
+	out.Str = strconv.FormatFloat(float64(v), 'f', 1, 32)
+}
+
+func FloatToStringTransformDEPRECATE(v any, out *TelemetryField) {
+	out.Type = DataTypeSTRING
+
+	if v == nil {
+		out.Str = "inv"
+		return
+	}
+
+	out.Str = strconv.FormatFloat(float64(v.(float32)), 'f', 1, 32)
+}
+
+func FloatToUInt8TransformDEPRECATE(v any, out *TelemetryField) {
+	out.Type = DataTypeUINT8
+
+	if v == nil {
+		out.Raw = uint64(0)
+		return
+	}
+
+	out.Raw = uint64(v.(float32))
+}

telemetry/data.go

@@ -27,10 +27,14 @@ type VirtualField interface {
 // NOTE: Update the iracing SDK to write data to the same map ALWAYS, then
 // I can bind that address and read directly from there on the transform
 
+// BoundField is the data structure we use to bind the telemetry provider's data
+// to our internal telemetry fields
 type BoundField struct {
-	Key       string
+	Key       string // NOTE: to be deprecated
 	ID        FieldID
-	Transform func(any, *TelemetryField)
+	Fetch     func() any                 // NOTE: to be deprecated
+	Transform func(any, *TelemetryField) // NOTE: to be deprecated
+	Update    func(out *TelemetryField)
 }
 
 var bufferPool = sync.Pool{
@@ -69,6 +73,11 @@ type TelemetryField struct {
 	Str  string // Only to be used with DataTypeSTRING
 }
 
+func (tf *TelemetryField) Unused() {
+	tf.Type = DataTypeCHAR
+	tf.Raw = uint64('-')
+}
+
 // Pack will pack this current TelemetryField into bytes to send over the wire
 // Format:
 // 0x00 - Field ID
@@ -143,6 +152,14 @@ const (
 	WaterTemp
 	// Engine Warnings
 	PitSpeedLimiter
+	// Electrics (dash lights and so on)
+	LeftIndicator
+	RightIndicator
+	Hazards
+	ABSWarningLight
+	ParkingBrakeLight
+	TCLight
+	BatteryLight
 	// Adjustements
 	BrakeBias
 	ABSSetting
@@ -191,6 +208,14 @@ var FieldNames = [MaxFields]string{
 	WaterTemp: "Water Temperature",
 	// Engine Warnings
 	PitSpeedLimiter: "Pit Speed Limiter",
+	// Electrics (dash lights and so on)
+	LeftIndicator:     "Left Indicator",
+	RightIndicator:    "Right Indicator",
+	Hazards:           "Hazards",
+	ABSWarningLight:   "ABS Dash Light",
+	ParkingBrakeLight: "Parking Brake Dash Light",
+	TCLight:           "Traction Control Light",
+	BatteryLight:      "Battery Light",
 	// Ajustments
 	BrakeBias:       "BrakeBias",
 	ABSSetting:      "ABS Control",

tui/internal/controllers/layout.go

@@ -31,6 +31,7 @@ func NewLayoutController(base *Controller, service *services.CDashService) *Layo
 		Messages:       make(chan string, 10),
 		DevService:     service,
 		MoveToolState:  &windowManipState{Mode: moveMode},
+		// SelectedLayout: "beamng.yaml",
 		SelectedLayout: "layout.yaml",
 	}
 

tui/internal/controllers/streaming.go

@@ -35,7 +35,7 @@ func NewStreamingCtrl(
 	serCDash *services.CDashService,
 	serTelem *services.TelemetryService,
 ) *StreamingCtrl {
-	// NOTE: looks sus
+	// NOTE: looks sus, put this somewhere also. Not very good in here
 	providerList := []providers.Provider{}
 	for _, item := range providers.Providers {
 		providerList = append(providerList, item)