staircase: Rename threshold to hysteresis

Author: 0xIO32

internal/configuration/curves.go

@@ -30,8 +30,8 @@ type LinearCurveConfig struct {
 type StaircaseCurveConfig struct {
 	// Sensor is the id of the sensor to use for this curve
 	Sensor string `json:"sensor"`
-	// Threshold is the temperature threshold in degrees
-	Threshold int `json:"threshold"`
+	// Hysteresis configuration
+	Hysteresis HysteresisConfig `json:"hysteresis"`
 	// Steps is a map of temperature to relative speed value (in range of 0..255 or alternatively 0%..100%)
 	// InSteps contains the speed values as strings (like "42" or "11%"), as read from fan2go.yaml
 	InSteps map[int]string `mapstructure:"steps" json:"-"`
@@ -41,6 +41,11 @@ type StaircaseCurveConfig struct {
 	Steps map[int]float64 `json:"steps" mapstructure:"-"`
 }
 
+type HysteresisConfig struct {
+	// Temperature drop threshold in degrees before reducing fan speed
+	Down int `json:"down,omitempty"`
+}
+
 type PidCurveConfig struct {
 	// Sensor is the id of the sensor to use for this curve
 	Sensor string `json:"sensor"`

internal/curves/staircase.go

@@ -37,7 +37,7 @@ func (c *StaircaseSpeedCurve) Evaluate() (value float64, err error) {
 			targetTemp = max(targetTemp, temp)
 		}
 	}
-	if targetTemp < c.LastTemp && (c.LastTemp-int(measured/1000)) < c.Config.Staircase.Threshold {
+	if targetTemp < c.LastTemp && (c.LastTemp-int(measured/1000)) < c.Config.Staircase.Hysteresis.Down {
 		targetTemp = c.LastTemp
 	}
 

internal/curves/staircase_test.go

@@ -12,15 +12,15 @@ import (
 func createStaircaseCurveConfig(
 	id string,
 	sensorId string,
-	threshold int,
+	hysteresis configuration.HysteresisConfig,
 	steps map[int]float64,
 ) (curve configuration.CurveConfig) {
 	curve = configuration.CurveConfig{
 		ID: id,
 		Staircase: &configuration.StaircaseCurveConfig{
-			Sensor:    sensorId,
-			Threshold: threshold,
-			Steps:     steps,
+			Sensor:     sensorId,
+			Hysteresis: hysteresis,
+			Steps:      steps,
 		},
 	}
 	return curve
@@ -38,7 +38,9 @@ func TestStaircaseCurveWithStepsAtMin(t *testing.T) {
 	curveConfig := createStaircaseCurveConfig(
 		"curve",
 		s.GetId(),
-		8,
+		configuration.HysteresisConfig{
+			Down: 8,
+		},
 		map[int]float64{
 			50: 30,
 			60: 100,
@@ -69,7 +71,9 @@ func TestStaircaseCurveWithStepsInMiddle(t *testing.T) {
 	curveConfig := createStaircaseCurveConfig(
 		"curve",
 		s.GetId(),
-		8,
+		configuration.HysteresisConfig{
+			Down: 8,
+		},
 		map[int]float64{
 			50: 30,
 			60: 100,
@@ -121,7 +125,9 @@ func TestStaircaseCurveWithStepsAtMax(t *testing.T) {
 	curveConfig := createStaircaseCurveConfig(
 		"curve",
 		s.GetId(),
-		8,
+		configuration.HysteresisConfig{
+			Down: 8,
+		},
 		map[int]float64{
 			50: 30,
 			60: 100,
@@ -152,7 +158,9 @@ func TestStaircaseCurveWithNegativeTemperatures(t *testing.T) {
 	curveConfig := createStaircaseCurveConfig(
 		"curve_neg",
 		s.GetId(),
-		3,
+		configuration.HysteresisConfig{
+			Down: 3,
+		},
 		map[int]float64{
 			-10: 10,
 			10:  50,
@@ -192,7 +200,9 @@ func TestStaircaseCurveWithStepAtZero(t *testing.T) {
 	curveConfig := createStaircaseCurveConfig(
 		"curve_zero",
 		s.GetId(),
-		5,
+		configuration.HysteresisConfig{
+			Down: 5,
+		},
 		map[int]float64{
 			0:  5,
 			40: 50,