upd tested against

add macOS badge

.github/workflows/golang-ci.yml

@@ -2,11 +2,11 @@ name: CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ['main']
     paths:
       - '**.go'
   pull_request:
-    branches: [ "main" ]
+    branches: ['main']
     paths:
       - '**.go'
 jobs:
@@ -23,7 +23,8 @@ jobs:
         uses: actions/setup-go@v5
         with:
           go-version: '1.24'
-      - name: Install golangci-lint
-        run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
-      - name: Run golangci-lint
-        run: golangci-lint run ./...
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v9
+        with:
+          version: v2.6.0
+          args: --config .golangci.yml

.golangci.yml

@@ -1,54 +1,125 @@
+version: '2'
+
 run:
-  # timeout for analysis, e.g. 30s, 3m, default is 1m
   timeout: 3m
-  # exclude test files
   tests: true
+  go: '1.24'
 
 linters:
-  # Set to true runs only fast linters.
-  # Good option for 'lint on save', pre-commit hook or CI.
-  fast: true
-
-  disable-all: true
-
   enable:
-    - gosimple
-    - govet
-    - ineffassign
-    - staticcheck
-    - unused
-    - gofmt
-    - gofumpt
-    - misspell
-    - unparam
-    - gosec
-    - asciicheck
-    - errname
-    - gci
-    - godot
-    - goimports
-    - revive
-
-linters-settings:
-  gofmt:
-    rewrite-rules:
-      - pattern: 'interface{}'
-        replacement: 'any'
-      - pattern: 'a[b:len(a)]'
-        replacement: 'a[b:]'
+    # Default enabled linters
+    - errcheck # Check for unchecked errors
+    - govet # Go's built-in vetting tool
+    - ineffassign # Detect ineffectual assignments
+    - staticcheck # Advanced static analysis
+    - unused # Check for unused code
+    # Additional useful linters
+    - misspell # Detect common misspellings
+    - unparam # Check for unused function parameters
+    - gosec # Security checks
+    - asciicheck # Check for non-ASCII characters
+    - errname # Check error variable names
+    - godot # Check for missing periods in comments
+    - revive # Highly configurable linter for style and correctness
+    - gocritic # Detect code issues and suggest improvements
+    - gocyclo # Check for cyclomatic complexity
+    - dupl # Check for code duplication
+    - predeclared # Check for shadowing of predeclared identifiers
+    - copyloopvar # Check for loop variable capture in goroutines
+    - errorlint # Check for common mistakes in error handling
+    - goconst # Check for repeated strings that could be constants
+    - gosmopolitan # Check for non-portable code
 
+  settings:
     misspell:
       locale: UK
 
     errcheck:
       check-type-assertions: true
+      check-blank: true
+
+    revive:
+      rules:
+        # Code quality and style
+        - name: exported
+          arguments:
+            - 'checkPrivateReceivers'
+            - 'sayRepetitiveInsteadOfStutters'
+        - name: var-naming
+        - name: package-comments
+        - name: range-val-in-closure
+        - name: time-naming
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+        - name: empty-block
+        - name: error-return
+        - name: error-strings
+        - name: error-naming
+        - name: if-return
+        - name: increment-decrement
+        - name: indent-error-flow
+        - name: receiver-naming
+        - name: redefines-builtin-id
+        - name: superfluous-else
+        - name: unexported-return
+        - name: unreachable-code
+        - name: unused-parameter
+        - name: var-declaration
+        - name: blank-imports
+        - name: range
+
+        # Disabled rules (can be enabled if needed)
+        # - name: line-length-limit
+        #   arguments: [120]
+        # - name: function-length
+        #   arguments: [50, 0]
+        # - name: cyclomatic
+        #   arguments: [10]
+
+    gosec:
+      excludes:
+        - G104 # Duplicated errcheck checks
+        - G115 # integer overflow conversion int -> uint32
+
+  exclusions:
+    warn-unused: false
+    rules:
+      # Exclude some linters from running on tests files.
+      - path: _test\.go
+        linters:
+          - gocyclo
+          - errcheck
+          - dupl
+          - gosec
+
+# Formatters configuration
+formatters:
+  # Enable specific formatters
+  enable:
+    - gofumpt # Stricter gofmt alternative
+    - goimports # Organizes imports
+    - gci # Controls import order/grouping
+    - golines # Enforces line length
+
+  # Formatter-specific settings
+  settings:
+    goimports:
+      local-prefixes: [github.com/onyx-and-iris/vbantxt]
+
+    gci:
+      # Define import sections order
+      sections:
+        - standard # Standard library
+        - default # Everything else
+        - prefix(github.com/onyx-and-iris/vbantxt) # Current module
+
+    gofumpt:
+      extra-rules: true # Enable additional formatting rules
 
 issues:
-  max-same-issues: 0
-  max-issues-per-linter: 0
-  exclude-use-default: false
-  exclude:
-    # gosec: Duplicated errcheck checks
-    - G104
-    # gosec: integer overflow conversion int -> uint32
-    - G115
+  # Limit the number of same issues reported to avoid spam
+  max-same-issues: 50
+
+  # Limit the number of issues per linter to keep output manageable
+  max-issues-per-linter: 100

CHANGELOG.md

@@ -11,6 +11,17 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+# [0.6.0] - 2025-02-14
+
+### Added
+
+- streamname length validation added to {packet} factory method.
+
+### Changed
+- {packet}.bspIndex now defaults to *indexOf(BpsOpts, 256000)*.
+    -   this doesn't affect the CLI which already defaulted to 256000.
+- WithBPSOpt and WithChannel functional options now log at warn level if passed out of bounds value. They will fallback to valid defaults.
+
 # [0.5.0] - 2025-06-25
 
 ### Added

README.md

@@ -1,5 +1,6 @@
 ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
 ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
 
 # VBAN Sendtext
 
@@ -23,10 +24,10 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.1.1.9
--   Banana 2.1.1.9
--   Potato 3.1.1.9
--   Matrix 1.0.1.2
+-   Basic 1.1.2.2
+-   Banana 2.1.2.2
+-   Potato 3.1.2.2
+-   Matrix 1.0.2.6
 
 ---
 

Taskfile.yml

@@ -9,6 +9,7 @@ vars:
 
   WINDOWS: '{{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe'
   LINUX: '{{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64'
+  MACOS: '{{.BIN_DIR}}/{{.PROGRAM}}_darwin_amd64'
 
 tasks:
   default:
@@ -22,7 +23,7 @@ tasks:
     cmds:
       - task: build-windows
       - task: build-linux
-
+      - task: build-macos
   vet:
     desc: Vet the code
     deps: [fmt]
@@ -38,11 +39,19 @@ tasks:
     desc: Build the vbantxt project for Windows
     cmds:
       - GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.version={{.VERSION}}" ./cmd/{{.PROGRAM}}/
+    internal: true
 
   build-linux:
     desc: Build the vbantxt project for Linux
     cmds:
       - GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.version={{.VERSION}}" ./cmd/{{.PROGRAM}}/
+    internal: true
+
+  build-macos:
+    desc: Build the vbantxt project for macOS
+    cmds:
+      - GOOS=darwin GOARCH=amd64 go build -o {{.MACOS}} -ldflags="-X main.version={{.VERSION}}" ./cmd/{{.PROGRAM}}/
+    internal: true
 
   test:
     desc: Run tests

cmd/vbantxt/main.go

@@ -11,10 +11,11 @@ import (
 	"time"
 
 	"github.com/charmbracelet/log"
-	"github.com/onyx-and-iris/vbantxt"
 	"github.com/peterbourgon/ff/v4"
 	"github.com/peterbourgon/ff/v4/ffhelp"
 	"github.com/peterbourgon/ff/v4/fftoml"
+
+	"github.com/onyx-and-iris/vbantxt"
 )
 
 var version string // Version will be set at build time
@@ -32,16 +33,49 @@ type Flags struct {
 	Version    bool   // Version flag
 }
 
-func exitOnError(err error) {
-	_, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", err)
-	os.Exit(1)
+func (f *Flags) String() string {
+	return fmt.Sprintf(
+		"Host: %s, Port: %d, Streamname: %s, Bps: %d, Channel: %d, Ratelimit: %dms, ConfigPath: %s, Loglevel: %s",
+		f.Host,
+		f.Port,
+		f.Streamname,
+		f.Bps,
+		f.Channel,
+		f.Ratelimit,
+		f.ConfigPath,
+		f.Loglevel,
+	)
 }
 
+// main is the entry point of the application.
+// It sets up a deferred function to handle exiting with the appropriate exit code
+// and calls the run function to execute the main logic.
 func main() {
+	var exitCode int
+
+	// Defer exit with the final exit code
+	defer func() {
+		if exitCode != 0 {
+			os.Exit(exitCode)
+		}
+	}()
+
+	closer, err := run()
+	if closer != nil {
+		defer closer()
+	}
+	if err != nil {
+		log.Error(err)
+		exitCode = 1
+	}
+}
+
+// run contains the main application logic and returns a closer function and any error.
+func run() (func(), error) {
 	var flags Flags
 
 	// VBAN specific flags
-	fs := ff.NewFlagSet("vbantxt")
+	fs := ff.NewFlagSet("vbantxt - A command-line tool for sending text requests over VBAN")
 	fs.StringVar(&flags.Host, 'H', "host", "localhost", "VBAN host")
 	fs.IntVar(&flags.Port, 'p', "port", 6980, "VBAN port")
 	fs.StringVar(&flags.Streamname, 's', "streamname", "Command1", "VBAN stream name")
@@ -51,13 +85,25 @@ func main() {
 
 	configDir, err := os.UserConfigDir()
 	if err != nil {
-		exitOnError(fmt.Errorf("failed to get user config directory: %w", err))
+		return nil, fmt.Errorf("failed to get user config directory: %w", err)
 	}
 	defaultConfigPath := filepath.Join(configDir, "vbantxt", "config.toml")
 
 	// Configuration file and logging flags
-	fs.StringVar(&flags.ConfigPath, 'C', "config", defaultConfigPath, "Path to the configuration file")
-	fs.StringVar(&flags.Loglevel, 'l', "loglevel", "warn", "Log level (debug, info, warn, error, fatal, panic)")
+	fs.StringVar(
+		&flags.ConfigPath,
+		'C',
+		"config",
+		defaultConfigPath,
+		"Path to the configuration file",
+	)
+	fs.StringVar(
+		&flags.Loglevel,
+		'l',
+		"loglevel",
+		"warn",
+		"Log level (debug, info, warn, error, fatal, panic)",
+	)
 	fs.BoolVar(&flags.Version, 'v', "version", "Show version information")
 
 	err = ff.Parse(fs, os.Args[1:],
@@ -69,43 +115,51 @@ func main() {
 	switch {
 	case errors.Is(err, ff.ErrHelp):
 		fmt.Fprintf(os.Stderr, "%s\n", ffhelp.Flags(fs, "vbantxt [flags] <vban commands>"))
-		os.Exit(0)
+		return nil, nil
 	case err != nil:
-		exitOnError(fmt.Errorf("failed to parse flags: %w", err))
+		return nil, fmt.Errorf("failed to parse flags: %w", err)
 	}
 
 	if flags.Version {
-		if version == "" {
-			info, ok := debug.ReadBuildInfo()
-			if !ok {
-				exitOnError(errors.New("failed to read build info"))
-			}
-			version = strings.Split(info.Main.Version, "-")[0]
-		}
-		fmt.Printf("vbantxt version: %s\n", version)
-		os.Exit(0)
+		fmt.Printf("vbantxt version: %s\n", versionFromBuild())
+		return nil, nil
 	}
 
 	level, err := log.ParseLevel(flags.Loglevel)
 	if err != nil {
-		exitOnError(fmt.Errorf("invalid log level: %s", flags.Loglevel))
+		return nil, fmt.Errorf("invalid log level %q", flags.Loglevel)
 	}
 	log.SetLevel(level)
 
-	log.Debugf("Loaded configuration: %+v", flags)
+	log.Debugf("Loaded configuration: %s", flags.String())
 
 	client, closer, err := createClient(&flags)
 	if err != nil {
-		exitOnError(err)
+		return nil, fmt.Errorf("failed to create VBAN client: %w", err)
 	}
-	defer closer()
 
-	for _, arg := range fs.GetArgs() {
-		err := client.Send(arg)
-		if err != nil {
-			log.Error(err)
+	commands := fs.GetArgs()
+	if len(commands) == 0 {
+		return closer, errors.New(
+			"no VBAN commands provided; please provide at least one command as an argument",
+		)
 	}
+	sendCommands(client, commands)
+
+	return closer, nil
 }
+
+// versionFromBuild retrieves the version information from the build metadata.
+func versionFromBuild() string {
+	if version != "" {
+		return version
+	}
+
+	info, ok := debug.ReadBuildInfo()
+	if !ok {
+		return "(unable to read version)"
+	}
+	return strings.Split(info.Main.Version, "-")[0]
 }
 
 // createClient creates a new vban client with the provided options.
@@ -127,5 +181,14 @@ func createClient(flags *Flags) (*vbantxt.VbanTxt, func(), error) {
 		}
 	}
 
-	return client, closer, err
+	return client, closer, nil
+}
+
+// sendCommands sends the provided VBAN commands using the client and logs any errors that occur.
+func sendCommands(client *vbantxt.VbanTxt, commands []string) {
+	for _, cmd := range commands {
+		if err := client.Send(cmd); err != nil {
+			log.Errorf("Failed to send command '%s': %v", cmd, err)
+		}
+	}
 }

go.mod

@@ -1,6 +1,6 @@
 module github.com/onyx-and-iris/vbantxt
 
-go 1.24.2
+go 1.25.0
 
 require (
 	github.com/charmbracelet/log v0.4.2
@@ -10,26 +10,25 @@ require (
 
 require (
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
-	github.com/charmbracelet/colorprofile v0.4.1 // indirect
+	github.com/charmbracelet/colorprofile v0.4.2 // indirect
 	github.com/charmbracelet/lipgloss v1.1.0 // indirect
 	github.com/charmbracelet/x/ansi v0.11.6 // indirect
 	github.com/charmbracelet/x/cellbuf v0.0.15 // indirect
 	github.com/charmbracelet/x/term v0.2.2 // indirect
-	github.com/clipperhouse/displaywidth v0.9.0 // indirect
-	github.com/clipperhouse/stringish v0.1.1 // indirect
-	github.com/clipperhouse/uax29/v2 v2.6.0 // indirect
+	github.com/clipperhouse/displaywidth v0.11.0 // indirect
+	github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-logfmt/logfmt v0.6.1 // indirect
 	github.com/kr/pretty v0.1.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.3.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
-	github.com/mattn/go-runewidth v0.0.19 // indirect
+	github.com/mattn/go-runewidth v0.0.20 // indirect
 	github.com/muesli/termenv v0.16.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.4 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
-	golang.org/x/exp v0.0.0-20260112195511-716be5621a96 // indirect
+	golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa // indirect
 	golang.org/x/sys v0.41.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

go.sum

@@ -1,7 +1,7 @@
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
-github.com/charmbracelet/colorprofile v0.4.1 h1:a1lO03qTrSIRaK8c3JRxJDZOvhvIeSco3ej+ngLk1kk=
-github.com/charmbracelet/colorprofile v0.4.1/go.mod h1:U1d9Dljmdf9DLegaJ0nGZNJvoXAhayhmidOdcBwAvKk=
+github.com/charmbracelet/colorprofile v0.4.2 h1:BdSNuMjRbotnxHSfxy+PCSa4xAmz7szw70ktAtWRYrY=
+github.com/charmbracelet/colorprofile v0.4.2/go.mod h1:0rTi81QpwDElInthtrQ6Ni7cG0sDtwAd4C4le060fT8=
 github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
 github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
 github.com/charmbracelet/log v0.4.2 h1:hYt8Qj6a8yLnvR+h7MwsJv/XvmBJXiueUcI3cIxsyig=
@@ -12,12 +12,10 @@ github.com/charmbracelet/x/cellbuf v0.0.15 h1:ur3pZy0o6z/R7EylET877CBxaiE1Sp1GMx
 github.com/charmbracelet/x/cellbuf v0.0.15/go.mod h1:J1YVbR7MUuEGIFPCaaZ96KDl5NoS0DAWkskup+mOY+Q=
 github.com/charmbracelet/x/term v0.2.2 h1:xVRT/S2ZcKdhhOuSP4t5cLi5o+JxklsoEObBSgfgZRk=
 github.com/charmbracelet/x/term v0.2.2/go.mod h1:kF8CY5RddLWrsgVwpw4kAa6TESp6EB5y3uxGLeCqzAI=
-github.com/clipperhouse/displaywidth v0.9.0 h1:Qb4KOhYwRiN3viMv1v/3cTBlz3AcAZX3+y9OLhMtAtA=
-github.com/clipperhouse/displaywidth v0.9.0/go.mod h1:aCAAqTlh4GIVkhQnJpbL0T/WfcrJXHcj8C0yjYcjOZA=
-github.com/clipperhouse/stringish v0.1.1 h1:+NSqMOr3GR6k1FdRhhnXrLfztGzuG+VuFDfatpWHKCs=
-github.com/clipperhouse/stringish v0.1.1/go.mod h1:v/WhFtE1q0ovMta2+m+UbpZ+2/HEXNWYXQgCt4hdOzA=
-github.com/clipperhouse/uax29/v2 v2.6.0 h1:z0cDbUV+aPASdFb2/ndFnS9ts/WNXgTNNGFoKXuhpos=
-github.com/clipperhouse/uax29/v2 v2.6.0/go.mod h1:Wn1g7MK6OoeDT0vL+Q0SQLDz/KpfsVRgg6W7ihQeh4g=
+github.com/clipperhouse/displaywidth v0.11.0 h1:lBc6kY44VFw+TDx4I8opi/EtL9m20WSEFgwIwO+UVM8=
+github.com/clipperhouse/displaywidth v0.11.0/go.mod h1:bkrFNkf81G8HyVqmKGxsPufD3JhNl3dSqnGhOoSD/o0=
+github.com/clipperhouse/uax29/v2 v2.7.0 h1:+gs4oBZ2gPfVrKPthwbMzWZDaAFPGYK72F0NJv2v7Vk=
+github.com/clipperhouse/uax29/v2 v2.7.0/go.mod h1:EFJ2TJMRUaplDxHKj1qAEhCtQPW2tJSwu5BF98AuoVM=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-logfmt/logfmt v0.6.1 h1:4hvbpePJKnIzH1B+8OR/JPbTx37NktoI9LE2QZBBkvE=
@@ -33,8 +31,8 @@ github.com/lucasb-eyer/go-colorful v1.3.0 h1:2/yBRLdWBZKrf7gB40FoiKfAWYQ0lqNcbuQ
 github.com/lucasb-eyer/go-colorful v1.3.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/mattn/go-runewidth v0.0.19 h1:v++JhqYnZuu5jSKrk9RbgF5v4CGUjqRfBm05byFGLdw=
-github.com/mattn/go-runewidth v0.0.19/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs=
+github.com/mattn/go-runewidth v0.0.20 h1:WcT52H91ZUAwy8+HUkdM3THM6gXqXuLJi9O3rjcQQaQ=
+github.com/mattn/go-runewidth v0.0.20/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs=
 github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
 github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
 github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4=
@@ -49,8 +47,8 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
-golang.org/x/exp v0.0.0-20260112195511-716be5621a96 h1:Z/6YuSHTLOHfNFdb8zVZomZr7cqNgTJvA8+Qz75D8gU=
-golang.org/x/exp v0.0.0-20260112195511-716be5621a96/go.mod h1:nzimsREAkjBCIEFtHiYkrJyT+2uy9YZJB7H1k68CXZU=
+golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa h1:Zt3DZoOFFYkKhDT3v7Lm9FDMEV06GpzjG2jrqW+QTE0=
+golang.org/x/exp v0.0.0-20260218203240-3dfff04db8fa/go.mod h1:K79w1Vqn7PoiZn+TkNpx3BUWUQksGO3JcVX6qIjytmA=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
 golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=

makefile

@@ -5,24 +5,27 @@ BIN_DIR := bin
 
 WINDOWS=$(BIN_DIR)/$(PROGRAM)_windows_amd64.exe
 LINUX=$(BIN_DIR)/$(PROGRAM)_linux_amd64
+MACOS=$(BIN_DIR)/$(PROGRAM)_darwin_amd64
 VERSION=$(shell git describe --tags $(shell git rev-list --tags --max-count=1))
 
 .DEFAULT_GOAL := build
 
-.PHONY: fmt vet build windows linux test clean
+.PHONY: fmt vet build windows linux macos test clean
 fmt:        
 	$(GO) fmt ./...
 
 vet: fmt        
 	$(GO) vet ./...
 
-build: vet windows linux | $(BIN_DIR)
+build: vet windows linux macos | $(BIN_DIR)
 	@echo version: $(VERSION)
 
 windows: $(WINDOWS)
 
 linux: $(LINUX)
 
+macos: $(MACOS)
+
 
 $(WINDOWS):
 	env GOOS=windows GOARCH=amd64 go build -v -o $(WINDOWS) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
@@ -30,6 +33,9 @@ $(WINDOWS):
 $(LINUX):
 	env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
 
+$(MACOS):
+	env GOOS=darwin GOARCH=amd64 go build -v -o $(MACOS) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
+
 test:
 	$(GO) test ./...
 

option.go

@@ -19,18 +19,37 @@ func WithRateLimit(ratelimit time.Duration) Option {
 // WithBPSOpt is a functional option to set the bps index for {VbanTxt}.packet.
 func WithBPSOpt(bps int) Option {
 	return func(vt *VbanTxt) {
+		defaultBps := BpsOpts[vt.packet.bpsIndex]
+
 		bpsIndex := indexOf(BpsOpts, bps)
 		if bpsIndex == -1 {
-			log.Warnf("invalid bps value %d, expected one of %v, defaulting to 0", bps, BpsOpts)
+			log.Warnf(
+				"invalid bps value %d, expected one of %v, defaulting to %d",
+				bps,
+				BpsOpts,
+				defaultBps,
+			)
 			return
 		}
-		vt.packet.bpsIndex = bpsIndex
+		if bpsIndex > 255 {
+			log.Warnf("bps index %d too large for uint8, defaulting to %d", bpsIndex, defaultBps)
+			return
+		}
+		vt.packet.bpsIndex = uint8(bpsIndex)
 	}
 }
 
 // WithChannel is a functional option to set the channel for {VbanTxt}.packet.
 func WithChannel(channel int) Option {
 	return func(vt *VbanTxt) {
-		vt.packet.channel = channel
+		if channel < 0 || channel > 255 {
+			log.Warnf(
+				"channel value %d out of range [0,255], defaulting to %d",
+				channel,
+				vt.packet.channel,
+			)
+			return
+		}
+		vt.packet.channel = uint8(channel)
 	}
 }

packet.go

@@ -3,12 +3,14 @@ package vbantxt
 import (
 	"bytes"
 	"encoding/binary"
+	"fmt"
 
 	"github.com/charmbracelet/log"
 )
 
 const (
 	vbanProtocolTxt = 0x40
+	vbanTxtUtf8     = 0x10
 	streamNameSz    = 16
 	headerSz        = 4 + 1 + 1 + 1 + 1 + 16 + 4
 )
@@ -21,30 +23,44 @@ var BpsOpts = []int{
 }
 
 type packet struct {
-	streamname   []byte
-	bpsIndex     int
-	channel      int
-	framecounter []byte
+	streamname   [streamNameSz]byte
+	bpsIndex     uint8
+	channel      uint8
+	framecounter uint32
 	hbuf         *bytes.Buffer
 }
 
-// newPacket returns a packet struct with default values, framecounter at 0.
-func newPacket(streamname string) packet {
-	streamnameBuf := make([]byte, streamNameSz)
-	copy(streamnameBuf, streamname)
+// newPacket creates a new packet with the given stream name and default values for other fields.
+// It validates the stream name length and ensures the default baud rate is present in BpsOpts.
+func newPacket(streamname string) (packet, error) {
+	if len(streamname) > streamNameSz {
+		return packet{}, fmt.Errorf(
+			"streamname too long: %d chars, max %d",
+			len(streamname),
+			streamNameSz,
+		)
+	}
+
+	var streamnameBuf [streamNameSz]byte
+	copy(streamnameBuf[:], streamname)
+
+	bpsIndex := indexOf(BpsOpts, 256000)
+	if bpsIndex == -1 {
+		return packet{}, fmt.Errorf("default baud rate 256000 not found in BpsOpts")
+	}
 
 	return packet{
 		streamname:   streamnameBuf,
-		bpsIndex:     0,
+		bpsIndex:     uint8(bpsIndex),
 		channel:      0,
-		framecounter: make([]byte, 4),
-		hbuf:         bytes.NewBuffer(make([]byte, headerSz)),
-	}
+		framecounter: 0,
+		hbuf:         bytes.NewBuffer(make([]byte, 0, headerSz)),
+	}, nil
 }
 
 // sr defines the samplerate for the request.
 func (p *packet) sr() byte {
-	return byte(vbanProtocolTxt + p.bpsIndex)
+	return byte(p.bpsIndex | vbanProtocolTxt)
 }
 
 // nbc defines the channel of the request.
@@ -59,16 +75,21 @@ func (p *packet) header() []byte {
 	p.hbuf.WriteByte(p.sr())
 	p.hbuf.WriteByte(byte(0))
 	p.hbuf.WriteByte(p.nbc())
-	p.hbuf.WriteByte(byte(0x10))
-	p.hbuf.Write(p.streamname)
-	p.hbuf.Write(p.framecounter)
+	p.hbuf.WriteByte(byte(vbanTxtUtf8))
+	p.hbuf.Write(p.streamname[:])
+
+	var frameBytes [4]byte
+	binary.LittleEndian.PutUint32(frameBytes[:], p.framecounter)
+	p.hbuf.Write(frameBytes[:])
+
 	return p.hbuf.Bytes()
 }
 
 // bumpFrameCounter increments the frame counter by 1.
+// The uint32 will safely wrap to 0 after reaching max value (4,294,967,295),
+// which is expected behaviour for network protocol sequence numbers.
 func (p *packet) bumpFrameCounter() {
-	x := binary.LittleEndian.Uint32(p.framecounter)
-	binary.LittleEndian.PutUint32(p.framecounter, x+1)
+	p.framecounter++
 
-	log.Debugf("framecounter: %d", x)
+	log.Debugf("framecounter: %d", p.framecounter)
 }

vbantxt.go

@@ -4,26 +4,34 @@ import (
 	"fmt"
 	"io"
 	"time"
+
+	"github.com/charmbracelet/log"
 )
 
 // VbanTxt is used to send VBAN-TXT requests to a distant Voicemeeter/Matrix.
 type VbanTxt struct {
-	udpConn   io.WriteCloser
+	conn      io.WriteCloser
 	packet    packet
 	ratelimit time.Duration
+	lastSend  time.Time
 }
 
 // New constructs a fully formed VbanTxt instance. This is the package's entry point.
 // It sets default values for it's fields and then runs the option functions.
 func New(host string, port int, streamname string, options ...Option) (*VbanTxt, error) {
-	udpConn, err := newUDPConn(host, port)
+	conn, err := newUDPConn(host, port)
 	if err != nil {
 		return nil, fmt.Errorf("error creating UDP client for (%s:%d): %w", host, port, err)
 	}
 
+	packet, err := newPacket(streamname)
+	if err != nil {
+		return nil, fmt.Errorf("error creating packet: %w", err)
+	}
+
 	vt := &VbanTxt{
-		udpConn:   udpConn,
-		packet:    newPacket(streamname),
+		conn:      conn,
+		packet:    packet,
 		ratelimit: time.Duration(20) * time.Millisecond,
 	}
 
@@ -34,24 +42,32 @@ func New(host string, port int, streamname string, options ...Option) (*VbanTxt,
 	return vt, nil
 }
 
-// Send is resonsible for firing each VBAN-TXT request.
-// It waits for {vt.ratelimit} time before returning.
-func (vt VbanTxt) Send(cmd string) error {
-	_, err := vt.udpConn.Write(append(vt.packet.header(), []byte(cmd)...))
+// Send is responsible for firing each VBAN-TXT request.
+// It enforces rate limiting by waiting only when necessary.
+func (vt *VbanTxt) Send(cmd string) error {
+	if elapsed := time.Since(vt.lastSend); elapsed < vt.ratelimit {
+		log.Debugf(
+			"Rate limit in effect. Waiting for %v before sending next command.",
+			vt.ratelimit-elapsed,
+		)
+		time.Sleep(vt.ratelimit - elapsed)
+	}
+
+	vt.lastSend = time.Now()
+
+	_, err := vt.conn.Write(append(vt.packet.header(), cmd...))
 	if err != nil {
 		return fmt.Errorf("error sending command (%s): %w", cmd, err)
 	}
 
 	vt.packet.bumpFrameCounter()
 
-	time.Sleep(vt.ratelimit)
-
 	return nil
 }
 
 // Close is responsible for closing the UDP Client connection.
-func (vt VbanTxt) Close() error {
-	err := vt.udpConn.Close()
+func (vt *VbanTxt) Close() error {
+	err := vt.conn.Close()
 	if err != nil {
 		return fmt.Errorf("error attempting to close UDP Client: %w", err)
 	}

vbantxt_test.go

@@ -7,8 +7,9 @@ import (
 	"os"
 	"testing"
 
-	"github.com/onyx-and-iris/vbantxt"
 	"github.com/stretchr/testify/require"
+
+	"github.com/onyx-and-iris/vbantxt"
 )
 
 //go:embed testdata/vm.txt