Merge tag '3.14' into merge-3.14

Author: Renaud Guillard

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,18 +1,132 @@
-WiringPi (Unofficial Mirror/Fork)
-=================================
+# WiringPi Library
+Welcome to the WiringPi Library, the highly performant GPIO access library for Raspberry Pi boards. This library is written in C and is designed to provide fast and efficient control of the GPIO pins by directly accessing the hardware registers using DMA. 
 
-This is an unofficial mirror/fork of wiringPi to support ports (Python/Ruby/etc).  With the
-[end of official development](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.
+**Key Features:** 
+- **Support:** WiringPi supports all Raspberry Pi Boards including Pi 5 ( :construction: On the Pi 5, only the GCLK functionality is currently not supported due to missing documentation of the RP1 chip).
+- **High Performance:** By directly accessing the hardware registers, WiringPi ensures minimal latency and maximum performance for your GPIO operations.
+- **Wide Adoption:** WiringPi is widely used in numerous projects, making it a reliable choice for your Raspberry Pi GPIO needs.
 
-  * 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.
+Whether you’re working on a simple LED blink project or a complex automation system, WiringPi provides the tools you need to get the job done efficiently.
 
-Ports
------
+## How to use
+
+To compile programs with wiringPi Library, 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:
 
@@ -22,12 +136,29 @@ 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.
+
+If you're not sure whether to create an issue or not, please engage in [discussions](https://github.com/WiringPi/WiringPi/discussions)!
+
+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 2.5' 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.
 
-Please do not email Gordon if you have issues, he will not be able to help.
+## Debug
 
-Pull-requests may be accepted to add or fix support for newer hardware, but new features or
-other changes may not be accepted.
+WIRINGPI_DEBUG=1 ./my_wiringpi_program
 
-For support, comments, questions, etc please join the WiringPi Discord channel: https://discord.gg/SM4WUVG
+WIRINGPI_DEBUG=1 gpio readall

VERSION

@@ -1 +1 @@
-2.61
+3.14

build

@@ -3,7 +3,7 @@
 # build
 #	Simple wiringPi build and install script
 #
-#	Copyright (c) 2012-2015 Gordon Henderson
+#	Copyright (c) 2012-2024 Gordon Henderson and contributors
 #################################################################################
 # This file is part of wiringPi:
 #	A "wiring" library for the Raspberry Pi
@@ -83,9 +83,15 @@ fi
 # Only if you know what you're doing!
 
 if [ x$1 = "xdebian" ]; then
+  vMaj=`cut -d. -f1 VERSION`
+  vMin=`cut -d. -f2 VERSION`
   here=`pwd`
   deb_destdir=${here}/debian-template/wiringPi
   cd debian-template/wiringPi
+  export VERSION=$vMaj.$vMin
+  export ARCH=$(dpkg-architecture -qDEB_HOST_ARCH)
+  echo version:$VERSION architecture:$ARCH
+  envsubst < control_template > DEBIAN/control
   rm -rf usr
   cd $here/wiringPi
   make install-deb DEB_DESTDIR=${deb_destdir}
@@ -95,7 +101,7 @@ if [ x$1 = "xdebian" ]; then
   make install-deb INCLUDE='-I../wiringPi -I../devLib' LDFLAGS=-L../debian-template/wiringPi/usr/lib DEB_DESTDIR=${deb_destdir}
   cd $here/debian-template
   fakeroot dpkg-deb --build wiringPi
-  mv wiringPi.deb  wiringpi-`cat $here/VERSION`-1.deb
+  dpkg-name -o wiringPi.deb
   exit
 fi
 
@@ -110,22 +116,6 @@ fi
 
   hardware=`fgrep Hardware /proc/cpuinfo | head -1 | awk '{ print $3 }'`
 
-#  if [ x$hardware != "xBCM2708" ]; then
-#    echo ""
-#    echo "   +------------------------------------------------------------+"
-#    echo "   |   wiringPi is designed to run on the Raspberry Pi only.    |"
-#    echo "   |   This processor does not appear to be a Raspberry Pi.     |"
-#    echo "   +------------------------------------------------------------+"
-#    echo "   | In the unlikely event that you think it is a Raspberry Pi, |"
-#    echo "   | then please accept my apologies and email the contents of  |"
-#    echo "   | /proc/cpuinfo to [email protected].                      |"
-#    echo "   |    - Thanks, Gordon                                        |"
-#    echo "   +------------------------------------------------------------+"
-#    echo ""
-#    exit 1
-#  fi
-
-
   echo
   echo "WiringPi Library"
   cd wiringPi

debian-template/wiringPi/DEBIAN/control

@@ -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

debian-template/wiringPi/DEBIAN/postinst

@@ -0,0 +1,14 @@
+Package: wiringpi
+Version: $VERSION
+Section: libraries
+Priority: optional
+Architecture: $ARCH
+Depends: libc6
+Maintainer: Grazer Computer Club - GC2 <[email protected]>
+Uploaders: Grazer Computer Club - GC2 <[email protected]>
+Description: The wiringPi libraries, headers and gpio command
+  Libraries to allow GPIO access on a Raspberry Pi from C and C++
+  programs as well as from the command-line
+Homepage: https://github.com/WiringPi/WiringPi
+Bugs: https://github.com/WiringPi/WiringPi/issues
+

debian-template/wiringPi/control_template

@@ -3,7 +3,7 @@ Section: electronics
 Priority: optional
 Maintainer: Ian Jackson <[email protected]>
 Standards-Version: 3.8.0
-Homepage: http://wiringpi.com/
+Homepage: https://github.com/WiringPi/WiringPi
 Build-Depends: debhelper (>= 8)
 
 Package: libwiringpi2

debian/control

@@ -5,7 +5,7 @@
 #	Copyright (c) 2012-2016 Gordon Henderson
 #################################################################################
 # This file is part of wiringPi:
-#	https://projects.drogon.net/raspberry-pi/wiringpi/
+#	https://github.com/wiringPi/wiringPi
 #
 #    wiringPi is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU Lesser General Public License as published by