Merge branch 'burtyb-master'

Author: Gadgetoid

examples/README.md

@@ -19,12 +19,17 @@ Complete example for monitoring temperature and automatic fan control.
 
 The LED should light up Green when the fan is enabled, and Red when it's not.
 
-The script supports three arguments:
+The script supports these arguments:
+
+* `--on-threshold N` the temperature at which to turn the fan on, in degrees C (default 65)
+* `--off-threshold N` the temperature at which to turn the fan off, in degrees C (default 55)
+* `--delay N` the delay between subsequent temperature readings, in seconds (default 2)
+* `--preempt` preemptively kick in the fan when the CPU frequency is raised (default off)
+
+Deprecated arguments
 
 * `--threshold N` the temperature at which the fan should turn on, in degrees C (default 55)
 * `--hysteresis N` the change in temperature needed to trigger a fan state change, in degrees C (default 5)
-* `--delay N` the delay between subsequent temperature readings, in seconds
-* `--preempt` preemptively kick in the fan when the CPU frequency is raised
 
 You can use systemd or crontab to run this example as a fan controller service on your Pi.
 
@@ -43,13 +48,13 @@ sudo systemctl stop pimoroni-fanshim.service
 If you need to change the threshold, hysteresis or delay you can add them as arguments to the installer:
 
 ```
-sudo ./install-service.sh --threshold <threshold> --hysteresis <hysteresis> --delay <delay>
+sudo ./install-service.sh --on-threshold 65 --off-threshold 55 --delay 2
 ```
 
 To enable CPU-frequency based control:
 
 ```
-sudo ./install-service.sh --threshold <threshold> --hysteresis <hysteresis> --delay <delay> --preempt
+sudo ./install-service.sh --on-threshold 65 --off-threshold 55 --delay 2 --preempt
 ```
 
 You can also add `--noled` to disable LED control and/or `--nobutton` to disable button input.

examples/automatic.py

@@ -8,8 +8,11 @@
 
 
 parser = argparse.ArgumentParser()
-parser.add_argument('--threshold', type=float, default=55.0, help='Temperature threshold in degrees C to enable fan')
-parser.add_argument('--hysteresis', type=float, default=5.0, help='Distance from threshold before fan is disabled')
+parser.add_argument('--threshold', type=float, default=-1, help='Temperature threshold in degrees C to enable fan')
+parser.add_argument('--hysteresis', type=float, default=-1, help='Distance from threshold before fan is disabled')
+
+parser.add_argument('--off-threshold', type=float, default=55.0, help='Temperature threshold in degrees C to enable fan')
+parser.add_argument('--on-threshold', type=float, default=65.0, help='Temperature threshold in degrees C to disable fan')
 parser.add_argument('--delay', type=float, default=2.0, help='Delay, in seconds, between temperature readings')
 parser.add_argument('--preempt', action='store_true', default=False, help='Monitor CPU frequency and activate cooling premptively')
 parser.add_argument('--verbose', action='store_true', default=False, help='Output temp and fan status messages')
@@ -21,7 +24,8 @@
 
 def clean_exit(signum, frame):
     set_fan(False)
-    fanshim.set_light(0, 0, 0)
+    if not args.noled:
+        fanshim.set_light(0, 0, 0)
     sys.exit(0)
 
 
@@ -65,6 +69,14 @@ def set_automatic(status):
     last_change = 0
 
 
+if args.threshold > -1 or args.hysteresis > -1:
+    print("""
+The --threshold and --hysteresis parameters have been deprecated.
+Use --on-threshold and --off-threshold instead!
+""")
+    sys.exit(1)
+
+
 fanshim = FanShim()
 fanshim.set_hold_time(1.0)
 fanshim.set_fan(False)
@@ -102,19 +114,31 @@ def held_handler():
 
 signal.signal(signal.SIGTERM, clean_exit)
 
+update_led(fanshim.get_fan())
+enable = False
+is_fast = False
+last_change = 0
+
 try:
     while True:
-        update_led(fanshim.get_fan())
         t = get_cpu_temp()
         f = get_cpu_freq()
+        was_fast = is_fast
+        is_fast = (int(f.current) == int(f.max))
         if args.verbose:
             print("Current: {:05.02f} Target: {:05.02f} Freq {: 5.02f} Automatic: {} On: {}".format(t, args.threshold, f.current / 1000.0, armed, enabled))
-        if abs(last_change - t) > args.hysteresis and armed:
-            enable = (t >= args.threshold)
-            if args.preempt:
-                enable = enable or (int(f.current) == int(f.max))
-            if set_fan(enable):
-                last_change = t
+
+        if args.preempt and is_fast and was_fast:
+            enable = True
+        elif armed:
+            if t >= args.on_threshold:
+                enable = True
+            elif t <= args.off_threshold:
+                enable = False
+
+        if set_fan(enable):
+            last_change = t
+
         time.sleep(args.delay)
 except KeyboardInterrupt:
     pass

examples/install-service.sh

@@ -1,9 +1,16 @@
 #!/bin/bash
-THRESHOLD=55
+ON_THRESHOLD=65
+OFF_THRESHOLD=55
 HYSTERESIS=5
 DELAY=2
 PREEMPT="no"
 POSITIONAL_ARGS=()
+NOLED="no"
+NOBUTTON="no"
+
+OLD_THRESHOLD=""
+OLD_HYSTERESIS=""
+
 SERVICE_PATH=/etc/systemd/system/pimoroni-fanshim.service
 
 if ! [ -f "/usr/bin/python3" ]; then
@@ -42,13 +49,23 @@ while [[ $# -gt 0 ]]; do
 		fi
 		shift
 		;;
+        --on-threshold)
+		ON_THRESHOLD="$2"
+		shift
+		shift
+		;;
+	--off-threshold)
+		OFF_THRESHOLD="$2"
+		shift
+		shift
+		;;
 	-t|--threshold)
-		THRESHOLD="$2"
+		OLD_THRESHOLD="error"
 		shift
 		shift
 		;;
 	-h|--hysteresis)
-		HYSTERESIS="$2"
+		OLD_HYSTERESIS="error"
 		shift
 		shift
 		;;
@@ -67,6 +84,12 @@ set -- "${POSITIONAL_ARGS[@]}"
 
 EXTRA_ARGS=""
 
+if [ "$OLD_THRESHOLD" == "error" ] || [ "$OLD_HYSTERESIS" == "error" ]; then
+	printf "The --threshold and --hysteresis parameters are deprecated.\n"
+	printf "Use --off-threshold and --on-threshold instead.\n"
+	exit 1
+fi
+
 if [ "$PREEMPT" == "yes" ]; then
 	EXTRA_ARGS+=' --preempt'
 fi
@@ -90,15 +113,15 @@ fi
 
 cat << EOF
 Setting up with:
-Threshold: $THRESHOLD C
-Hysteresis: $HYSTERESIS C
+Off Threshold: $OFF_THRESHOLD C
+On Threshold: $ON_THRESHOLD C
 Delay: $DELAY seconds
 Preempt: $PREEMPT
 No LED: $NOLED
 No Button: $NOBUTTON
 
 To change these options, run:
-sudo ./install-service --threshold <n> --hysteresis <n> --delay <n> (--preempt) (--noled) (--nobutton)
+sudo ./install-service.sh --off-threshold <n> --on-threshold <n> --delay <n> (--preempt) (--noled) (--nobutton)
 
 Or edit: $SERVICE_PATH
 
@@ -113,7 +136,7 @@ After=multi-user.target
 [Service]
 Type=simple
 WorkingDirectory=$(pwd)
-ExecStart=$(pwd)/automatic.py --threshold $THRESHOLD --hysteresis $HYSTERESIS --delay $DELAY $EXTRA_ARGS
+ExecStart=$(pwd)/automatic.py --on-threshold $ON_THRESHOLD --off-threshold $OFF_THRESHOLD --delay $DELAY $EXTRA_ARGS
 Restart=on-failure
 
 [Install]