Skip to content

Commit 25eebc4

Browse files
committed
Added a README file for the Pi fan control script.
1 parent 011c9df commit 25eebc4

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

pi_fancontrol/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# 🌀 Raspberry Pi Fan Controller Installer
2+
3+
A Bash-based installer for a Python-powered fan controller on Raspberry Pi, designed for Debian-based systems (e.g. Raspberry Pi OS). It sets up a systemd service to automatically manage your fan based on CPU temperature.
4+
5+
## 📦 Features
6+
7+
- Installs a lightweight Python script to control a GPIO-connected fan
8+
- Automatically starts the fan controller using systemd
9+
- Monitors CPU temperature and toggles fan based on thresholds
10+
- Logs installation output to `/var/log/pi_fancontroller.log`
11+
- Includes a clean uninstall option
12+
13+
## 🛠️ Requirements
14+
15+
- Raspberry Pi running a Debian-based OS (e.g. Raspberry Pi OS)
16+
- GPIO-connected fan (default GPIO pin: 17)
17+
**NOTE: Do NOT connect the fan directly to the GPIO pins, a transistor circuit must be used**
18+
- Python 3 installed
19+
- `gpiozero` Python library (installed automatically if missing)
20+
- Must be run as root (use `sudo`)
21+
22+
## 🚀 Installation
23+
Make new file on your Raspberry Pi:
24+
*nano pi_fancontrol.sh*
25+
Copy and paste the contents of:
26+
https://github.com/SilentWoof/Scripts/tree/main/shell_scripts/pi_fancontrol/pi_fancontrol.sh
27+
into the new file.
28+
Make the file execuutable:
29+
*sudo chmod +x pi_fancontrol.sh*
30+
Run the installer:
31+
*sudo ./pi_fancontrol.sh*
32+
33+
## 🗑️ Uninstall
34+
The script contains an uninstaller. To run it use --uninstall:
35+
*sudo pi_fancontrol.sh --uninstall*

0 commit comments

Comments
 (0)