cleanup, readme, example ...

Author: sparkoo

README.md

@@ -9,21 +9,12 @@ ACC must be running. Otherwise, `telemetry.Connect()` will fail with an error.
 
 Methods `StaticPointer()`, `PhysicsPointer()` and `GraphicsPointer()` returns pointer to shared memory, so data will change over time. It's up to client code to create snapshot of the data if they wish so.
 
+`RealtimeCarUpdate()` is read from UDP broadcast and it returns instance of latest `RealtimeCarUpdate` state.
+
 ### Example:
-```go
-func main() {
-  telemetry := acctelemetry.New()
-  err := telemetry.Connect()
-  if err != nil {
-    t.Error(fmt.Errorf("unable to connect to ACC: %w", err))
-  }
-
-  // we can run this in loop
-  ticker := time.NewTicker(1 * time.Second)
-  for _ = range ticker.C {
-    fmt.Printf("%+v\n\n", telemetry.StaticPointer())
-    fmt.Printf("%+v\n\n", telemetry.PhysicsPointer())
-    fmt.Printf("%+v\n\n", telemetry.GraphicsPointer())
-  }
-}
-```
+
+see [examples/main.go](examples/main.go)
+
+### Configs:
+
+see [telemetry_config.go](telemetry_config.go)

examples/main.go

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/sparkoo/acctelemetry-go"
+)
+
+func main() {
+	telemetry := acctelemetry.New(acctelemetry.DefaultUdpConfig())
+	err := telemetry.Connect()
+	if err != nil {
+		log.Fatalf("unable to connect to ACC: %s", err)
+	}
+
+	// we can run this in loop
+	ticker := time.NewTicker(1 * time.Second)
+	for _ = range ticker.C {
+		fmt.Printf("%+v\n\n", telemetry.StaticPointer())
+		fmt.Printf("%+v\n\n", telemetry.PhysicsPointer())
+		fmt.Printf("%+v\n\n", telemetry.GraphicsPointer())
+		fmt.Printf("%+v\n\n", telemetry.RealtimeCarUpdate())
+	}
+}

telemetry.go

@@ -3,55 +3,23 @@ package acctelemetry
 import (
 	"fmt"
 	"net"
-	"time"
 	"unsafe"
 )
 
 const STATIC_FILE_MMAP = "Local\\acpmf_static"
 const PHYSICS_FILE_MMAP = "Local\\acpmf_physics"
 const GRAPHIS_FILE_MMAP = "Local\\acpmf_graphics"
 
-type AccTelemetryConfig struct {
-	EnableUdp                   bool
-	UdpIpPort                   string
-	UdpConnectionPassword       string
-	UdpPollRate                 time.Duration
-	udpCommandPassword          string
-	udpDisplayName              string
-	udpRealtimeUpdateIntervalMS int32
-}
-
-func DefaultConfig() *AccTelemetryConfig {
-	return &AccTelemetryConfig{
-		EnableUdp: false,
-	}
-}
-
-func DefaultUdpConfig() *AccTelemetryConfig {
-	return UdpConfig("127.0.0.1:9000", "asd")
-}
-
-func UdpConfig(ipPort string, password string) *AccTelemetryConfig {
-	return &AccTelemetryConfig{
-		EnableUdp:                   true,
-		UdpIpPort:                   ipPort,
-		UdpConnectionPassword:       password,
-		udpCommandPassword:          "",
-		udpDisplayName:              "RaceMate",
-		udpRealtimeUpdateIntervalMS: 100,
-	}
-}
-
 type AccTelemetry struct {
-	config *AccTelemetryConfig
+	config *accTelemetryConfig
 
 	staticData   *accDataHolder[AccStatic]
 	physicsData  *accDataHolder[AccPhysics]
 	graphicsData *accDataHolder[AccGraphic]
 
 	udpConnection *net.UDPConn
 
-	RealtimeCarUpdate *RealtimeCarUpdate
+	realtimeCarUpdate *RealtimeCarUpdate
 }
 
 type accDataHolder[T AccGraphic | AccPhysics | AccStatic] struct {
@@ -127,7 +95,7 @@ func (telemetry *AccTelemetry) connectUdp() error {
 	return nil
 }
 
-func New(config *AccTelemetryConfig) *AccTelemetry {
+func New(config *accTelemetryConfig) *AccTelemetry {
 	return &AccTelemetry{
 		config: config,
 	}
@@ -158,8 +126,8 @@ func (t *AccTelemetry) PhysicsPointer() *AccPhysics {
 }
 
 // returns what is current RealtimeCarUpdate
-func (t *AccTelemetry) ReadUdpMessage() *RealtimeCarUpdate {
-	return t.RealtimeCarUpdate
+func (t *AccTelemetry) RealtimeCarUpdate() *RealtimeCarUpdate {
+	return t.realtimeCarUpdate
 }
 
 func (t *AccTelemetry) Close() error {

telemetry_config.go

@@ -0,0 +1,31 @@
+package acctelemetry
+
+type accTelemetryConfig struct {
+	EnableUdp                   bool
+	UdpIpPort                   string
+	UdpConnectionPassword       string
+	udpCommandPassword          string
+	udpDisplayName              string
+	udpRealtimeUpdateIntervalMS int32
+}
+
+func DefaultConfig() *accTelemetryConfig {
+	return &accTelemetryConfig{
+		EnableUdp: false,
+	}
+}
+
+func DefaultUdpConfig() *accTelemetryConfig {
+	return UdpConfig("127.0.0.1:9000", "asd")
+}
+
+func UdpConfig(ipPort string, password string) *accTelemetryConfig {
+	return &accTelemetryConfig{
+		EnableUdp:                   true,
+		UdpIpPort:                   ipPort,
+		UdpConnectionPassword:       password,
+		udpCommandPassword:          "",
+		udpDisplayName:              "RaceMate",
+		udpRealtimeUpdateIntervalMS: 100,
+	}
+}

telemetry_udp.go

@@ -61,9 +61,9 @@ func (t *AccTelemetry) connect() error {
 			if err == nil {
 				realtimeCarUpdate, createMsgErr := t.createMessage(payload)
 				if createMsgErr != nil {
-					fmt.Printf("failed to create realtime car update message: %s", createMsgErr)
+					fmt.Printf("failed to create realtime car update message: %s\n", createMsgErr)
 				}
-				t.RealtimeCarUpdate = realtimeCarUpdate
+				t.realtimeCarUpdate = realtimeCarUpdate
 			} else {
 				if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
 					fmt.Printf("UDP read timeout, ACC may not be running: %s\n", netErr)
@@ -108,7 +108,7 @@ func (t *AccTelemetry) handshake() error {
 		return fmt.Errorf("failed to read connection response: %w", err)
 	}
 
-	fmt.Printf("Connected to ACC, listen for messages: '%+v'", connectionResult)
+	fmt.Printf("Connected to ACC, listen for messages: '%+v'\n", connectionResult)
 
 	return nil
 }