Merge pull request #82 from druck13/extended_colours

Extended colours

Author: Gadgetoid

examples/automatic.py

@@ -10,17 +10,17 @@
 
 
 parser = argparse.ArgumentParser()
-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('--low-temp', type=float, default=None, help='Temperature at which the LED is greeen')
+parser.add_argument('--high-temp', type=float, default=None, help='Temperature for which LED is red')
 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')
 parser.add_argument('--nobutton', action='store_true', default=False, help='Disable button input')
 parser.add_argument('--noled', action='store_true', default=False, help='Disable LED control')
 parser.add_argument('--brightness', type=float, default=255.0, help='LED brightness, from 0 to 255')
+parser.add_argument('--extended-colours', action='store_true', default=False, help='Extend LED colours for outside of normal low to high range')
 
 args = parser.parse_args()
 
@@ -35,13 +35,26 @@ def clean_exit(signum, frame):
 def update_led_temperature(temp):
     led_busy.acquire()
     temp = float(temp)
-    temp -= args.off_threshold
-    temp /= float(args.on_threshold - args.off_threshold)
-    temp = max(0, min(1, temp))
-    temp = 1.0 - temp
-    temp *= 120.0
-    temp /= 360.0
-    r, g, b = [int(c * 255.0) for c in colorsys.hsv_to_rgb(temp, 1.0, args.brightness / 255.0)]
+    if temp < args.low_temp and args.extended_colours:
+        # Between minimum temp and low temp, set LED to blue through to green
+        temp -= min_temp
+        temp /= float(args.low_temp - min_temp)
+        temp  = max(0, temp)
+        hue   = (120.0 / 360.0) + ((1.0 - temp) * 120.0 / 360.0)
+    elif temp > args.high_temp and args.extended_colours:
+        # Between high temp and maximum temp, set LED to red through to magenta
+        temp -= args.high_temp
+        temp /= float(max_temp - args.high_temp)
+        temp  = min(1, temp)
+        hue   = 1.0 - (temp * 60.0 / 360.0)
+    else:
+        # In the normal low temp to high temp range, set LED to green through to red
+        temp -= args.low_temp
+        temp /= float(args.high_temp - args.low_temp)
+        temp = max(0, min(1, temp))
+        hue   = (1.0 - temp) * 120.0 / 360.0
+
+    r, g, b = [int(c * 255.0) for c in colorsys.hsv_to_rgb(hue, 1.0, args.brightness / 255.0)]
     fanshim.set_light(r, g, b)
     led_busy.release()
 
@@ -76,14 +89,6 @@ 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)
@@ -93,18 +98,20 @@ def set_automatic(status):
 enable = False
 is_fast = False
 last_change = 0
+min_temp = 30
+max_temp = 85
 signal.signal(signal.SIGTERM, clean_exit)
 
 if args.noled:
     led_busy.acquire()
     fanshim.set_light(0, 0, 0)
     led_busy.release()
 
-t = get_cpu_temp()
-if t >= args.threshold:
-    last_change = get_cpu_temp()
-    set_fan(True)
+if args.low_temp is None:
+    args.low_temp = args.off_threshold
 
+if args.high_temp is None:
+    args.high_temp = args.on_threshold
 
 if not args.nobutton:
     @fanshim.on_release()

examples/button.py

@@ -10,19 +10,17 @@ POSITIONAL_ARGS=()
 NOLED="no"
 NOBUTTON="no"
 BRIGHTNESS=255
+EXTCOLOURS="no"
 PYTHON="python3"
 PIP="pip3"
 PSUTIL_MIN_VERSION="5.6.7"
 
 ON_THRESHOLD_SET=false
 OFF_THRESHOLD_SET=false
 
-OLD_THRESHOLD=""
-OLD_HYSTERESIS=""
-
 SERVICE_PATH=/etc/systemd/system/pimoroni-fanshim.service
 
-USAGE="sudo ./install-service.sh --off-threshold <n> --on-threshold <n> --delay <n> --brightness <n> --venv <python_virtual_environment> (--preempt) (--noled) (--nobutton)"
+USAGE="sudo ./install-service.sh --off-threshold <n> --on-threshold <n> --delay <n> --brightness <n> --low-temp <n> --high-temp <n> --venv <python_virtual_environment> (--preempt) (--noled) (--nobutton) (--extended-colours)"
 
 # Convert Python path to absolute for systemd
 PYTHON=`type -P $PYTHON`
@@ -69,13 +67,13 @@ while [[ $# -gt 0 ]]; do
 		shift
 		shift
 		;;
-	-t|--threshold)
-		OLD_THRESHOLD="error"
+	-G|--low-temp)
+		LOW_TEMP="$2"
 		shift
 		shift
 		;;
-	-h|--hysteresis)
-		OLD_HYSTERESIS="error"
+	-R|--high-temp)
+		HIGH_TEMP="$2"
 		shift
 		shift
 		;;
@@ -96,6 +94,15 @@ while [[ $# -gt 0 ]]; do
 		shift
 		shift
 		;;
+	-x|--extended-colours)
+		if [ "$2" == "yes" ] || [ "$2" == "no" ]; then
+			EXTCOLOURS="$2"
+			shift
+		else
+			EXTCOLOURS="yes"
+		fi
+		shift
+		;;
 	*)
 		if [[ $1 == -* ]]; then
 			printf "Unrecognised option: $1\n";
@@ -132,12 +139,6 @@ 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
@@ -150,6 +151,10 @@ if [ "$NOBUTTON" == "yes" ]; then
 	EXTRA_ARGS+=' --nobutton'
 fi
 
+if [ "$EXTCOLOURS" == "yes" ]; then
+	EXTRA_ARGS+=' --extended-colours'
+fi
+
 if ! [ "$1" == "" ]; then
 	if [ $ON_THRESHOLD_SET ]; then
 		printf "Refusing to overwrite explicitly set On Threshold ($ON_THRESHOLD) with positional argument!\n"
@@ -168,16 +173,26 @@ if ! [ "$2" == "" ]; then
 	(( OFF_THRESHOLD = ON_THRESHOLD - $2 ))
 fi
 
+if [ "$LOW_TEMP" == "" ]; then
+    LOW_TEMP=$OFF_THRESHOLD
+fi
+
+if [ "$HIGH_TEMP" == "" ]; then
+    HIGH_TEMP=$ON_THRESHOLD
+fi
 
 cat << EOF
 Setting up with:
-Off Threshold:  $OFF_THRESHOLD C
-On Threshold:   $ON_THRESHOLD C
-Delay:          $DELAY seconds
-Preempt:        $PREEMPT
-Disable LED:    $NOLED
-Disable Button: $NOBUTTON
-Brightness:     $BRIGHTNESS
+Off Threshold:    $OFF_THRESHOLD C
+On Threshold:     $ON_THRESHOLD C
+Low Temp:         $LOW_TEMP C
+High Temp:        $HIGH_TEMP C
+Delay:            $DELAY seconds
+Preempt:          $PREEMPT
+Disable LED:      $NOLED
+Disable Button:   $NOBUTTON
+Brightness:       $BRIGHTNESS
+Extended Colours: $EXTCOLOURS
 
 To change these options, run:
 $USAGE
@@ -195,7 +210,7 @@ After=multi-user.target
 [Service]
 Type=simple
 WorkingDirectory=$(pwd)
-ExecStart=$PYTHON $(pwd)/automatic.py --on-threshold $ON_THRESHOLD --off-threshold $OFF_THRESHOLD --delay $DELAY --brightness $BRIGHTNESS $EXTRA_ARGS
+ExecStart=$PYTHON $(pwd)/automatic.py --on-threshold $ON_THRESHOLD --off-threshold $OFF_THRESHOLD --low-temp $LOW_TEMP --high-temp $HIGH_TEMP --delay $DELAY --brightness $BRIGHTNESS $EXTRA_ARGS
 Restart=on-failure
 
 [Install]

examples/install-service.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+from fanshim import FanShim
+import time
+import colorsys
+
+fanshim = FanShim()
+fanshim.set_fan(False)
+
+try:
+    for i in range(-10, 21):
+        print("Temp index %d" % i)
+        # Normal temperature range 0 to 1, cold < 0, hot > 1
+        temp = i/10.0
+        if temp < 0.0:
+            # hue of blue through to green
+            hue  = (120.0 / 360.0) - (temp * 120.0 / 360.0)
+        elif temp > 1.0:
+            # hue of red to through to magenta
+            hue = ((1.0 - temp) * 60.0 / 360.0) + 1.0
+        else:
+            # hue of green through to red
+            hue  = (1.0 - temp) * 120.0 / 360.0
+
+        r, g, b = [int(c * 255.0) for c in colorsys.hsv_to_rgb(hue, 1.0, 1.0)]
+        fanshim.set_light(r, g, b)
+
+        time.sleep(1.0)
+
+except KeyboardInterrupt:
+    pass