Merge pull request #5 from ar51an/3.0

pigpio update

Author: ar51an

README.md

@@ -18,42 +18,43 @@
 <div align="justify">
 
 ### Intro
-Service to adjust RP4 PWM (Pulse Width Modulation) fan speed automatically based on CPU temperature. It will help in reducing fan noise and power consumption. It is written in C. **Main objective is to keep it fast and use minimum CPU and memory resources**.
+Raspberry Pi fan-control service to adjust PWM fan speed automatically based on CPU temperature. It will help in reducing fan noise and power consumption. It is written in C. **Main objective is to keep it fast and use minimum CPU and memory resources**.
 <br/>
 
 <div align="center">
-  <img src="https://user-images.githubusercontent.com/11185794/202808642-ba7d83c2-aec5-4079-92e5-48765c693dc3.png?raw=true" alt="resource-usage"/>
+  <img src="https://github.com/ar51an/raspberrypi-fan-control/assets/11185794/c16ae27c-ea3b-46ad-9397-ea79e5471a84?raw=true" alt="resource-usage"/>
 </div>
 <br/>
 
-If you just want PWM fan On/Off based on CPU temperature. Connect fan's `PWM, ground and +5V wires` directly to the GPIO pins. Enable fan **either** from raspi-config **or** UI. Set the PWM pin and CPU temperature in the setup. Lowest temperature you can specify from setup is 60°C. This limit can be bypassed by editing `/boot/config.txt` manually. Search for `dtoverlay=gpio-fan` entry and change the `temp=60000` value to your desired temperature. Fan will start at the specified CPU temperature and it will stop 10°C below that. The downside is fan will run at full speed and bit noisy, specially if you are using an open RP4 case.
+If you just want PWM fan On/Off based on CPU temperature. Connect fan's `PWM, ground and +5V wires` directly to the GPIO pins. Enable fan **either** from raspi-config **or** UI. Set the PWM pin and CPU temperature in the setup. Lowest temperature limit of 60°C can be bypassed by editing `/boot/firmware/config.txt` manually. Find `dtoverlay=gpio-fan` entry and change the `temp=60000` to the desired temperature. Fan will start at the specified CPU temperature and it will stop 10°C below that. The downside is fan will run at full speed and bit noisy, specially if you are using an open RP4 case.
 <br/>
 
-This service is specifically written for `Noctua 5V PWM` fan and `Raspberry Pi 4`. It may work for other PWM fans and RP models. You should know the intended fan's specifications, like max / min `RPM` and `target frequency`. Adjust these values in code/config and rebuild the binary (if needed). Raspberry Pi crystal oscillator clock frequency on RPi4B is 54MHz and on all earlier models it is 19.2MHz. `WiringPi` function `pwmSetClock` requires a divisor of clock frequency to set the target frequency of fan. The process is well documented in the fan-control source code.
+This service is specifically written for `Noctua 5V PWM` fan and `Raspberry Pi 4`. It may work for other PWM fans and RP models. You should know the intended fan's specifications, like max / min `RPM` and `target frequency`. Adjust these values in code/config and rebuild the binary (if needed).
 <br/>
 
-I connected Noctua fan wires directly to the RP4 GPIO pins. It's been almost 2 years without any issue, your mileage may vary. If your fan does not support PWM or you want to safeguard hardware **either** build your own circuit **or** buy a pre-built PCB with transistor and diode like [EZ RP Fan Controller](https://www.tindie.com/products/jeremycook/ez-fan2-tiny-raspberry-pi-fan-controller/).  
-***WARNING: I accept no responsibility if you damage your Raspberry Pi or fan.***
+I connected Noctua fan wires directly to the RP4 GPIO pins. It's been almost 3 years without any issue, your mileage may vary. If your fan does not support PWM or you want to safeguard hardware **either** build your own circuit **or** buy a pre-built PCB with transistor and diode like [EZ RP Fan Controller](https://www.tindie.com/products/jeremycook/ez-fan2-tiny-raspberry-pi-fan-controller/).
+
+> `⚠️` **WARNING:** ***I accept no responsibility if you damage your Raspberry Pi or fan.***
+
 <br/>
 
 #### Specs:
-> |Noctua Fan           |HW                      |OS                           |WiringPi C Lib Ver|
-> |:--------------------|:-----------------------|:----------------------------|:-----------------|
-> |`NF-A4x10 5V PWM Fan`|`Raspberry Pi 4 Model B`|`raspios-bullseye-arm64-lite`|`2.70`            |
+> |Noctua Fan           |HW                      |OS                           |pigpio C Lib Ver|
+> |:--------------------|:-----------------------|:----------------------------|:---------------|
+> |`NF-A4x10 5V PWM Fan`|`Raspberry Pi 4 Model B`|`raspios-bookworm-arm64-lite`|`79`            |
 #
 
 ### Hardware Prep
 * The default noctua fan connector will not connect directly to GPIO header. You need to do some modifications. There are multiple options:  
   > **1 - Dupont Jumper Wires Male to Female:**  
-  > Noctua's existing wire is pretty long. Get short jumper wires somewhere between 2-4" long. Male part of jumper wire will connect to Noctua connector and Female part will connect to GPIO. This is what I used in the beginning for few months.
+  > Noctua's existing wire is pretty long. Get short jumper wires somewhere between 2-4" long. Male part of jumper wire will connect to Noctua connector and Female part will connect to GPIO. I used it for few months.
 
   > **2 - Dupont Female Pin Connectors 2.54mm Pitch:**  
-  > This is the one I am using now, as shown in the preview. It is the cleanest option. It could be the most expensive option if you do not have all the tools. You need dupont Female pin connectors, crimping tool, wire cutter/stripper, heat shrink tube/heat gun **or** dupont connector housing.  
-  > You can **either** buy connectors and housing kit **or** buy dupont connectors separately. Better options for dupont connectors are `Molex Crimp Terminals Series: 70058 Part No: 16020098` or `Harwin Series: M20 Part No: 1180042`. I used Molex connectors. For crimping I used IWISS `IWS-2820` crimping tool. Cover these connectors with **either** heat shrink tube (I used 3.00mm diameter tube) **or** dupont connector housing.  
-  > If you go with this route. You have to cut the noctua fan wire to the required length. **Make sure you calculate required wire length properly before cutting**. If you cut it too short you will end up inserting wire joints. Strip wires (practice some stripping on the unused end). Attach dupont connectors to the stripped wires, crimp them with crimpping tool. Add heat shrink tubes to the connectors and shrink them with heatgun or attach connector housing.  
-
+  > It is the cleanest option, as shown in the preview. You need dupont Female pin connectors, crimping tool, wire cutter & stripper, heat-shrink-tube & heat-gun **or** dupont connector housing.  
+  > Better options for dupont connectors are `Molex Crimp Terminals Series: 70058 Part No: 16020098` or `Harwin Series: M20 Part No: 1180042`. I used Molex connectors and IWISS `IWS-2820` crimping tool. Cover these connectors with **either** heat shrink tube (3.00mm diameter tube) **or** dupont connector housing.  
+  
   > **3 - Use Wires from Old Fan:**  
-  > If you have some old fan laying around that has dupont connector wires and you have no plan of using it. Cut the wires from that fan, cut the Noctua connector and do some wire joining. Noctua fan comes with 4 OmniJoin adaptors, you can use them as well for joining wires.
+  > If you have some old unused fan laying around that has dupont connector wires. Cut the wires from that fan, cut the Noctua connector and do some wire joining. Noctua fan's OmniJoin adaptors can be used for joining wires.
 
 * Complete specification of Noctua fan is available at [Noctua Whitepaper](https://noctua.at/pub/media/wysiwyg/Noctua_PWM_specifications_white_paper.pdf). Details of Raspberry Pi GPIO pin layout is available at [GPIO Pinout](https://pinout.xyz/). Screenshots attached for quick reference.
 
@@ -70,19 +71,19 @@ I connected Noctua fan wires directly to the RP4 GPIO pins. It's been almost 2 y
   |Blue PWM Signal |Physical Pin 12|
   |Green RPM Signal|Physical Pin 16|
 
-  Fan's PWM signal wire is connected to the RP4 `Physical/Board pin 12 - GPIO/BCM pin 18`. This fan-control code uses GPIO 18 as default. There are 4 pins on RP4 that support hardware PWM `GPIO 12/13/18/19`. If you are going to use a different GPIO pin make sure you change the `PWM_PIN` in `params.conf` with the one you use.  
-The green tachometer wire on Noctua fan is used to calculate RPM. Connect the fan's RPM signal wire to the RP4 `Physical/Board pin 16 - GPIO/BCM pin 23`. By default, tacho output is disabled in `params.conf`. (refer to `Points to Note`)
+  Fan's PWM signal wire is connected to the RP4 `Physical pin 12 - GPIO pin 18`. This fan-control code uses GPIO 18 as default. There are 4 pins on RP4 that support hardware PWM `GPIO 12/13/18/19`. If you are going to use a different GPIO pin make sure you change the `PWM_PIN` in `params.conf` with the one you use.  
+The green tachometer wire on Noctua fan is used to calculate RPM. Connect the fan's RPM signal wire to the RP4 `Physical pin 16 - GPIO pin 23`. By default, tacho output is disabled in `params.conf`. (refer to `Points to Note`)
 
 #
 ### Steps
-#### ⮞ Install WiringPi
-* Install `WiringPi C` library. You can download it from [WiringPi](https://github.com/WiringPi/WiringPi). Installation instructions are available at [Install](https://github.com/WiringPi/WiringPi/blob/master/INSTALL).
+#### ❯ Install pigpio
+* Install `pigpio C` library. You can download it from [pigpio](https://codeload.github.com/joan2937/pigpio/zip/refs/heads/master).
 
-  > **Quick Reference:**  
-  > Unzip `sudo unzip -o WiringPi-master.zip -d WiringPi`  
-  > Build and Install `sudo ./build`  
+  > `unzip -o pigpio-master.zip`  
+  > `make`  
+  > `sudo make install`  
 
-#### ⮞ Install FanControl
+#### ❯ Install FanControl
 * Create folder `/opt/gpio/fan`. Copy `fan-control` and `params.conf` from the latest release under `build` folder to this newly created folder `/opt/gpio/fan`. Make sure both files are under the ownership of root and `fan-control` is executable. **Fan-control will work with default values without `params.conf`.**
 
   > **Create folder:**  
@@ -113,7 +114,7 @@ The green tachometer wire on Noctua fan is used to calculate RPM. Connect the fa
   > **Check Journal Logs:**  
   > `sudo journalctl -u fan-control`  
 
-  > **_NOTE:_**  
+  > `ℹ️` **Note:**  
   > Default service starts fan-control early in the boot process. It works fine with `lite RaspiOS`. In case any issue or warning with fan-control startup at boot, you can modify the service to start late in the boot process. Edit `fan-control.service`. Uncomment `After=multi-user.target` and `WantedBy=multi-user.target`. Comment out `WantedBy=sysinit.target`. Save and reboot.
 
 #
@@ -149,20 +150,9 @@ The green tachometer wire on Noctua fan is used to calculate RPM. Connect the fa
 
 #
 ### Build
-* Install `libsystemd-dev`. It is required if you are going to build fan-control source code.  If you **do not** want journal logging at all from fan-control service you can skip `libsystemd-dev` package installation and remove journal logging from code, explained below.  
-  > **Install Package:**  
+* Install `libsystemd-dev`. It is required for compiling fan-control source code.  
   > `sudo apt install libsystemd-dev`  
 
-* Binary is available in the release. If for any reason you want to rebuild.  
-  > **Build command:**  
-  > `sudo gcc -Wall -O2 fan-control.c -o fan-control -lwiringPi -lsystemd`  
-
-* Test binary after build.  
-  > **Run binary:**  
-  > `sudo ./fan-control`  
-  >  Ctrl+C to exit  
-
-* If you are not interested in journal logging. Comment out the include header `sd-journal.h` and journal logging lines starting with `sd_journal_print`  
-  > **Build command without journal logging:**  
-  > `sudo gcc -Wall -O2 fan-control.c -o fan-control -lwiringPi`  
+* Binary is available in the release. If for any reason you want to recompile.  
+  > `sudo gcc -Wall -O2 fan-control.c -o fan-control -lpigpio -lsystemd`  
 </div>

src/fan-control.c

@@ -1,6 +1,6 @@
 /*
  * PWM Fan Controller:
- *   PWM fan controller is developed using WiringPi C library for RPi4. It is
+ *   PWM fan controller is developed using pigpio C library for RPi4. It is
  *   intended for "Noctua NF-A4x10 5V PWM" fan, it may work for any PWM fan
  *   with slight adjustment according to the fan specs.
  *   Copyright (c) 2021 - ar51an
@@ -9,21 +9,22 @@
 #include <stdio.h>
 #include <time.h>
 #include <signal.h>
-#include <wiringPi.h>
+#include <pigpio.h>
 #include <systemd/sd-journal.h>
 
-int PWM_PIN             = 18;   // HW PWM works at GPIO [12, 13, 18 & 19] on RPi4B
+int PWM_PIN             = 18;    // HW PWM works at GPIO [12, 13, 18 & 19] on RPi4B
 int TACHO_PIN           = 23;
-int RPM_MAX             = 5000; // Noctua Specs: Max=5000
-int RPM_MIN             = 1500; // Noctua Specs: Min=1000 [Kept 1500 as Min]
+int FREQUENCY           = 25000; // Noctua Specs: Target_Frequency=25kHz
+int RPM_MAX             = 5000;  // Noctua Specs: Max=5000
+int RPM_MIN             = 1500;  // Noctua Specs: Min=1000 [Kept 1500 as Min]
 int RPM_OFF             = 0;
-int TEMP_MAX            = 55;   // Above this temperature [FAN=ON At Max speed]
-int TEMP_LOW            = 40;   // Below this temperature [FAN=OFF]
-int WAIT                = 5000; // MilliSecs before adjusting RPM
-int TACHO_ENABLED       = 0;    // TACHO Specific [Enable Tacho: 0=Disable 1=Enable]
-const int PULSE         = 2;    // TACHO Specific [Noctua fan puts out 2 pulses per revolution]
-volatile int intCount   = 0;    // TACHO Specific [Interrupt Counter]
-int getRpmStartTime     = 0;    // TACHO Specific
+int TEMP_MAX            = 55;    // Above this temperature [FAN=ON At Max speed]
+int TEMP_LOW            = 40;    // Below this temperature [FAN=OFF]
+int WAIT                = 5000;  // Milliseconds before adjusting RPM
+int TACHO_ENABLED       = 0;     // TACHO Specific [Enable Tacho: 0=Disable 1=Enable]
+const int PULSE         = 2;     // TACHO Specific [Noctua fan puts out 2 pulses per revolution]
+volatile int intCount   = 0;     // TACHO Specific [Interrupt Counter]
+int getRpmStartTime     = 0;     // TACHO Specific
 int origPwmPinMode      = -1;
 int origTachoPinMode    = -1;
 float tempLimitDiffPct  = 0.0f;
@@ -57,18 +58,24 @@ void initFanControl () {
     if (TACHO_ENABLED && TACHO_ENABLED != 1) TACHO_ENABLED = 0;
 }
 
-void initWiringPi () {
-    /* Initialize wiringPi, calling 1 of 4 setup methods */
-    wiringPiSetupGpio(); // Defaults to GPIO/BCM pin numbers
+int initPigpio () {
+    int config = gpioCfgGetInternals();
+    config |= PI_CFG_NOSIGHANDLER;
+    gpioCfgSetInternals(config);
+    if (gpioInitialise() < 0) {
+        sd_journal_print(LOG_ERR, "pigpio initialization failed ...");
+        return -1;
+    }
+    return 0;
 }
 
 int getPinMode (int pin) {
     /* Mode Name Mapping: INPUT=0, OUTPUT=1, ALT0=4, ALT1=5, ALT2=6, ALT3=7, ALT4=3, ALT5=2 */
-    return getAlt(pin);
+    return gpioGetMode(pin);
 }
 
 void setFanSpeed (int pin, int speed) {
-    pwmWrite(pin, speed);
+    gpioPWM(pin, speed);
 }
 
 int getCurrTemp () {
@@ -77,24 +84,16 @@ int getCurrTemp () {
     thermalFile = fopen(thermalFilename, "r");
     fscanf(thermalFile, "%d", &currTemp);
     fclose(thermalFile);
-    currTemp = ((float) currTemp/1000) + 0.5;
+    currTemp = ((float) currTemp/1000)+0.5;
     return currTemp;
 }
 
 void setupPwm () {
-    /* Set pwm fan freq=25kHz (Noctua whitepaper stated as Intel's recommendation for PWM FANs)
-     * PWM crystal oscillator clock base frequency: RPI3=19.2MHz & RPI4=54MHz. pwmSetClock()
-     * takes a divisor of base fequency: "19200000/768=25kHz". It adjusts the divisor for RPI4
-     * 54MHz in the code itself as "divisor=540*divisor/192"
-     */
-    int pwmClock = 768;
     origPwmPinMode = getPinMode(PWM_PIN);
-    pinMode(PWM_PIN, PWM_OUTPUT);
-    // Using default balanced mode instead of mark:space mode
-    //pwmSetMode(PWM_MODE_MS);
-    pwmSetClock(pwmClock);
-    pwmSetRange(RPM_MAX);          // Set PWM range to Max RPM
-    setFanSpeed(PWM_PIN, RPM_OFF); // Set Fan speed to 0 initially
+    gpioSetMode(PWM_PIN, PI_OUTPUT);
+    gpioSetPWMfrequency(PWM_PIN, FREQUENCY);
+    gpioSetPWMrange(PWM_PIN, RPM_MAX);          // Set PWM range to Max RPM
+    setFanSpeed(PWM_PIN, RPM_OFF);              // Set Fan speed to 0 initially
     //printf("[PWM] GPIO:Mode | %d:%d\n", PWM_PIN, origPwmPinMode);
     return;
 }
@@ -107,10 +106,10 @@ void interruptHandler () {
 
 void setupTacho () {
     origTachoPinMode = getPinMode(TACHO_PIN);
-    pinMode(TACHO_PIN, INPUT);
-    pullUpDnControl(TACHO_PIN, PUD_UP);
+    gpioSetMode(TACHO_PIN, PI_INPUT);
+    gpioSetPullUpDown(TACHO_PIN, PI_PUD_UP);
     getRpmStartTime = time(NULL);
-    wiringPiISR(TACHO_PIN, INT_EDGE_FALLING, interruptHandler);
+    gpioSetISRFunc(TACHO_PIN, FALLING_EDGE, 0, interruptHandler);
     return;
 }
 
@@ -146,6 +145,15 @@ void setFanRpm () {
     return;
 }
 
+void delay (unsigned int waitMillisec)
+{
+    const int msInSec = 1000;
+    struct timespec sleepInterval;
+    sleepInterval.tv_sec  = (time_t) (waitMillisec/msInSec);
+    sleepInterval.tv_nsec = (long) (waitMillisec%msInSec)*1000000L;
+    nanosleep (&sleepInterval, NULL);
+}
+
 void start () {
     if (TACHO_ENABLED) {
         setupTacho();
@@ -167,11 +175,12 @@ static void signalHandler (int _) {
 void cleanup () {
     // PWM pin cleanup
     setFanSpeed(PWM_PIN, RPM_OFF);
-    pinMode(PWM_PIN, origPwmPinMode);
-    //pullUpDnControl(PWM_PIN, PUD_DOWN);
+    gpioSetMode(PWM_PIN, origPwmPinMode);
+    //gpioSetPullUpDown(PWM_PIN, PUD_DOWN);
     // TACHO pin cleanup
-    if (TACHO_ENABLED) pinMode(TACHO_PIN, origTachoPinMode);
-    //pullUpDnControl(TACHO_PIN, PUD_DOWN);
+    if (TACHO_ENABLED) gpioSetMode(TACHO_PIN, origTachoPinMode);
+    //gpioSetPullUpDown(TACHO_PIN, PUD_DOWN);
+    gpioTerminate();
     sd_journal_print(LOG_INFO, "Cleaned up - Exiting ...");
     return;
 }
@@ -180,7 +189,7 @@ int main (void)
 {
     signal(SIGINT, signalHandler);
     initFanControl();
-    initWiringPi();
+    if (initPigpio() < 0) return 1;
     setupPwm();
     sd_journal_print(LOG_INFO, "Initialized and running ...");
     start();