added error returns to the SendData method on the peripheral interface

Docs/Streaming_Flow.md

@@ -0,0 +1 @@
+# Streaming Flow

devices/cdashdisplay/display.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	helper "esdi/helpers"
+	"esdi/peripheral"
 	"esdi/peripheral/communication"
 	"esdi/peripheral/communication/packets"
 	"esdi/peripheral/types"
@@ -107,10 +108,12 @@ func NewCDashState() *CDashState {
 }
 
 type CDashDisplay struct {
-	WT             *communication.WalkieTalkie
-	State          *CDashState
-	fieldToWindows map[telemetry.FieldID][]int16
-	bufPool        sync.Pool
+	WT                          *communication.WalkieTalkie
+	State                       *CDashState
+	fieldToWindows              map[telemetry.FieldID][]int16
+	bufPool                     sync.Pool
+	failedSends                 int
+	FailedSendsConsecutiveLimit int
 }
 
 // Connect will try to find and connect to the CDashDisplay
@@ -118,7 +121,7 @@ func NewCDashDisplay() (*CDashDisplay, error) {
 	// Look for the port
 	p, err := findDisplayPort()
 	if err != nil {
-		slog.Info("failed to find cdashdisplay port: %s", err.Error())
+		slog.Info("failed to find cdashdisplay port", "reason", err.Error())
 		return nil, err
 	}
 
@@ -132,6 +135,8 @@ func NewCDashDisplay() (*CDashDisplay, error) {
 				return &b
 			},
 		},
+		failedSends:                 0,
+		FailedSendsConsecutiveLimit: 5,
 	}, nil
 }
 
@@ -393,12 +398,12 @@ func (d *CDashDisplay) UnloadLayout() error {
 	return nil
 }
 
-func (d *CDashDisplay) SendData(data *telemetry.TelemetryData) {
+func (d *CDashDisplay) SendData(data *telemetry.TelemetryData) error {
 	packet := d.encodePacket(data)
 
 	bytes, err := helper.StructToBytes(packet)
 	if err != nil {
-		return
+		return peripheral.ErrFailureToPackData
 	}
 
 	curStr := ""
@@ -408,7 +413,6 @@ func (d *CDashDisplay) SendData(data *telemetry.TelemetryData) {
 		curStr += fmt.Sprintf("%02x ", byte)
 
 		if byteCount == 8 {
-			// slog.Debug(curStr)
 			curStr = ""
 			byteCount = 0
 		}
@@ -417,6 +421,11 @@ func (d *CDashDisplay) SendData(data *telemetry.TelemetryData) {
 	// var ack packets.AckPacket
 	err = d.WT.SendCommand(sendDataCMDID, bytes, nil)
 	if err != nil && err != io.EOF {
-		return
+		if d.failedSends == d.FailedSendsConsecutiveLimit {
+			return peripheral.ErrDeviceTimedOut
+		}
+		d.failedSends++
 	}
+
+	return nil
 }

devices/uidevice/device.go

@@ -17,9 +17,9 @@ func NewUIDevice() (peripheral.Peripheral, error) {
 	}, nil
 }
 
-func (uid *UIDevice) SendData(data *telemetry.TelemetryData) {
+func (uid *UIDevice) SendData(data *telemetry.TelemetryData) error {
 	if data == nil {
-		return
+		return peripheral.ErrInvalidData
 	}
 
 	select {
@@ -27,6 +27,8 @@ func (uid *UIDevice) SendData(data *telemetry.TelemetryData) {
 	default:
 		// Drop frame if buffer is full
 	}
+
+	return nil
 }
 
 func (uid *UIDevice) Name() string {

peripheral/errors.go

@@ -0,0 +1,9 @@
+package peripheral
+
+import "errors"
+
+var (
+	ErrInvalidData       = errors.New("invalid data")
+	ErrDeviceTimedOut    = errors.New("device timed out")
+	ErrFailureToPackData = errors.New("failed to pack received data")
+)

peripheral/peripheral.go

@@ -17,7 +17,7 @@ const (
 
 type Peripheral interface {
 	Name() string
-	SendData(*telemetry.TelemetryData)
+	SendData(*telemetry.TelemetryData) error
 	RequiredFields() []telemetry.FieldID
 }
 

providers/beamng/beamng.go

@@ -28,7 +28,7 @@ type BeamNG struct {
 	updaters [telemetry.MaxFields]func(*telemetry.TelemetryField)
 
 	// stream control
-	streamCh     chan telemetry.TelemetryData
+	wg           sync.WaitGroup
 	streamCancel context.CancelFunc
 
 	// timing
@@ -46,12 +46,11 @@ func NewBeamNGProvider(logger *slog.Logger, opts *bngsdk.Options) (*BeamNG, erro
 	}
 
 	provider := &BeamNG{
-		logger:   logger.With("TelemetryProvider", NAME),
-		streamCh: make(chan telemetry.TelemetryData, 1),
-		data:     telemetry.NewTelemetryData(),
-		SDK:      beam,
-		og:       &bngsdk.Outgauge{},
-		ticker:   time.NewTicker(time.Second / 60),
+		logger: logger.With("TelemetryProvider", NAME),
+		data:   telemetry.NewTelemetryData(),
+		SDK:    beam,
+		og:     &bngsdk.Outgauge{},
+		ticker: time.NewTicker(time.Second / 60),
 	}
 
 	provider.updaters = [telemetry.MaxFields]func(*telemetry.TelemetryField){
@@ -110,9 +109,9 @@ func (b *BeamNG) Stream() (<-chan telemetry.TelemetryData, error) {
 	ctx, b.streamCancel = context.WithCancel(context.Background())
 
 	// Start the stream
-	b.stream(ctx)
+	ch := b.stream(ctx)
 
-	return b.streamCh, nil
+	return ch, nil
 }
 
 func (b *BeamNG) Subscribe(requestFields []telemetry.FieldID) {
@@ -162,7 +161,6 @@ func (b *BeamNG) Subscribe(requestFields []telemetry.FieldID) {
 
 func (b *BeamNG) readData() {
 	slog.Debug("READING THIS DATA")
-	// BUG: getting stuck in here
 	ogSnapshot, err := b.SDK.Update()
 	slog.Debug("THE DATA WAS READ")
 	if err != nil {
@@ -193,10 +191,15 @@ func (b *BeamNG) readData() {
 	b.data.LastDataPoll = time.Now()
 }
 
-func (b *BeamNG) stream(ctx context.Context) {
+func (b *BeamNG) stream(ctx context.Context) <-chan telemetry.TelemetryData {
 	b.data.InitialTime = time.Now()
+	outCh := make(chan telemetry.TelemetryData)
+	b.wg.Add(1)
 
 	go func() {
+		defer b.wg.Done()
+		defer close(outCh)
+
 		for {
 			// Explicitly intercept cancellation
 			select {
@@ -205,8 +208,6 @@ func (b *BeamNG) stream(ctx context.Context) {
 			default:
 			}
 
-			// NOTE: add a method to check if there's data available, or make this happen
-
 			select {
 			case <-ctx.Done():
 				return
@@ -217,7 +218,7 @@ func (b *BeamNG) stream(ctx context.Context) {
 
 				// Publish data
 				select {
-				case b.streamCh <- *b.data:
+				case outCh <- *b.data:
 					slog.Debug("PUBLISHED DATA")
 				default:
 					// skip this data, don't allow publishers to lag behind
@@ -225,4 +226,6 @@ func (b *BeamNG) stream(ctx context.Context) {
 			}
 		}
 	}()
+
+	return outCh
 }

providers/iracing/iracing.go

@@ -33,7 +33,8 @@ type IRacing struct {
 	ticker *time.Ticker // ticker will keep polling intervals constant
 
 	// Stream
-	streamCh     chan telemetry.TelemetryData
+	wg sync.WaitGroup
+	// streamCh     chan telemetry.TelemetryData
 	streamCancel context.CancelFunc
 }
 
@@ -50,10 +51,10 @@ func NewIRacingProvider(
 	}
 
 	provider := &IRacing{
-		logger:   logger,
-		SDK:      sdk,
-		data:     telemetry.NewTelemetryData(),
-		streamCh: make(chan telemetry.TelemetryData, 1),
+		logger: logger,
+		SDK:    sdk,
+		data:   telemetry.NewTelemetryData(),
+		// streamCh: make(chan telemetry.TelemetryData, 1),
 		// NOTE: This is because I stupidly recorded a test IBT file in 240
 		// TODO: make this configurable from the user side
 		ticker: time.NewTicker(time.Second / 240),
@@ -129,11 +130,14 @@ func (i *IRacing) isDataAvailable() bool {
 	return true
 }
 
-func (i *IRacing) stream(ctx context.Context) {
+func (i *IRacing) stream(ctx context.Context) <-chan telemetry.TelemetryData {
 	i.data.InitialTime = time.Now()
+	outCh := make(chan telemetry.TelemetryData)
+	i.wg.Add(1)
 
 	go func() {
-		defer close(i.streamCh)
+		defer i.wg.Done()
+		defer close(outCh)
 
 		// Put this into the configuration file
 		consecutiveTimeouts := 0
@@ -153,7 +157,7 @@ func (i *IRacing) stream(ctx context.Context) {
 
 				// Publish data
 				select {
-				case i.streamCh <- *i.data:
+				case outCh <- *i.data:
 				default:
 					// skip this data, don't allow publishers to lag behind
 				}
@@ -169,6 +173,8 @@ func (i *IRacing) stream(ctx context.Context) {
 			}
 		}
 	}()
+
+	return outCh
 }
 
 func (i *IRacing) readData() {
@@ -205,9 +211,9 @@ func (i *IRacing) Stream() (<-chan telemetry.TelemetryData, error) {
 	ctx, i.streamCancel = context.WithCancel(context.Background())
 
 	// Start the stream
-	i.stream(ctx)
+	ch := i.stream(ctx)
 
-	return i.streamCh, nil
+	return ch, nil
 }
 
 func (i *IRacing) StopStream() {
@@ -216,6 +222,7 @@ func (i *IRacing) StopStream() {
 	}
 
 	i.streamCancel()
+	i.wg.Wait()
 	i.streamCancel = nil
 }
 

services/devices.go

@@ -84,14 +84,6 @@ func (ds *DeviceService) FindDevices() {
 	}
 }
 
-// func (ds *DeviceService) SubscribeFields() error {
-// 	for _, dev := range ds.Devices {
-// 		fields := dev.RequiredFields()
-// 	}
-//
-// 	return nil
-// }
-
 func (ds *DeviceService) RegisterDevice(dev peripheral.Peripheral) error {
 	ds.mu.Lock()
 	defer ds.mu.Unlock()
@@ -167,7 +159,11 @@ func (ds *DeviceService) transmit(ctx context.Context) {
 			// the data locked
 			ds.mu.RLock()
 			for _, dev := range ds.Devices {
-				dev.SendData(&data)
+				err := dev.SendData(&data)
+				if err == peripheral.ErrDeviceTimedOut {
+					// What do we do here?
+					// TODO: somehow we need to handle reconnection
+				}
 			}
 			ds.mu.RUnlock()
 

services/telemetry.go

@@ -16,6 +16,8 @@ import (
 type TelemetryService struct {
 	logger     *slog.Logger
 	devService *DeviceService
+	// Streaming
+	isStreaming bool
 	// Concurrency protection
 	mut            sync.RWMutex
 	activeProvider telem.TelemetryProvider
@@ -66,6 +68,92 @@ func (t *TelemetryService) ProviderMonitor(ctx context.Context) {
 	}
 }
 
+// Listener Control [START] ----------------------------------------------------
+
+func (t *TelemetryService) SubscribeListener(id string, bufferSize int) <-chan telem.TelemetryData {
+	t.mut.Lock()
+	defer t.mut.Unlock()
+
+	// NOTE: is this truly necessary?
+	// return the channel if it already exists
+	if ch, exists := t.listeners[id]; exists {
+		return ch
+	}
+
+	ch := make(chan telem.TelemetryData, bufferSize)
+	t.listeners[id] = ch
+
+	t.logger.Info("New stream subscriber registered", "id", id)
+	return ch
+}
+
+func (t *TelemetryService) UnsubscribeListener(id string) {
+	t.mut.Lock()
+	defer t.mut.Unlock()
+
+	if ch, exists := t.listeners[id]; exists {
+		close(ch)
+		delete(t.listeners, id)
+		t.logger.Info("Stream subscriber removed", "id", id)
+	}
+}
+
+func (t *TelemetryService) SubscribeToFields() []telem.FieldID {
+	seen := make(map[telemetry.FieldID]struct{})
+	var allFields []telemetry.FieldID
+
+	for _, dev := range t.devService.Devices {
+		for _, field := range dev.RequiredFields() {
+			if _, exists := seen[field]; !exists {
+				seen[field] = struct{}{}
+				allFields = append(allFields, field)
+			}
+		}
+	}
+
+	t.logger.Debug("requested fields", "fields", allFields)
+	t.activeProvider.Subscribe(allFields)
+
+	return allFields
+}
+
+// Listener Control [END] ------------------------------------------------------
+
+// Provider Control [START] ----------------------------------------------------
+
+func (t *TelemetryService) HasActiveProvider() bool {
+	if t.activeProvider == nil {
+		return false
+	}
+
+	return true
+}
+
+func (t *TelemetryService) dropActiveProvider() {
+	if t.cancelForward != nil {
+		t.cancelForward()
+	}
+
+	t.activeProvider.StopStream()
+	t.activeProvider.Close()
+	t.activeProvider = nil
+}
+
+func (t *TelemetryService) SwitchProvider(newProvider telem.TelemetryProvider) error {
+	t.mut.Lock()
+	defer t.mut.Unlock()
+
+	// Clean up the current to be old provider
+	if t.activeProvider != nil {
+		t.dropActiveProvider()
+	}
+
+	// Assign the new provider
+	t.activeProvider = newProvider
+
+	return nil
+}
+
 func (t *TelemetryService) onProviderHealthCheckFailed() {
 	// Just restart the whole lookup process
 	go t.FindProvider(t.CtxMonitor)
@@ -123,19 +211,46 @@ func (t *TelemetryService) FindProvider(ctx context.Context) {
 	}
 }
 
-func (t *TelemetryService) SwitchProvider(newProvider telem.TelemetryProvider) error {
+// Provider Control [END] ------------------------------------------------------
+
+// Streaming Control [START] ---------------------------------------------------
+
+func (t *TelemetryService) StopStream() {
 	t.mut.Lock()
 	defer t.mut.Unlock()
 
-	// Clean up the current to be old provider
-	if t.activeProvider != nil {
-		t.dropActiveProvider()
+	if t.cancelForward != nil {
+		t.cancelForward()
+		t.cancelForward = nil
 	}
 
-	// Assign the new provider
-	t.activeProvider = newProvider
+	t.activeProvider.StopStream()
+	t.isStreaming = false
+}
 
-	return nil
+func (t *TelemetryService) StartStream() {
+	slog.Debug("Stream started")
+
+	// Start the new stream
+	if t.activeProvider == nil {
+		slog.Debug("there's no active provider. not starting the stream")
+		return
+	}
+
+	// Stop the provider healthcheck
+	t.healthCheckCancel()
+
+	simInCh, _ := t.activeProvider.Stream()
+	// TODO: the provider needs to be able to tell the data has stopped
+	// so we can restart the provider lookup routine
+
+	// Create the context so we can control the lifecycle
+	ctx, cancel := context.WithCancel(context.Background())
+	t.cancelForward = cancel
+
+	// Multiplex this data
+	go t.multiplexData(ctx, simInCh)
+	t.isStreaming = true
 }
 
 func (t *TelemetryService) multiplexData(ctx context.Context, dataCh <-chan telem.TelemetryData) {
@@ -165,101 +280,8 @@ func (t *TelemetryService) multiplexData(ctx context.Context, dataCh <-chan tele
 	}
 }
 
-func (t *TelemetryService) dropActiveProvider() {
-	if t.cancelForward != nil {
-		t.cancelForward()
-	}
-
-	t.activeProvider.StopStream()
-	t.activeProvider.Close()
-	t.activeProvider = nil
+func (t *TelemetryService) IsStreaming() bool {
+	return t.isStreaming
 }
 
-func (t *TelemetryService) SubscribeListener(id string, bufferSize int) <-chan telem.TelemetryData {
-	t.mut.Lock()
-	defer t.mut.Unlock()
-
-	// NOTE: is this truly necessary?
-	// return the channel if it already exists
-	if ch, exists := t.listeners[id]; exists {
-		return ch
-	}
-
-	ch := make(chan telem.TelemetryData, bufferSize)
-	t.listeners[id] = ch
-
-	t.logger.Info("New stream subscriber registered", "id", id)
-	return ch
-}
-
-func (t *TelemetryService) UnsubscribeListener(id string) {
-	t.mut.Lock()
-	defer t.mut.Unlock()
-
-	if ch, exists := t.listeners[id]; exists {
-		close(ch)
-		delete(t.listeners, id)
-		t.logger.Info("Stream subscriber removed", "id", id)
-	}
-}
-
-func (t *TelemetryService) SubscribeToFields() {
-	seen := make(map[telemetry.FieldID]struct{})
-	var allFields []telemetry.FieldID
-
-	for _, dev := range t.devService.Devices {
-		for _, field := range dev.RequiredFields() {
-			if _, exists := seen[field]; !exists {
-				seen[field] = struct{}{}
-				allFields = append(allFields, field)
-			}
-		}
-	}
-
-	t.logger.Debug("requested fields", "fields", allFields)
-	t.activeProvider.Subscribe(allFields)
-}
-
-func (t *TelemetryService) StartStream() {
-	slog.Debug("Stream started")
-
-	// Start the new stream
-	if t.activeProvider == nil {
-		slog.Debug("there's no active provider. not starting the stream")
-		return
-	}
-
-	// Stop the provider healthcheck
-	t.healthCheckCancel()
-
-	simInCh, _ := t.activeProvider.Stream()
-	// TODO: the provider needs to be able to tell the data has stopped
-	// so we can restart the provider lookup routine
-
-	// Create the context so we can control the lifecycle
-	ctx, cancel := context.WithCancel(context.Background())
-	t.cancelForward = cancel
-
-	// Multiplex this data
-	go t.multiplexData(ctx, simInCh)
-}
-
-func (t *TelemetryService) StopStream() {
-	t.mut.Lock()
-	defer t.mut.Unlock()
-
-	if t.cancelForward != nil {
-		t.cancelForward()
-		t.cancelForward = nil
-	}
-
-	t.activeProvider.StopStream()
-}
-
-func (t *TelemetryService) HasActiveProvider() bool {
-	if t.activeProvider == nil {
-		return false
-	}
-
-	return true
-}
+// Streaming Control [END] -----------------------------------------------------

tui/internal/controllers/streaming.go

@@ -18,7 +18,7 @@ import (
 
 type StreamingCtrl struct {
 	*Controller
-	Service     *services.DeviceService
+	DevService  *services.DeviceService
 	StreamView  *views.StreamToolView
 	Messages    chan string
 	Internal    chan string
@@ -45,18 +45,16 @@ func NewStreamingCtrl(
 
 	ctrl := &StreamingCtrl{
 		Controller:  base,
-		Service:     devService,
+		DevService:  devService,
 		TelemServ:   serTelem,
 		Messages:    make(chan string, 10),
 		Internal:    make(chan string, 10),
 		TelemetryCh: make(chan telemetry.TelemetryData, 1),
 		Run:         false,
 		StreamView:  streamView,
-		isRunning:   false,
 	}
 
 	ctrl.registerHooks()
-	// ctrl.subscribeListeners()
 
 	return ctrl
 }
@@ -96,11 +94,11 @@ func (sc *StreamingCtrl) registerHooks() {
 }
 
 func (sc *StreamingCtrl) StartStop() {
-	if sc.isRunning {
+	if sc.TelemServ.IsStreaming() {
 		slog.Info("stopping stream")
 
 		sc.TelemServ.StopStream()
-		sc.Service.StopStream()
+		sc.DevService.StopStream()
 
 		sc.isRunning = false
 		return
@@ -110,9 +108,9 @@ func (sc *StreamingCtrl) StartStop() {
 	// NOTE:
 	// Subscribe the only existing device - needs to be discovered by now
 	slog.Debug("setting the data stream for device servie")
-	sc.Service.SetTelemetryChannel(sc.TelemServ.SubscribeListener("DeviceService", 1))
+	sc.DevService.SetTelemetryChannel(sc.TelemServ.SubscribeListener("DeviceService", 1))
 
-	dev, err := sc.Service.GetDevice(uidevice.NAME)
+	dev, err := sc.DevService.GetDevice(uidevice.NAME)
 	if err == nil {
 		if uiDev, ok := dev.(*uidevice.UIDevice); ok {
 			sc.TelemetryCh = uiDev.DataChannel()
@@ -121,7 +119,7 @@ func (sc *StreamingCtrl) StartStop() {
 	}
 
 	slog.Debug("starting services")
-	sc.Service.StartStream()
+	sc.DevService.StartStream()
 	sc.TelemServ.StartStream()
 
 	sc.isRunning = true
@@ -161,24 +159,11 @@ func (sc *StreamingCtrl) updateStream() {
 // Performance reasoning: this is not used during the high frequency data transmission
 // so we can get away with using a map for convenience here
 func (sc *StreamingCtrl) SetInternalState() {
-	// Acquire the cdashdisplay
-	// displayIF, err := sc.Service.GetDevice(cdashdisplay.NAME)
-	// if err != nil {
-	// 	sc.Messages <- "failed to get " + cdashdisplay.NAME
-	// 	return
-	// }
-	// display, ok := displayIF.(*cdashdisplay.CDashDisplay)
-	// if !ok {
-	// 	sc.Messages <- "failed to acquire " + cdashdisplay.NAME
-	// 	return
-	// }
-	// ---
-
-	sc.TelemServ.SubscribeToFields()
+	fields := sc.TelemServ.SubscribeToFields()
 
 	// sc.Messages <- fmt.Sprintf("Subscribed Fields: %+v [%d]\n", fields, len(fields))
 	// Should I update this?
-	sc.Messages <- fmt.Sprintf("Subscribed to fields\n")
+	sc.Messages <- fmt.Sprintf("Subscribed to fields: %+v", fields)
 }
 
 func (sc *StreamingCtrl) listenToUIStream() {
@@ -190,8 +175,6 @@ func (sc *StreamingCtrl) listenToUIStream() {
 		}
 		isDrawing.Store(true)
 
-		// sc.Logger.Debug("got data", "data", msg)
-
 		// Capture locally
 		telemetryMsg := msg