Skip to content
This repository has been archived by the owner on Jan 11, 2024. It is now read-only.

Commit

Permalink
Updating and refactoring site docs for 1.3 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
@savageautomate
savageautomate committed Jan 21, 2021
1 parent 5343dea commit 20e5647
Show file tree
Hide file tree
Showing 92 changed files with 197 additions and 152 deletions.
2 changes: 2 additions & 0 deletions pi4j-distribution/src/scripts/pi4j
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,14 @@ case $1 in
echo " -U, --uninstall : uninstall Pi4J"
echo " -c, --compile <FILE> : exec javac with pi4j in classpath"
echo " -r, --run <CLASS> : exec java with pi4j in classpath"
echo " -WPI, --wiringpi : download, build and install latest WiringPi library"
echo
echo " EXAMPLES:"
echo " ---------"
echo " pi4j --version (display Pi4J version)"
echo " pi4j --update (update Pi4J installation)"
echo " pi4j --uninstall (uninstall Pi4J package)"
echo " pi4j --wiringpi (download, build and install WiringPi library)"
echo
echo " pi4j --compile HelloWorld.java (compile 'HelloWorld.java' sources)"
echo " pi4j -c HelloWorld.java (compile 'HelloWorld.java' sources)"
Expand Down
47 changes: 26 additions & 21 deletions src/site/apt/index.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Welcome to Pi4J!

Latest Development Updates:

* Added support for {{{./pins/model-4b-rev1.html}Raspberry Pi 4B}}
* Added support for {{{./pins/rpi-4b.html}Raspberry Pi 4B}}

* Added support for {{{./pins/model-400-rev1.html}Raspberry Pi 400}}
* Added support for {{{./pins/rpi-400.html}Raspberry Pi 400}}

* Added support for {{{./pins/model-cm4-rev1.html}Raspberry Pi Compute Module 4}}
* Added support for {{{./pins/rpi-cm4.html}Raspberry Pi Compute Module 4}}

* Various improvements and bug fixes listed here: {{{https://github.com/Pi4J/pi4j/milestone/10?closed=1}GitHub Issues (v1.3)}}

Expand All @@ -44,9 +44,14 @@ Welcome to Pi4J!

* Prerequisites

* {{{https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html}Java 8 JRE/JDK}} - The Java 8 runtime
* {{{https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html}Java 8 JRE/JDK}} - The <<Java 8>> runtime
environment must be installed and configured on your SoC platform.

\
<<ATTENTION:>> \
If you require a newer Java Virtual Machine for your project, please review the following Pi4J projects:
{{{https://pi4j.com/1.4}Pi4J v1.4}} or {{{https://v2.pi4j.com/}Pi4J v2.x}}

* {{{https://github.com/WiringPi/WiringPi}WiringPi}} -The latest WiringPi library must be installed on your RaspberryPi.

\
Expand All @@ -61,39 +66,39 @@ Welcome to Pi4J!

* Supported Hardware

* {{{./pins/model-a-rev2.html}Raspberry Pi - A}}
* {{{./pins/rpi-1a.html}Raspberry Pi - 1A}}

* {{{./pins/model-b-rev1.html}Raspberry Pi - B (Revision 1)}}
* {{{./pins/rpi-1b-rev1.html}Raspberry Pi - 1B (Revision 1)}}

* {{{./pins/model-b-rev2.html}Raspberry Pi - B (Revision 2)}}
* {{{./pins/rpi-1b-rev2.html}Raspberry Pi - 1B (Revision 2)}}

* {{{./pins/model-a-plus.html}Raspberry Pi - A+}}
* {{{./pins/rpi-1ap.html}Raspberry Pi - 1A+}}

* {{{./pins/model-b-plus.html}Raspberry Pi - B+}}
* {{{./pins/rpi-1bp.html}Raspberry Pi - 1B+}}

* {{{./pins/model-2b-rev1.html}Raspberry Pi - 2B}}
* {{{./pins/rpi-2b.html}Raspberry Pi - 2B}}

* {{{./pins/model-3b-rev1.html}Raspberry Pi - 3B}}
* {{{./pins/rpi-3b.html}Raspberry Pi - 3B}}

* {{{./pins/model-3b-plus-rev1.html}Raspberry Pi - 3B+}}
* {{{./pins/rpi-3bp.html}Raspberry Pi - 3B+}}

* {{{./pins/model-3a-plus-rev1.html}Raspberry Pi - 3A+}}
* {{{./pins/rpi-3ap.html}Raspberry Pi - 3A+}}

* {{{./pins/model-4b-rev1.html}Raspberry Pi - 4B}}
* {{{./pins/rpi-4b.html}Raspberry Pi - 4B}}

* {{{./pins/model-400-rev1.html}Raspberry Pi - 400}}
* {{{./pins/rpi-400.html}Raspberry Pi - 400}}

* {{{./pins/model-zero-rev1.html}Raspberry Pi - Zero}}
* {{{./pins/rpi-zero.html}Raspberry Pi - Zero}}

* {{{./pins/model-zerow-rev1.html}Raspberry Pi - Zero W}}
* {{{./pins/rpi-zerow.html}Raspberry Pi - Zero W}}

* {{{./pins/model-cm-rev1.html}Raspberry Pi - CM1 (Compute Module)}}
* {{{./pins/rpi-cm1.html}Raspberry Pi - CM1 (Compute Module)}}

* {{{./pins/model-cm3-rev1.html}Raspberry Pi - CM3 (Compute Module)}}
* {{{./pins/rpi-cm3.html}Raspberry Pi - CM3 (Compute Module)}}

* {{{./pins/model-cm3-plus-rev1.html}Raspberry Pi - CM3+ (Compute Module)}}
* {{{./pins/rpi-cm3p.html}Raspberry Pi - CM3+ (Compute Module)}}

* {{{./pins/model-cm4-rev1.html}Raspberry Pi - CM4 (Compute Module)}}
* {{{./pins/rpi-cm4.html}Raspberry Pi - CM4 (Compute Module)}}

* {{{./pins/lemaker-bananapi.html}LeMaker - BananaPi}}

Expand Down
34 changes: 20 additions & 14 deletions src/site/apt/pin-numbering-scheme.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,33 +35,39 @@ Pin Numbering Schemes
The available GPIO pins differ between Raspberry Pi models and board revisions.
Please select your model/revision below to see the GPIO pinout for your board.

* {{{./pins/model-a-rev2.html}Raspberry Pi - A}}
* {{{./pins/rpi-1a.html}Raspberry Pi - 1A}}

* {{{./pins/model-a-plus.html}Raspberry Pi - A+}}
* {{{./pins/rpi-1ap.html}Raspberry Pi - 1A+}}

* {{{./pins/model-b-rev1.html}Raspberry Pi - B (Revision 1.0)}}
* {{{./pins/rpi-1b-rev1.html}Raspberry Pi - 1B (Revision 1.0)}}

* {{{./pins/model-b-rev2.html}Raspberry Pi - B (Revision 2.0)}}
* {{{./pins/rpi-1b-rev2.html}Raspberry Pi - 1B (Revision 2.0)}}

* {{{./pins/model-b-plus.html}Raspberry Pi - B+}}
* {{{./pins/rpi-1bp.html}Raspberry Pi - 1B+}}

* {{{./pins/model-2b-rev1.html}Raspberry Pi - 2B}}
* {{{./pins/rpi-2b.html}Raspberry Pi - 2B}}

* {{{./pins/model-3b-rev1.html}Raspberry Pi - 3B}}
* {{{./pins/rpi-3b.html}Raspberry Pi - 3B}}

* {{{./pins/model-3b-plus-rev1.html}Raspberry Pi - 3B+}}
* {{{./pins/rpi-3bp.html}Raspberry Pi - 3B+}}

* {{{./pins/model-3a-plus-rev1.html}Raspberry Pi - 3A+}}
* {{{./pins/rpi-3ap.html}Raspberry Pi - 3A+}}

* {{{./pins/model-zero-rev1.html}Raspberry Pi - Zero}}
* {{{./pins/rpi-4b.html}Raspberry Pi - 4B}}

* {{{./pins/model-zerow-rev1.html}Raspberry Pi - Zero W}}
* {{{./pins/rpi-400.html}Raspberry Pi - 400}}

* {{{./pins/model-cm-rev1.html}Raspberry Pi - CM1 (Compute Module)}}
* {{{./pins/rpi-zero.html}Raspberry Pi - Zero}}

* {{{./pins/model-cm3-rev1.html}Raspberry Pi - CM3 (Compute Module)}}
* {{{./pins/rpi-zerow.html}Raspberry Pi - Zero W}}

* {{{./pins/model-cm3-plus-rev1.html}Raspberry Pi - CM3+ (Compute Module)}}
* {{{./pins/rpi-cm1.html}Raspberry Pi - CM1 (Compute Module)}}

* {{{./pins/rpi-cm3.html}Raspberry Pi - CM3 (Compute Module)}}

* {{{./pins/rpi-cm3p.html}Raspberry Pi - CM3+ (Compute Module)}}

* {{{./pins/rpi-cm4.html}Raspberry Pi - CM4 (Compute Module)}}

* {{{./pins/lemaker-bananapi.html}Lemaker - BananaPi}}

Expand Down
12 changes: 7 additions & 5 deletions src/site/apt/pins/model-a-rev2.apt → src/site/apt/pins/rpi-1a.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,33 @@ Pin Numbering - Raspberry Pi Model A

The Raspberry Pi Model A contains both a 26-pin expansion header labeled as 'P1' providing access to 17 GPIO pins and an 8-pin expansion header labeled as 'P5' providing an additional 4 GPIO pins for a total of 21 GPIO pins.

[../images/p1header-rev2-photo.png]
[../images/pi4j-rpi-1a-header.png]

* P1 Pinout (26-pin Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme for the P1 header pins.

[../images/p1header.png]
[../images/pi4j-rpi-1a-pinout-small.png]

{{{../images/p1header-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1a-pinout.png}(click here for hi-resolution image)}}


* P5 Pinout (8-pin header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme for the P5 header pins. The P6 header does not have any header pins pre-soldered. If you want to make use of these pins, you will need to install and solder the header pins to the board.
(NOTE: The P5 header is only available on (model A and B) board revisions 2.0 and newer.)

[../images/p5header.png]
[../images/pi4j-rpi-1a-p5-small.png]

{{{../images/p5header-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1a-p5.png}(click here for hi-resolution image)}}


* Additional Resources

* Please visit the {{{../usage.html}usage}} page for additional details on how to control these pins using Pi4J.

* {{{https://www.raspberrypi.org/model-a/}Click here for more information on the Raspberry Pi 1A.}}

* {{{http://elinux.org/RPi_Low-level_peripherals#General_Purpose_Input.2FOutput_.28GPIO.29}Click here for more information on the P1 header.}}

* {{{http://elinux.org/RPi_Low-level_peripherals#P5_header}Click here for more information on the P5 header.}}
Expand Down
10 changes: 5 additions & 5 deletions src/site/apt/pins/model-a-plus.apt → src/site/apt/pins/rpi-1ap.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ Pin Numbering - Raspberry Pi Model A+
The Raspberry Pi Model A+ board contains a single 40-pin expansion header labeled as 'J8' providing access to 28 GPIO pins.\
(Pins 1, 2, 39 & 40 are also labeled below.)

[../images/j8header-photo-a-plus.png]
[../images/pi4j-rpi-1ap-header.png]

* J8 Pinout (40-pin Header)
* GPIO Pinout (40-pin J8 Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/j8header-a-plus.png]
[../images/pi4j-rpi-1ap-pinout-small.png]

{{{../images/j8header-a-plus-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1ap-pinout.png}(click here for hi-resolution image)}}


* Additional Resources

* Please visit the {{{../usage.html}usage}} page for additional details on how to control these pins using Pi4J.

* {{{http://www.raspberrypi.org/products/model-a-plus/}Click here for more information on the J8 header.}}
* {{{https://www.raspberrypi.org/products/raspberry-pi-1-model-a-plus/}Click here for more information on the Raspberry Pi 1A Plus.}}

* {{{http://elinux.org/RPi_BCM2835_GPIOs}Click here for more information the Raspberry Pi pin functions.}}
6 changes: 3 additions & 3 deletions src/site/apt/pins/model-b-rev1.apt → src/site/apt/pins/rpi-1b-rev1.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ Pin Numbering - Raspberry Pi Model B (Revision 1.0)

The Raspberry Pi Model B board revision 1.0 contains a single 26-pin expansion header labeled as 'P1' providing access to 17 GPIO pins.

[../images/p1header-rev1-photo.png]
[../images/pi4j-rpi-1b-rev1-header.png]

* P1 Pinout (26-pin Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/p1header.png]
[../images/pi4j-rpi-1b-pinout-small.png]

{{{../images/p1header-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1b-pinout.png}(click here for hi-resolution image)}}


* Additional Resources
Expand Down
10 changes: 5 additions & 5 deletions src/site/apt/pins/model-b-rev2.apt → src/site/apt/pins/rpi-1b-rev2.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,25 @@ Pin Numbering - Raspberry Pi Model B (Revision 2.0)

The Raspberry Pi Model B board revision 2.0 contains both a 26-pin expansion header labeled as 'P1' providing access to 17 GPIO pins and an 8-pin expansion header labeled as 'P5' providing an additional 4 GPIO pins for a total of 21 GPIO pins.

[../images/p1header-rev2-photo.png]
[../images/pi4j-rpi-1b-rev2-header.png]

* P1 Pinout (26-pin Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme for the P1 header pins.

[../images/p1header.png]
[../images/pi4j-rpi-1b-pinout-small.png]

{{{../images/p1header-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1b-pinout.png}(click here for hi-resolution image)}}


* P5 Pinout (8-pin header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme for the P5 header pins. The P6 header does not have any header pins pre-soldered. If you want to make use of these pins, you will need to install and solder the header pins to the board.
(NOTE: The P5 header is only available on (model A and B) board revisions 2.0 and newer.)

[../images/p5header.png]
[../images/pi4j-rpi-1b-p5-small.png]

{{{../images/p5header-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1b-p5.png}(click here for hi-resolution image)}}


* Additional Resources
Expand Down
10 changes: 5 additions & 5 deletions src/site/apt/pins/model-b-plus.apt → src/site/apt/pins/rpi-1bp.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ Pin Numbering - Raspberry Pi Model B+
The Raspberry Pi Model B+ board contains a single 40-pin expansion header labeled as 'J8' providing access to 28 GPIO pins.\
(Pins 1, 2, 39 & 40 are also labeled below.)

[../images/j8header-photo.png]
[../images/pi4j-rpi-1bp-header.png]

* J8 Pinout (40-pin Header)
* GPIO Pinout (40-pin J8 Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/j8header-b-plus.png]
[../images/pi4j-rpi-1bp-pinout-small.png]

{{{../images/j8header-b-plus-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-1bp-pinout.png}(click here for hi-resolution image)}}


* Additional Resources

* Please visit the {{{../usage.html}usage}} page for additional details on how to control these pins using Pi4J.

* {{{http://www.raspberrypi.org/product/model-b-plus/}Click here for more information on the J8 header.}}
* {{{https://www.raspberrypi.org/products/raspberry-pi-1-model-b-plus/}Click here for more information on the Raspberry Pi 1B Plus.}}

* {{{http://elinux.org/RPi_BCM2835_GPIOs}Click here for more information the Raspberry Pi pin functions.}}
10 changes: 5 additions & 5 deletions src/site/apt/pins/model-2b-rev1.apt → src/site/apt/pins/rpi-2b.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ Pin Numbering - Raspberry Pi 2 Model B
The Raspberry Pi 2 Model B board contains a single 40-pin expansion header labeled as 'J8' providing access to 28 GPIO pins.\
(Pins 1, 2, 39 & 40 are also labeled below.)

[../images/j8header-photo.png]
[../images/pi4j-rpi-2b-header.png]

* J8 Pinout (40-pin Header)
* GPIO Pinout (40-pin J8 Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/j8header-2b.png]
[../images/pi4j-rpi-2b-pinout-small.png]

{{{../images/j8header-2b-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-2b-pinout.png}(click here for hi-resolution image)}}


* Additional Resources

* Please visit the {{{../usage.html}usage}} page for additional details on how to control these pins using Pi4J.

* {{{http://www.raspberrypi.org/products/raspberry-pi-2-model-b/}Click here for more information on the J8 header.}}
* {{{https://www.raspberrypi.org/products/raspberry-pi-2-model-b/}Click here for more information on the Raspberry Pi 2B.}}

* {{{http://elinux.org/RPi_BCM2835_GPIOs}Click here for more information the Raspberry Pi pin functions.}}
8 changes: 4 additions & 4 deletions src/site/apt/pins/model-3a-plus-rev1.apt → src/site/apt/pins/rpi-3ap.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ Pin Numbering - Raspberry Pi 3A+
The Raspberry Pi 3A+ board contains a single 40-pin expansion header labeled as 'J8' providing access to 28 GPIO pins.\
(Pins 1, 2, 39 & 40 are also labeled below.)

[../images/j8header-photo.png]
[../images/pi4j-rpi-3ap-header.png]

* J8 Pinout (40-pin Header)
* GPIO Pinout (40-pin J8 Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/j8header-3a-plus.png]
[../images/pi4j-rpi-3ap-pinout-small.png]

{{{../images/j8header-3a-plus-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-3ap-pinout.png}(click here for hi-resolution image)}}

* Known Issues

Expand Down
10 changes: 5 additions & 5 deletions src/site/apt/pins/model-3b-rev1.apt → src/site/apt/pins/rpi-3b.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ Pin Numbering - Raspberry Pi 3 Model B
The Raspberry Pi 3 Model B board contains a single 40-pin expansion header labeled as 'J8' providing access to 28 GPIO pins.\
(Pins 1, 2, 39 & 40 are also labeled below.)

[../images/j8header-photo.png]
[../images/pi4j-rpi-3b-header.png]

* J8 Pinout (40-pin Header)
* GPIO Pinout (40-pin J8 Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/j8header-3b.png]
[../images/pi4j-rpi-3b-pinout-small.png]

{{{../images/j8header-3b-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-3b-pinout.png}(click here for hi-resolution image)}}

* Known Issues

Expand All @@ -55,6 +55,6 @@ Pin Numbering - Raspberry Pi 3 Model B

* Please visit the {{{../usage.html}usage}} page for additional details on how to control these pins using Pi4J.

* {{{http://www.raspberrypi.org/products/raspberry-pi-3-model-b/}Click here for more information on the J8 header.}}
* {{{https://www.raspberrypi.org/products/raspberry-pi-3-model-b/}Click here for more information on the Raspberry Pi 3B.}}

* {{{http://elinux.org/RPi_BCM2835_GPIOs}Click here for more information the Raspberry Pi pin functions.}}
8 changes: 4 additions & 4 deletions src/site/apt/pins/model-3b-plus-rev1.apt → src/site/apt/pins/rpi-3bp.apt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ Pin Numbering - Raspberry Pi 3B+
The Raspberry Pi 3B+ board contains a single 40-pin expansion header labeled as 'J8' providing access to 28 GPIO pins.\
(Pins 1, 2, 39 & 40 are also labeled below.)

[../images/j8header-photo.png]
[../images/pi4j-rpi-3bp-header.png]

* J8 Pinout (40-pin Header)
* GPIO Pinout (40-pin J8 Header)

The diagram below illustrates the GPIO pinout using the Pi4J/WiringPi GPIO numbering scheme.

[../images/j8header-3b-plus.png]
[../images/pi4j-rpi-3bp-pinout-small.png]

{{{../images/j8header-3b-plus-large.png}(click here for hi-resolution image)}}
{{{../images/pi4j-rpi-3bp-pinout.png}(click here for hi-resolution image)}}

* Known Issues

Expand Down
Loading

0 comments on commit 20e5647

Please sign in to comment.