add a timeout setting

Author: ryepup

internal/config/config.go

@@ -3,6 +3,8 @@ package config
 import (
 	"fmt"
 	"io"
+	"os"
+	"time"
 
 	"github.com/lazy-electron-consulting/ve-direct-exporter/internal/util"
 	"gopkg.in/yaml.v2"
@@ -14,21 +16,24 @@ const (
 	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"`
+	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 (m *Serial) defaults() {
-	m.BaudRate = util.Default(m.BaudRate, DefaultBaudRate)
-	m.DataBits = util.Default(m.DataBits, DefaultDataBits)
-	m.StopBits = util.Default(m.StopBits, DefaultStopBits)
-	m.Parity = util.Default(m.Parity, DefaultParity)
+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 {
@@ -61,3 +66,11 @@ func ParseYaml(r io.Reader) (*Config, error) {
 	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_test.go

@@ -3,6 +3,7 @@ package config_test
 import (
 	"embed"
 	"testing"
+	"time"
 
 	"github.com/lazy-electron-consulting/ve-direct-exporter/internal/config"
 	"github.com/stretchr/testify/require"
@@ -28,6 +29,7 @@ func TestParseYaml(t *testing.T) {
 					DataBits: 7,
 					StopBits: 2,
 					Parity:   "Y",
+					Timeout:  time.Hour,
 				},
 				Gauges: []config.Gauge{
 					{
@@ -49,6 +51,7 @@ func TestParseYaml(t *testing.T) {
 					DataBits: config.DefaultDataBits,
 					StopBits: config.DefaultStopBits,
 					Parity:   config.DefaultParity,
+					Timeout:  config.DefaultTimeout,
 				},
 			},
 		},

internal/config/testdata/full.yml

@@ -5,6 +5,7 @@ serial:
   dataBits: 7
   stopBits: 2
   parity: Y
+  timeout: 60m
 gauges:
   - name: "battery_volts"
     help: "Main battery voltage"