-quiet flag

Author: tobias-kuendig

README.md

@@ -98,6 +98,16 @@ systemctl --user enable --now hacompanion
 # journalctl --user -xlf -u hacompanion
 ```
 
+## Controlling the output
+
+By default, the companion will log all sent and received messages to the console.
+
+You can reduce the output by using the `-quiet` flag:
+
+```bash
+hacompanion -quiet
+```  
+
 ## Custom scripts
 
 You can add any number of custom scripts in your configuration file.

api/api.go

@@ -127,19 +127,23 @@ type API struct {
 	DeviceName   string
 	client       http.Client
 	Registration Registration
+	quiet        bool
 }
 
-func NewAPI(host, token string, deviceName string) *API {
+func NewAPI(host, token, deviceName string, quiet bool) *API {
 	return &API{
 		Host:       host,
 		Token:      token,
 		DeviceName: deviceName,
 		client:     http.Client{Timeout: 5 * time.Second},
+		quiet:      quiet,
 	}
 }
 
 func (api *API) sendRequest(ctx context.Context, url string, payload []byte) ([]byte, error) {
-	log.Printf("sending to %s: %+v", url, string(payload))
+	if !api.quiet {
+		log.Printf("sending to %s: %+v", url, string(payload))
+	}
 	req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewBuffer(payload))
 	if err != nil {
 		return nil, err
@@ -157,7 +161,9 @@ func (api *API) sendRequest(ctx context.Context, url string, payload []byte) ([]
 	if resp.StatusCode >= 400 {
 		return nil, fmt.Errorf("received invalid status code %d (%s)", resp.StatusCode, body)
 	}
-	log.Printf("received %s", string(body))
+	if !api.quiet {
+		log.Printf("received %s", string(body))
+	}
 	return body, nil
 }
 

entity/sensor.go

@@ -48,6 +48,7 @@ type Sensor struct {
 	Name        string
 	UniqueID    string
 	Unit        string
+	QuietOutput bool
 }
 
 func (s Sensor) String() string {
@@ -62,14 +63,18 @@ func (s Sensor) Update(ctx context.Context, wg *sync.WaitGroup, outputs *Outputs
 		log.Printf("failed to run sensor %s: %s", s, err)
 		return
 	}
-	log.Printf("received Payload for %s: %+v", s.UniqueID, value)
+	if !s.QuietOutput {
+		log.Printf("received Payload for %s: %+v", s.UniqueID, value)
+	}
 	outputs.Add(Output{Sensor: s, Payload: value})
 }
 
 // Invalidate sets the state of the given sensor(s) to unavailable.
 func (s Sensor) Invalidate(outputs *Outputs) {
 	p := NewPayload()
 	p.State = "unavailable"
-	log.Printf("received p for %s: %+v", s.UniqueID, p)
+	if !s.QuietOutput {
+		log.Printf("received p for %s: %+v", s.UniqueID, p)
+	}
 	outputs.Add(Output{Sensor: s, Payload: p})
 }

main.go

@@ -51,10 +51,12 @@ func main() {
 	var hassHost string
 	var deviceName string
 	var configFlag string
+	var quiet bool
 	flag.StringVar(&configFlag, "config", "~/.config/hacompanion.toml", "Path to the config file")
 	flag.StringVar(&hassHost, "host", "", "Home Assistant host")
 	flag.StringVar(&hassToken, "token", "", "Long-lived access token")
 	flag.StringVar(&deviceName, "device-name", "", "Device name")
+	flag.BoolVar(&quiet, "quiet", false, "Disable verbose logging")
 	flag.Parse()
 
 	configFile, err := util.NewHomePath(configFlag)
@@ -136,12 +138,12 @@ func main() {
 	// Build the application kernel.
 	k := Kernel{
 		config: &config,
-		api:    api.NewAPI(hassHost, hassToken, deviceName),
+		api:    api.NewAPI(hassHost, hassToken, deviceName, quiet),
 	}
 
 	// Start the main process.
 	go func() {
-		err = k.Run(context.Background())
+		err = k.Run(context.Background(), quiet)
 		if err != nil {
 			log.Fatalf("failed to start application: %s", err)
 		}
@@ -166,7 +168,7 @@ func main() {
 }
 
 // Run runs the application.
-func (k *Kernel) Run(appCtx context.Context) error {
+func (k *Kernel) Run(appCtx context.Context, quiet bool) error {
 	log.Printf("Starting Desktop Companion version %s", Version)
 	// Create a global application context that is later used for proper shutdowns.
 	ctx, cancel := context.WithCancel(appCtx)
@@ -190,7 +192,7 @@ func (k *Kernel) Run(appCtx context.Context) error {
 	}
 
 	// Parse out all sensors from the config file and register them in Home Assistant.
-	sensors, err := k.buildSensors(k.config)
+	sensors, err := k.buildSensors(k.config, quiet)
 	if err != nil {
 		return fmt.Errorf("failed to build sensors from config: %w", err)
 	}
@@ -259,7 +261,7 @@ func (k *Kernel) Shutdown(ctx context.Context) error {
 }
 
 // buildSensors returns a slice of concrete Sensor types based on the configuration.
-func (k *Kernel) buildSensors(config *Config) ([]entity.Sensor, error) {
+func (k *Kernel) buildSensors(config *Config, quiet bool) ([]entity.Sensor, error) {
 	var sensors []entity.Sensor
 	// Parse default sensor configuration.
 	for key, sensorConfig := range config.Sensors {
@@ -279,6 +281,7 @@ func (k *Kernel) buildSensors(config *Config) ([]entity.Sensor, error) {
 			DeviceClass: data.DeviceClass,
 			Icon:        data.Icon,
 			Unit:        data.Unit,
+			QuietOutput: quiet,
 		})
 	}
 	// Parse custom scripts.