mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-10-29 17:50:37 +00:00
176 lines
4.5 KiB
ReStructuredText
176 lines
4.5 KiB
ReStructuredText
pinout
|
|
======
|
|
|
|
.. image:: images/pinout_pi3.png
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
::
|
|
|
|
pinout [-h] [-r REVISION] [-c] [-m]
|
|
|
|
Description
|
|
-----------
|
|
|
|
A utility for querying Raspberry Pi GPIO pin-out information. Running
|
|
:program:`pinout` on its own will output a board diagram, and GPIO header
|
|
diagram for the current Raspberry Pi. It is also possible to manually specify a
|
|
revision of Pi, or (by :doc:`remote_gpio`) to output information about a
|
|
remote Pi.
|
|
|
|
Options
|
|
-------
|
|
|
|
.. program:: pinout
|
|
|
|
.. option:: -h, --help
|
|
|
|
show this help message and exit
|
|
|
|
.. option:: -r REVISION, --revision REVISION
|
|
|
|
RPi revision. Default is to autodetect revision of current device
|
|
|
|
.. option:: -c, --color
|
|
|
|
Force colored output (by default, the output will include ANSI color codes
|
|
if run in a color-capable terminal). See also :option:`--monochrome`
|
|
|
|
.. option:: -m, --monochrome
|
|
|
|
Force monochrome output. See also :option:`--color`
|
|
|
|
Examples
|
|
--------
|
|
|
|
To output information about the current Raspberry Pi:
|
|
|
|
.. code-block:: console
|
|
|
|
$ pinout
|
|
|
|
For a Raspberry Pi model 3B, this will output something like the following:
|
|
|
|
.. code-block:: none
|
|
|
|
,--------------------------------.
|
|
| oooooooooooooooooooo J8 +====
|
|
| 1ooooooooooooooooooo | USB
|
|
| +====
|
|
| Pi Model 3B V1.1 |
|
|
| +----+ +====
|
|
| |D| |SoC | | USB
|
|
| |S| | | +====
|
|
| |I| +----+ |
|
|
| |C| +======
|
|
| |S| | Net
|
|
| pwr |HDMI| |I||A| +======
|
|
`-| |--------| |----|V|-------'
|
|
|
|
Revision : a02082
|
|
SoC : BCM2837
|
|
RAM : 1024Mb
|
|
Storage : MicroSD
|
|
USB ports : 4 (excluding power)
|
|
Ethernet ports : 1
|
|
Wi-fi : True
|
|
Bluetooth : True
|
|
Camera ports (CSI) : 1
|
|
Display ports (DSI): 1
|
|
|
|
J8:
|
|
3V3 (1) (2) 5V
|
|
GPIO2 (3) (4) 5V
|
|
GPIO3 (5) (6) GND
|
|
GPIO4 (7) (8) GPIO14
|
|
GND (9) (10) GPIO15
|
|
GPIO17 (11) (12) GPIO18
|
|
GPIO27 (13) (14) GND
|
|
GPIO22 (15) (16) GPIO23
|
|
3V3 (17) (18) GPIO24
|
|
GPIO10 (19) (20) GND
|
|
GPIO9 (21) (22) GPIO25
|
|
GPIO11 (23) (24) GPIO8
|
|
GND (25) (26) GPIO7
|
|
GPIO0 (27) (28) GPIO1
|
|
GPIO5 (29) (30) GND
|
|
GPIO6 (31) (32) GPIO12
|
|
GPIO13 (33) (34) GND
|
|
GPIO19 (35) (36) GPIO16
|
|
GPIO26 (37) (38) GPIO20
|
|
GND (39) (40) GPIO21
|
|
|
|
By default, if stdout is a console that supports color, ANSI codes will be used
|
|
to produce color output. Output can be forced to be :option:`--monochrome`:
|
|
|
|
.. code-block:: console
|
|
|
|
$ pinout --monochrome
|
|
|
|
Or forced to be :option:`--color`, in case you are redirecting to something
|
|
capable of supporting ANSI codes:
|
|
|
|
.. code-block:: console
|
|
|
|
$ pinout --color | less -SR
|
|
|
|
To manually specify the revision of Pi you want to query, use
|
|
:option:`--revision`. The tool understands both old-style `revision codes`_
|
|
(such as for the model B):
|
|
|
|
.. code-block:: console
|
|
|
|
$ pinout -r 000d
|
|
|
|
Or new-style `revision codes`_ (such as for the Pi Zero W):
|
|
|
|
.. code-block:: console
|
|
|
|
$ pinout -r 9000c1
|
|
|
|
.. image:: images/pinout_pizero_w.png
|
|
|
|
You can also use the tool with :doc:`remote_gpio` to query remote Raspberry
|
|
Pi's:
|
|
|
|
.. code-block:: console
|
|
|
|
$ GPIOZERO_PIN_FACTORY=pigpio PIGPIO_ADDR=other_pi pinout
|
|
|
|
Or run the tool directly on a PC using the mock pin implementation (although in
|
|
this case you'll almost certainly want to specify the Pi revision manually):
|
|
|
|
.. code-block:: console
|
|
|
|
$ GPIOZERO_PIN_FACTORY=mock pinout -r a22042
|
|
|
|
Environment Variables
|
|
---------------------
|
|
|
|
GPIOZERO_PIN_FACTORY
|
|
The library to use when communicating with the GPIO pins. Defaults to
|
|
attempting to load RPi.GPIO, then RPIO, then pigpio, and finally uses a
|
|
native Python implementation. Valid values include "rpigpio", "rpio",
|
|
"pigpio", "native", and "mock". The latter is most useful on non-Pi
|
|
platforms as it emulates a Raspberry Pi model 3B (by default).
|
|
|
|
PIGPIO_ADDR
|
|
The hostname of the Raspberry Pi the pigpio library should attempt to
|
|
connect to (if the pigpio pin factory is being used). Defaults to
|
|
``localhost``.
|
|
|
|
PIGPIO_PORT
|
|
The port number the pigpio library should attempt to connect to (if the
|
|
pigpio pin factory is being used). Defaults to ``8888``.
|
|
|
|
|
|
.. only:: builder_man
|
|
|
|
See Also
|
|
--------
|
|
|
|
:manpage:`remote-gpio(7)`
|
|
|
|
.. _revision codes: http://elinux.org/RPi_HardwareHistory
|