Merge pull request #267 from jwefers/fix/linearPwmAdjustment

WIP: Fix/linear pwm adjustment

Author: markusressel

.github/workflows/go.yml

@@ -22,13 +22,13 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version: '^1.18'
+          go-version: '^1.23'
 
       - name: Run golangci-lint
         uses: golangci/[email protected]
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.54.2
+          version: v1.61.0
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir

Makefile

@@ -7,7 +7,7 @@ PACKAGE    := github.com/markusressel/$(NAME)
 GIT_REV    ?= $(shell git rev-parse --short HEAD)
 SOURCE_DATE_EPOCH ?= $(shell date +%s)
 DATE       ?= $(shell date -u -d @${SOURCE_DATE_EPOCH} +"%Y-%m-%dT%H:%M:%SZ")
-VERSION    ?= 0.8.1
+VERSION    ?= 0.9.0
 
 test:   ## Run all tests
 	@go clean --testcache && go test -v ./...

README.md

@@ -373,7 +373,7 @@ curves:
 
 Unlike the other curve types, this one does not use the average of the sensor data
 to calculate its value, which allows you to create a completely custom behaviour.
-Keep in mind though that the fan controller is also PID based and will also affect
+Keep in mind though that the fan controller may also be PID based which could also affect
 how the curve is applied to the fan.
 
 #### Function
@@ -441,7 +441,7 @@ After successfully verifying your configuration you can launch fan2go from the C
 working as expected. Assuming you put your configuration file in `/etc/fan2go/fan2go.yaml` run:
 
 ```shell
-> fan2go help                                                                                                                                                                              2 (0.032s) < 22:43:49
+> fan2go help
 fan2go is a simple daemon that controls the fans
 on your computer based on temperature sensors.
 
@@ -654,23 +654,62 @@ sensor value.
 
 ## Fan Controllers
 
-Fan speed is controlled by a PID controller per each configured fan. The default
+The speed of a Fan is controlled using a combination of its curve, a control algorithm and the properties of
+the fan controller itself.
+
+The curve is used as the target value for the control algorithm to reach. The control algorithm then calculates the
+next PWM value to apply to the fan to reach this target value. The fan controller then applies this PWM value to the
+fan, while respecting constraints like the minimum and maximum PWM values, as well as the `neverStop` flag.
+
+### Control Algorithms
+
+A control algorithm
+is a function that returns the next PWM value to apply based on the target value calculated by the curve. The simplest
+control algorithm is the direct control algorithm, which simply forwards the target value to the fan.
+
+#### Direct Control Algorithm
+
+The simplest control algorithm is the direct control algorithm. It simply forwards the curve value to the fan
+controller.
+
+```yaml
+fans:
+  - id: some_fan
+    ...
+    controlAlgorithm: direct
+```
+
+This control algorithm can also be used to approach the curve value more slowly:
+
+```yaml
+fans:
+  - id: some_fan
+    ...
+    controlAlgorithm:
+      direct:
+        maxPwmChangePerCycle: 10
+```
+
+### PID Control Algorithm
+
+The PID control algorithm uses a PID loop to approach the target value. The default
 configuration is pretty non-aggressive using the following values:
 
-| P      | I       | D        |
-|--------|---------|----------|
-| `0.03` | `0.002` | `0.0005` |
+| P     | I      | D       |
+|-------|--------|---------|
+| `0.3` | `0.02` | `0.005` |
 
 If you don't like the default behaviour you can configure your own in the config:
 
 ```yaml
 fans:
   - id: some_fan
     ...
-    controlLoop:
-      p: 0.03
-      i: 0.002
-      d: 0.0005
+    controlAlgorithm:
+      pid:
+        p: 0.3
+        i: 0.02
+        d: 0.005
 ```
 
 The loop is advanced at a constant rate, specified by the `controllerAdjustmentTickRate` config option, which

cmd/curve/list.go

@@ -26,7 +26,7 @@ var curveCmd = &cobra.Command{
 
 		err = configuration.Validate(configPath)
 		if err != nil {
-			ui.FatalWithoutStacktrace(err.Error())
+			ui.FatalWithoutStacktrace("configuration validation failed: %v", err)
 		}
 
 		curveConfigsToPrint := []configuration.CurveConfig{}
@@ -146,7 +146,7 @@ func drawGraph(graphValues map[int]float64, caption string) {
 	}
 
 	graph := asciigraph.Plot(values, asciigraph.Height(15), asciigraph.Width(100), asciigraph.Caption(caption))
-	ui.Printfln(graph)
+	ui.Println(graph)
 }
 
 func printFunctionCurveInfo(curve curves.SpeedCurve, config *configuration.FunctionCurveConfig) {
@@ -195,7 +195,7 @@ func printInfoTable(headers []string, rows [][]string) {
 		panic(tableErr)
 	}
 	tableString := buf.String()
-	ui.Printfln(tableString)
+	ui.Println(tableString)
 }
 
 func init() {

cmd/detect.go

@@ -122,9 +122,9 @@ var detectCmd = &cobra.Command{
 				}
 				tableString := buf.String()
 				if idx < (len(tables) - 1) {
-					ui.Printf(tableString)
+					ui.Print(tableString)
 				} else {
-					ui.Printfln(tableString)
+					ui.Println(tableString)
 				}
 			}
 		}

cmd/fan/curve.go

@@ -24,7 +24,7 @@ var curveCmd = &cobra.Command{
 		configuration.LoadConfig()
 		err := configuration.Validate(configPath)
 		if err != nil {
-			ui.FatalWithoutStacktrace(err.Error())
+			ui.FatalWithoutStacktrace("%v", err)
 		}
 
 		persistence := persistence.NewPersistence(configuration.CurrentConfig.DbPath)
@@ -45,7 +45,7 @@ var curveCmd = &cobra.Command{
 
 			pwmData, fanCurveErr := persistence.LoadFanPwmData(fan)
 			if fanCurveErr == nil {
-				_ = fan.AttachFanCurveData(&pwmData)
+				_ = fan.AttachFanRpmCurveData(&pwmData)
 			}
 
 			if idx > 0 {
@@ -54,7 +54,7 @@ var curveCmd = &cobra.Command{
 			}
 
 			// print table
-			ui.Printfln(fan.GetId())
+			ui.Println(fan.GetId())
 			tab := table.Table{
 				Headers: []string{"", ""},
 				Rows: [][]string{
@@ -78,11 +78,11 @@ var curveCmd = &cobra.Command{
 				panic(tableErr)
 			}
 			tableString := buf.String()
-			ui.Printfln(tableString)
+			ui.Println(tableString)
 
 			// print graph
 			if fanCurveErr != nil {
-				ui.Printfln("No fan curve data yet...")
+				ui.Println("No fan curve data yet...")
 				continue
 			}
 
@@ -99,7 +99,7 @@ var curveCmd = &cobra.Command{
 
 			caption := "RPM / PWM"
 			graph := asciigraph.Plot(values, asciigraph.Height(15), asciigraph.Width(100), asciigraph.Caption(caption))
-			ui.Printfln(graph)
+			ui.Println(graph)
 		}
 	},
 }

cmd/fan/fan.go

@@ -35,7 +35,7 @@ func getFan(id string) (fans.Fan, error) {
 	configuration.LoadConfig()
 	err := configuration.Validate(configPath)
 	if err != nil {
-		ui.FatalWithoutStacktrace(err.Error())
+		ui.FatalWithoutStacktrace("%v", err)
 	}
 
 	controllers := hwmon.GetChips()

cmd/fan/init.go

@@ -2,10 +2,10 @@ package fan
 
 import (
 	"github.com/markusressel/fan2go/internal/configuration"
+	"github.com/markusressel/fan2go/internal/control_loop"
 	"github.com/markusressel/fan2go/internal/controller"
 	"github.com/markusressel/fan2go/internal/persistence"
 	"github.com/markusressel/fan2go/internal/ui"
-	"github.com/markusressel/fan2go/internal/util"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -31,12 +31,9 @@ var initCmd = &cobra.Command{
 		fanController := controller.NewFanController(
 			p,
 			fan,
-			*util.NewPidLoop(
-				0.03,
-				0.002,
-				0.0005,
-			),
-			configuration.CurrentConfig.ControllerAdjustmentTickRate)
+			control_loop.NewDirectControlLoop(nil),
+			configuration.CurrentConfig.ControllerAdjustmentTickRate,
+		)
 
 		ui.Info("Deleting existing data for fan '%s'...", fan.GetId())
 

cmd/root.go

@@ -33,7 +33,7 @@ on your computer based on temperature sensors.`,
 		configuration.LoadConfig()
 		err := configuration.Validate(configPath)
 		if err != nil {
-			ui.ErrorAndNotify("Config Validation Error", err.Error())
+			ui.ErrorAndNotify("Config Validation Error: %v", "%v", err)
 			return
 		}
 
@@ -75,6 +75,7 @@ func printHeader() {
 	if err != nil {
 		fmt.Println("fan2go")
 	}
+	ui.Info("Version: %s", global.Version)
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.

cmd/sensor/sensor.go

@@ -52,7 +52,7 @@ func getSensor(id string) (sensors.Sensor, error) {
 	configuration.LoadConfig()
 	err := configuration.Validate(configPath)
 	if err != nil {
-		ui.FatalWithoutStacktrace(err.Error())
+		ui.FatalWithoutStacktrace("%v", err)
 	}
 
 	controllers := hwmon.GetChips()