Updated docs, service installer

Author: Gadgetoid

README.md

@@ -1,4 +1,4 @@
-# Fan Shim
+# Fan Shim for Raspberry Pi
 
 [![Build Status](https://travis-ci.com/pimoroni/fanshim-python.svg?branch=master)](https://travis-ci.com/pimoroni/fanshim-python)
 [![Coverage Status](https://coveralls.io/repos/github/pimoroni/fanshim-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/fanshim-python?branch=master)

examples/README.md

@@ -0,0 +1,40 @@
+# led.py
+
+Basic demonstration of Fan Shim's RGB LED. Cycles around the circumference of the Hue/Saturation/Value colourspace.
+
+# button.py
+
+Demonstrates usage of button press, release and hold handlers.
+
+# toggle.py
+
+Demonstrates toggling the fan on and off with the button.
+
+# automatic.py
+
+Complete example for monitoring temperature and automatic fan control.
+
+* A long press on the button will toggle automatic mode off/on
+* A short press - when automatic is off - will toggle the fan
+
+The LED should light up Green when the fan is enabled, and Red when it's not.
+
+The script supports three arguments:
+
+* `--threshold N` the temperature at which the fan should turn on, in degrees C
+* `--hysteresis N` the change in temperature needed to trigger a fan state change, in degrees C
+* `--delay N` the delay between subsequent temperature readings, in seconds
+
+You can use systemd or crontab to run this example as a fan controller service on your Pi.
+
+To use systemd, just run:
+
+```
+sudo ./install-service.sh
+```
+
+You can then stop the fan service with:
+
+```
+sudo systemctl stop pimoroni-fanshim.service
+```

examples/automatic.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from fanshim import FanShim
 import psutil
 import argparse
@@ -35,6 +36,7 @@ def set_automatic(status):
 parser = argparse.ArgumentParser()
 parser.add_argument('--threshold', type=float, default=37.0, help='Temperature threshold in degrees C to enable fan')
 parser.add_argument('--hysteresis', type=float, default=2.0, help='Distance from threshold before fan is disabled')
+parser.add_argument('--delay', type=float, default=2.0, help='Delay, in seconds, between temperature readings')
 
 args = parser.parse_args()
 
@@ -78,6 +80,6 @@ def held_handler():
         if abs(last_change - t) > args.hysteresis and armed:
             if set_fan(t >= args.threshold):
                 last_change = t
-        time.sleep(1.0)
+        time.sleep(args.delay)
 except KeyboardInterrupt:
     pass

examples/button.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 import signal
 from fanshim import FanShim
 

examples/install-service.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+SERVICE_PATH=/etc/systemd/system/pimoroni-fanshim.service
+
+read -r -d '' UNIT_FILE << EOF
+[Unit]
+Description=Fan Shim Service
+After=multi-user.target
+
+[Service]
+Type=simple
+WorkingDirectory=$(pwd)
+ExecStart=$(pwd)/automatic.py --threshold 36
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+echo "Installing psutil"
+pip3 install psutil
+
+echo "Installing service to: $SERVICE_PATH"
+echo "$UNIT_FILE" > $SERVICE_PATH
+systemctl daemon-reload
+systemctl enable pimoroni-fanshim.service
+systemctl start pimoroni-fanshim.service
+systemctl status pimoroni-fanshim.service

examples/led.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 from fanshim import FanShim
 import time
 import colorsys

examples/toggle.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 import signal
 from fanshim import FanShim