Merge pull request WiringPi#188 from GrazerComputerClub/master

WiringPi 3.0 - let's revive the project

INSTALL

@@ -26,8 +26,4 @@ To un-install wiringPi:
 For help and support see:
 
 * https://github.com/WiringPi/WiringPi/issues
-* https://discord.gg/SM4WUVG
 
-
-wiringPi originally created by Gordon Henderson
-https://projects.drogon.net/

People

@@ -31,3 +31,5 @@ Andre Crone
 
 Rik Teerling
   Pointing out some silly mistooks in the I2C code...
+
+And everyone else that's been working on this project!

README.md

@@ -1,20 +1,127 @@
-:warning: This library was deprecated by its author in August 2019. As of 31st October 2023 nobody has shown an interest in properly maintaining it. Between this, and changes to GPIO in Rasberry Pi OS Bookworm and on the Raspberry Pi 5, this project is going nowhere. It has been archived to more clearly indicate this status.
+# WiringPi
 
-WiringPi (Unofficial Mirror/Fork)
-=================================
+WiringPi is a _performant_ GPIO access library written in C for Raspberry Pi boards.
 
-This is an unofficial mirror/fork of wiringPi to support ports (Python/Ruby/etc).  With the
-[end of official development](https://web.archive.org/web/20220405225008/http://wiringpi.com/wiringpi-deprecated/), this repository
-has become a mirror of the last "official" source release, plus a fork facilitating updates
-to support newer hardware (primarily for use by the ports) and fix bugs.
+:warning:️ :construction: on Pi5, PWM support is currently under development and _will not work at this point_. If you're interested in the progress, please check the [corresponding issue](https://github.com/GrazerComputerClub/WiringPi/issues/21).
 
-  * The final "official" source release can be found at the
-    [`final_source_2.50`](https://github.com/WiringPi/WiringPi/tree/final_official_2.50) tag.
-  * The default `master` branch contains code that has been written since that final source
-    release to provide support for newer hardware.
 
-Ports
------
+To compile programs with wiringPi, you need to include `wiringPi.h` as well as link against `wiringPi`:
+
+```c
+#include <wiringPi.h> // Include WiringPi library!
+
+int main(void)
+{
+  // uses BCM numbering of the GPIOs and directly accesses the GPIO registers.
+  wiringPiSetupGpio();
+
+  // pin mode ..(INPUT, OUTPUT, PWM_OUTPUT, GPIO_CLOCK)
+  // set pin 17 to input
+  pinMode(17, INPUT);
+
+  // pull up/down mode (PUD_OFF, PUD_UP, PUD_DOWN) => down
+  pullUpDnControl(17, PUD_DOWN);
+
+  // get state of pin 17
+  int value = digitalRead(17);
+
+  if (HIGH == value)
+  {
+    // your code
+  }
+}
+```
+
+To compile this code, link against wiringPi:
+
+```sh
+gcc -o myapp myapp.c -l wiringPi
+```
+
+Be sure to check out the [examples](./examples/), build them using Make:
+
+```sh
+cd examples
+make <example-name | really-all>
+```
+
+The tool `gpio` can be used to set single pins as well as get the state of everything at once:
+
+```
+pi@wiringdemo:~ $ gpio readall
+ +-----+-----+---------+------+---+---Pi 3B--+---+------+---------+-----+-----+
+ | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
+ +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
+ |     |     |    3.3v |      |   |  1 || 2  |   |      | 5v      |     |     |
+ |   2 |   8 |   SDA.1 |   IN | 1 |  3 || 4  |   |      | 5v      |     |     |
+ |   3 |   9 |   SCL.1 |   IN | 1 |  5 || 6  |   |      | 0v      |     |     |
+ |   4 |   7 | GPIO. 7 |   IN | 0 |  7 || 8  | 0 | IN   | TxD     | 15  | 14  |
+ |     |     |      0v |      |   |  9 || 10 | 1 | IN   | RxD     | 16  | 15  |
+ |  17 |   0 | GPIO. 0 |   IN | 1 | 11 || 12 | 1 | IN   | GPIO. 1 | 1   | 18  |
+ |  27 |   2 | GPIO. 2 |   IN | 1 | 13 || 14 |   |      | 0v      |     |     |
+ |  22 |   3 | GPIO. 3 |   IN | 1 | 15 || 16 | 0 | IN   | GPIO. 4 | 4   | 23  |
+ |     |     |    3.3v |      |   | 17 || 18 | 1 | IN   | GPIO. 5 | 5   | 24  |
+ |  10 |  12 |    MOSI |   IN | 0 | 19 || 20 |   |      | 0v      |     |     |
+ |   9 |  13 |    MISO |   IN | 0 | 21 || 22 | 1 | IN   | GPIO. 6 | 6   | 25  |
+ |  11 |  14 |    SCLK |   IN | 0 | 23 || 24 | 1 | IN   | CE0     | 10  | 8   |
+ |     |     |      0v |      |   | 25 || 26 | 0 | IN   | CE1     | 11  | 7   |
+ |   0 |  30 |   SDA.0 |   IN | 1 | 27 || 28 | 1 | IN   | SCL.0   | 31  | 1   |
+ |   5 |  21 | GPIO.21 |   IN | 0 | 29 || 30 |   |      | 0v      |     |     |
+ |   6 |  22 | GPIO.22 |   IN | 0 | 31 || 32 | 1 | IN   | GPIO.26 | 26  | 12  |
+ |  13 |  23 | GPIO.23 |   IN | 1 | 33 || 34 |   |      | 0v      |     |     |
+ |  19 |  24 | GPIO.24 |   IN | 1 | 35 || 36 | 1 | IN   | GPIO.27 | 27  | 16  |
+ |  26 |  25 | GPIO.25 |   IN | 1 | 37 || 38 | 1 | IN   | GPIO.28 | 28  | 20  |
+ |     |     |      0v |      |   | 39 || 40 | 1 | IN   | GPIO.29 | 29  | 21  |
+ +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
+ | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
+ +-----+-----+---------+------+---+---Pi 3B--+---+------+---------+-----+-----+
+```
+
+
+## Installing
+
+You can either build it yourself or use the prebuilt binaries:
+
+### From Source
+
+1. create debian-package
+
+```sh
+# fetch the source
+sudo apt install git
+git clone https://github.com/WiringPi/WiringPi.git
+cd WiringPi
+
+# build the package
+./build debian
+mv debian-template/wiringpi-3.0-1.deb .
+
+# install it
+sudo apt install ./wiringpi-3.0-1.deb
+```
+
+
+### Prebuilt Binaries
+
+Grab the latest release from [here](https://github.com/WiringPi/WiringPi/releases).
+
+
+Unzip/use the portable prebuilt verison:
+
+```sh
+# unzip the archive
+tar -xfv wiringpi_3.0.tar.gz
+```
+
+Install the debian package:
+
+```sh
+# install a dpkg
+sudo apt install ./wiringpi-3.0-1.deb
+```
+
+
+## Ports
 
 wiringPi has been wrapped for multiple languages:
 
@@ -24,7 +131,26 @@ wiringPi has been wrapped for multiple languages:
 * Python - https://github.com/WiringPi/WiringPi-Python
 * Ruby - https://github.com/WiringPi/WiringPi-Ruby
 
-Support
--------
+## Support
+
+Please use the [issue system](https://github.com/WiringPi/WiringPi/issues) of GitHub.
+
+Please do not email Gordon or @Gadgetoid.
+
+Please don't email GC2 for reporting issues, you might [contact us](mailto:[email protected]) for anything that's not meant for the public.
+
+## History
+
+This repository is the continuation of 'Gordon's wiringPi' which has been [deprecated](https://web.archive.org/web/20220405225008/http://wiringpi.com/wiringpi-deprecated/), a while ago.
+
+* The last "old wiringPi" source of Gordon's release can be found at the
+  [`final_source_2.50`](https://github.com/WiringPi/WiringPi/tree/final_official_2.50) tag.
+* The default `master` branch contains code that has been written since version 2.5
+  to provide support for newer hardware as well as new features.
+
+:information_source:️ Since 2024, [GC2](https://github.com/GrazerComputerClub) has taken over maintenance of the project, supporting new OS versions as well as current hardware generations. We are dedicated to keeping the arguably best-performing GPIO Library for Raspberry Pi running smoothly. We strive to do our best, but please note that this is a community effort, and we cannot provide any guarantees or take responsibility for implementing specific features you may need.
+
+## Debug
 
-Please do not email Gordon if you have issues, he will not be able to help.
+WIRINGPI_DEBUG=1 ./my_wiringpi_program
+WIRINGPI_DEBUG=1 ./gpio readall

VERSION

@@ -1 +1 @@
-2.70
+3.0

debian-template/wiringPi/DEBIAN/control

@@ -1,13 +1,13 @@
 Package: wiringpi
-Version: 2.70
+Version: 3.0
 Section: libraries
 Priority: optional
 Architecture: armhf
 Depends: libc6
-Maintainer: Phil Howard <wiringpi@gadgetoid.com>
-Uploaders: Phil Howard <wiringpi@gadgetoid.com>
+Maintainer: Grazer Computer Club - GC2 <wiringpi@gc2.at>
+Uploaders: Grazer Computer Club - GC2 <wiringpi@gc2.at>
 Description: The wiringPi libraries, headers and gpio command
   Libraries to allow GPIO access on a Raspberry Pi from C and C++
-  and BASIC programs as well as from the command-line
-Homepage: https://github.com/WiringPi/WiringPi/
-Bugs: https://github.com/WiringPi/WiringPi/
+  programs as well as from the command-line
+Homepage: https://github.com/WiringPi/WiringPi
+Bugs: https://github.com/WiringPi/WiringPi/issues

debian-template/wiringPi/DEBIAN/postinst

@@ -1,5 +1,5 @@
 #!/bin/sh
 set -e
-/bin/chown root.root	/usr/bin/gpio
+/bin/chown root:root	/usr/bin/gpio
 /bin/chmod 4755		/usr/bin/gpio
 /sbin/ldconfig