inital commit

README.md

@@ -1,3 +1,20 @@
-# PyFan
+## PyFAN
 
-Fan control based on hwmon and pir.
+This simple python script utilizes PID as base for fan control.
+
+# Usage
+
+Put your config in /etc/pyfan (reference example config) and enable pyfan as a service (service file also available here).
+
+# Config
+
+To know which hwmon is what device and what pwm controls what fan, the following commands can help you:
+
+List all devices + names:
+```tail /sys/class/hwmon/hwmon*/name```
+
+Enable control for a specific pwm: ```echo 1 > /sys/class/hwmon/hwmonX/pwmX_enable```
+
+Set fan speed: ```echo [0-255] > /sys/class/hwmon/hwmonX/pwmX```
+
+After you have figured out which fan is controlled by what pwm, you can adjust your config. You can have as many thermal zones as you want, just repeate them like shown.