Merge pull request #1 from lazy-electron-consulting/prototype

Prototype

Author: ryepup

.vscode/settings.json

@@ -3,5 +3,12 @@
         "Victron"
     ],
     "go.lintTool": "golangci-lint",
-    "go.testFlags": ["-race"],
+    "go.testFlags": ["-race", "-count=1"],
+    "go.addTags": {
+        "tags": "json,yaml",
+        "options": "json=omitempty,yaml=omitempty",
+        "promptForTags": false,
+        "transform": "camelcase",
+        "template": ""
+    }
 }

README.md

@@ -1,2 +1,18 @@
 # ve-direct-exporter
-prometheus exporter for victron devices using the ve-direct protocol
+
+[Prometheus exporter](https://prometheus.io/docs/instrumenting/exporters/)  for [Victron](https://www.victronenergy.com) devices using the [VE.Direct protocol](https://www.victronenergy.com/live/vedirect_protocol:faq).
+
+## Usage
+
+- download a binary from the github releases or build from source using `make
+  build`
+- connect your computer to a victron device, I'm using a victron brand [VE.Direct to USB interface](https://www.victronenergy.com/accessories/ve-direct-to-usb-interface)
+- run `./vedirect-exporter config.yaml`
+- see your metrics via http
+
+See `configs/` for an example of the config syntax.
+
+## Releasing
+
+- merging to `main` will make new "latest" binaries
+- push a tag w/ `v$SEMVER` to make a versioned binaries

cmd/vedirect_exporter/main.go

@@ -10,6 +10,7 @@ import (
 	"os/signal"
 	"syscall"
 
+	"github.com/lazy-electron-consulting/ve-direct-exporter/internal/config"
 	"github.com/lazy-electron-consulting/ve-direct-exporter/internal/start"
 )
 
@@ -25,9 +26,14 @@ func main() {
 		os.Exit(1)
 	}
 
+	cfg, err := config.ReadYaml(flag.Arg(0))
+	if err != nil {
+		log.Fatalf("could not read config %s: %v", flag.Arg(0), err)
+	}
+
 	ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGHUP, syscall.SIGABRT)
 	defer stop()
-	err := start.Run(ctx)
+	err = start.Run(ctx, cfg)
 	if err != nil && !errors.Is(err, context.Canceled) {
 		log.Fatalf("exiting with errors %v\n", err)
 	}

configs/smartshunt500.yml

@@ -0,0 +1,19 @@
+serial:
+  path: /dev/ttyUSB0
+  baudRate: 19200
+  dataBits: 8
+  stopBits: 1
+  parity: N
+subsystem: smart_shunt
+gauges:
+  - name: battery_volts
+    help: Main battery voltage
+    label: V 
+    multiplier: 0.001
+  - name: battery_amps
+    help: Main battery current
+    label: I 
+    multiplier: 0.001
+  - name: time_remaining_minutes
+    help: How long until the battery is empty
+    label: TTG

go.mod

@@ -1,3 +1,28 @@
 module github.com/lazy-electron-consulting/ve-direct-exporter
 
 go 1.18
+
+require (
+	github.com/goburrow/serial v0.1.0
+	github.com/stretchr/testify v1.7.1
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.1.2 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
+	github.com/prometheus/client_model v0.2.0 // indirect
+	github.com/prometheus/common v0.32.1 // indirect
+	github.com/prometheus/procfs v0.7.3 // indirect
+	golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
+	google.golang.org/protobuf v1.26.0 // indirect
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_golang v1.12.1
+	gopkg.in/yaml.v2 v2.4.0
+	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+)

go.sum

@@ -0,0 +1,84 @@
+package config
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"time"
+
+	"github.com/lazy-electron-consulting/ve-direct-exporter/internal/util"
+	"gopkg.in/yaml.v2"
+)
+
+const (
+	DefaultAddress  = ":8000"
+	DefaultBaudRate = 19200
+	DefaultDataBits = 8
+	DefaultStopBits = 1
+	DefaultParity   = "N"
+	DefaultTimeout  = 5 * time.Second
+)
+
+type Serial struct {
+	Path     string        `json:"path,omitempty" yaml:"path,omitempty"`
+	BaudRate int           `json:"baudRate,omitempty" yaml:"baudRate,omitempty"`
+	DataBits int           `json:"dataBits,omitempty" yaml:"dataBits,omitempty"`
+	StopBits int           `json:"stopBits,omitempty" yaml:"stopBits,omitempty"`
+	Parity   string        `json:"parity,omitempty" yaml:"parity,omitempty"`
+	Timeout  time.Duration `json:"timeout,omitempty" yaml:"timeout,omitempty"`
+}
+
+func (s *Serial) defaults() {
+	s.BaudRate = util.Default(s.BaudRate, DefaultBaudRate)
+	s.DataBits = util.Default(s.DataBits, DefaultDataBits)
+	s.StopBits = util.Default(s.StopBits, DefaultStopBits)
+	s.Parity = util.Default(s.Parity, DefaultParity)
+	s.Timeout = util.Default(s.Timeout, DefaultTimeout)
+}
+
+type Gauge struct {
+	Name       string  `json:"name,omitempty" yaml:"name,omitempty"`
+	Label      string  `json:"label,omitempty" yaml:"label,omitempty"`
+	Help       string  `json:"help,omitempty" yaml:"help,omitempty"`
+	Multiplier float64 `json:"multiplier,omitempty" yaml:"multiplier,omitempty"`
+}
+
+func (g *Gauge) defaults() {
+	g.Multiplier = util.Default(g.Multiplier, 1)
+}
+
+type Config struct {
+	Address   string  `json:"address,omitempty" yaml:"address,omitempty"`
+	Subsystem string  `json:"subsystem,omitempty" yaml:"subsystem,omitempty"`
+	Serial    Serial  `json:"serial,omitempty" yaml:"serial,omitempty"`
+	Gauges    []Gauge `json:"gauges,omitempty" yaml:"gauges,omitempty"`
+}
+
+func (c *Config) defaults() {
+	c.Address = util.Default(c.Address, DefaultAddress)
+	c.Serial.defaults()
+	for i, g := range c.Gauges {
+		g.defaults()
+		c.Gauges[i] = g
+	}
+}
+
+func ParseYaml(r io.Reader) (*Config, error) {
+	decoder := yaml.NewDecoder(r)
+	decoder.SetStrict(true)
+
+	var config Config
+	if err := decoder.Decode(&config); err != nil {
+		return nil, fmt.Errorf("failed to parse: %w", err)
+	}
+	config.defaults()
+	return &config, nil
+}
+
+func ReadYaml(path string) (*Config, error) {
+	f, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	return ParseYaml(f)
+}

internal/config/config.go

@@ -0,0 +1,79 @@
+package config_test
+
+import (
+	"embed"
+	"testing"
+	"time"
+
+	"github.com/lazy-electron-consulting/ve-direct-exporter/internal/config"
+	"github.com/stretchr/testify/require"
+)
+
+//go:embed testdata
+var testdata embed.FS
+
+func TestParseYaml(t *testing.T) {
+	t.Parallel()
+
+	tests := map[string]struct {
+		path string
+		want *config.Config
+	}{
+		"full": {
+			path: "testdata/full.yml",
+			want: &config.Config{
+				Address: ":9090",
+				Serial: config.Serial{
+					Path:     "/dev/ttyUSB0",
+					BaudRate: 9600,
+					DataBits: 7,
+					StopBits: 2,
+					Parity:   "Y",
+					Timeout:  time.Hour,
+				},
+				Subsystem: "test",
+				Gauges: []config.Gauge{
+					{
+						Name:       "battery_volts",
+						Help:       "Main battery voltage",
+						Label:      "V",
+						Multiplier: 0.01,
+					},
+				},
+			},
+		},
+		"empty": {
+			path: "testdata/empty.yml",
+			want: &config.Config{
+				Address: config.DefaultAddress,
+				Serial: config.Serial{
+					Path:     "/dev/ttyUSB1",
+					BaudRate: config.DefaultBaudRate,
+					DataBits: config.DefaultDataBits,
+					StopBits: config.DefaultStopBits,
+					Parity:   config.DefaultParity,
+					Timeout:  config.DefaultTimeout,
+				},
+				Gauges: []config.Gauge{
+					{
+						Name:       "foo",
+						Multiplier: 1,
+					},
+				},
+			},
+		},
+	}
+	for name, tc := range tests {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			file, err := testdata.Open(tc.path)
+			require.NoError(t, err)
+
+			got, err := config.ParseYaml(file)
+			require.NoError(t, err)
+			require.EqualValues(t, tc.want, got)
+		})
+	}
+}

internal/config/config_test.go

@@ -0,0 +1,4 @@
+serial:
+  path: /dev/ttyUSB1
+gauges:
+  - name: foo

internal/config/testdata/empty.yml

@@ -0,0 +1,14 @@
+address: :9090
+serial:
+  path: /dev/ttyUSB0
+  baudRate: 9600
+  dataBits: 7
+  stopBits: 2
+  parity: Y
+  timeout: 60m
+subsystem: test
+gauges:
+  - name: battery_volts
+    help: Main battery voltage
+    label: V
+    multiplier: 0.01