gpio/gpio.1

   1 .TH "GPIO" "14 June 2012" "Command-Line access to Raspberry Pi and PiFace GPIO"
   2
   3 .SH NAME
   4 gpio \- Command-line access to Raspberry Pi and PiFace GPIO
   5
   6 .SH SYNOPSIS
   7 .B gpio
   8 .B \-v
   9 .PP
  10 .B gpio
  11 .B [ \-g ]
  12 .B read/write/pwm/mode ...
  13 .PP
  14 .B gpio
  15 .B [ \-p ]
  16 .B read/write/mode
  17 .B ...
  18 .PP
  19 .B gpio
  20 .B unexportall/exports
  21 .PP
  22 .B gpio
  23 .B export/edge/unexport
  24 .B ...
  25 .PP
  26 .B gpio
  27 .B drive
  28 group value
  29 .PP
  30 .B gpio
  31 .B pwm-bal/pwm-ms
  32 .PP
  33 .B gpio
  34 .B pwmr
  35 range
  36 .PP
  37 .B gpio
  38 .B load \ i2c/spi
  39 .PP
  40 .B gpio
  41 .B gbr
  42 channel
  43 .PP
  44 .B gpio
  45 .B gbw
  46 channel value
  47
  48 .SH DESCRIPTION
  49
  50 .B GPIO
  51 is a swiss army knife of a command line tool to allow the user easy
  52 access to the GPIO pins on the Raspberry Pi and the SPI A/D and D/A
  53 converters on the Gertboard. It's designed for simple testing and
  54 diagnostic purposes, but can be used in shell scripts for general if
  55 somewhat slow control of the GPIO pins.
  56
  57 Additionally, it can be used to set the exports in the \fI/sys/class/gpio\fR
  58 system directory to allow subsequent programs to use the \fR/sys/class/gpio\fR
  59 interface without needing to be run as root.
  60
  61 .SH OPTIONS
  62
  63 .TP
  64 .B \-v
  65 Output the current version
  66
  67 .TP
  68 .B \-g
  69 Use the BCM_GPIO pins numbers rather than wiringPi pin numbers.
  70
  71 .TP
  72 .B \-p
  73 Use the PiFace interface board and its corresponding pin numbers.
  74
  75 .TP
  76 .B read
  77 Read the digital value of the given pin and print 0 or 1 to represent the
  78 respective logic levels.
  79
  80 .TP
  81 .B write
  82 Write the given value (0 or 1) to the pin.
  83
  84 .TP
  85 .B pwm
  86 Write a PWM value (0-1023) to the given pin.
  87
  88 .TP
  89 .B mode
  90 Set a pin into \fIinput\fR, \fIoutput\fR or \fIpwm\fR mode. Can also
  91 use the literals \fIup\fR, \fIdown\fR or \fItri\fR to set the internal
  92 pull-up, pull-down or tristate (off) controls.
  93
  94 .TP
  95 .B unexportall
  96 Un-Export all the GPIO pins in the /sys/class/gpio directory.
  97
  98 .TP
  99 .B exports
 100 Print a list (if any) of all the exported GPIO pins and their current values.
 101
 102 .TP
 103 .B export
 104 Export a GPIO pin in the \fI/sys/class/gpio\fR directory. Use like the
 105 mode command above however only \fIin\fR and \fIout\fR are supported at
 106 this time. Note that the pin number is the \fBBCM_GPIO\fR number and
 107 not the wiringPi number.
 108
 109 Once a GPIO pin has been exported, the \fBgpio\fR program changes the
 110 ownership of the \fI/sys/class/gpio/gpioX/value\fR and if present in
 111 later kernels, the \fI/sys/class/gpio/gpioX/edge\fR pseudo files to
 112 that of the user running the \fBgpio\fR program. This means that you
 113 can have a small script of gpio exports to setup the gpio pins as your
 114 program requires without the need to run anything as root, or with the
 115 sudo command.
 116
 117 .TP
 118 .B edge
 119 This exports a GPIO pin in the \fI/sys/class/gpio\fR directory, set
 120 the direction to input and set the edge interrupt method to \fInone\fR,
 121 \fIrising\fR, \fIfalling\fR or \fIboth\fR.  Use like the export command
 122 above and note that \fBBCM_GPIO\fR pin number is used not not wiringPi pin
 123 numbering.
 124
 125 Like the export commands above, ownership is set to that of the
 126 calling user, allowing subsequent access from user programs without
 127 requiring root/sudo.
 128
 129 .TP
 130 .B unexport
 131 Un-Export a GPIO pin in the /sys/class/gpio directory.
 132
 133 .TP
 134 .B drive
 135 group value
 136
 137 Change the pad driver value for the given pad group to the supplied drive
 138 value. Group is 0, 1 or 2 and value is 0-7. Do not use unless you are
 139 absolutely sure you know what you're doing.
 140
 141 .TP
 142 .B pwm-bal/pwm-ms
 143 Change the PWM mode to balanced (the default) or mark:space ratio (traditional)
 144
 145 .TP
 146 .B pwmr
 147 Change the PWM range register. The default is 1024.
 148
 149 .TP
 150 .B load i2c/spi
 151 This loads the i2c or the spi drivers into the system and changes the permissions on
 152 the associated /dev/ entries so that the current user has access to them.
 153
 154 .TP
 155 .B gbr
 156 channel
 157
 158 This reads the analog to digital converter on the Gertboard on the given
 159 channel. The board jumpers need to be in-place to do this operation.
 160
 161 .TP
 162 .B gbw
 163 channel value
 164
 165 This writes the supplied value to the output channel on the Gertboards
 166 SPI digital to analogue converter.
 167 The board jumpers need to be in-place to do this operation.
 168
 169
 170 .SH "WiringPi vs. GPIO Pin numbering"
 171
 172 .PP
 173 .TS
 174 r r r l.
 175 WiringPi        GPIO-r1 GPIO-r2 Function
 176 _
 177 0       17      17
 178 1       18      18      (PWM)
 179 2       21      27
 180 3       22      22
 181 4       23      23
 182 5       24      24
 183 6       25      25
 184 7       4       4
 185 8       0       2       I2C: SDA0
 186 9       1       3       I2C: SCL0
 187 10      8       8       SPI: CE0
 188 11      7       7       SPI: CE1
 189 12      10      10      SPI: MOSI
 190 13      9       9       SPI: MISO
 191 14      11      11      SPI: SCLK
 192 15      14      14      TxD
 193 16      15      16      RxD
 194 17      -       28
 195 18      -       29
 196 19      -       30
 197 20      -       31
 198 .TE
 199
 200 .SH FILES
 201
 202 .TP 2.2i
 203 .I gpio
 204 executable
 205
 206 .SH EXAMPLES
 207 .TP 2.2i
 208 gpio mode 4 output # Set pin 4 to output
 209 .PP
 210 gpio -g mode 23 output # Set GPIO pin 23 to output (same as WiringPi pin 4)
 211 .PP
 212 gpio mode 1 pwm # Set pin 1 to PWM mode
 213 .PP
 214 gpio pwm 1 512 # Set pin 1 to PWM value 512 - half brightness
 215 .PP
 216 gpio export 17 out # Set GPIO Pin 17 to output
 217 .PP
 218 gpio export 0 in # Set GPIO Pin 0 (SDA0) to input.
 219 .PP
 220 gpio -g read 0 # Read GPIO Pin 0 (SDA0)
 221
 222 .SH "NOTES"
 223
 224 When using the \fIexport\fR, \fIedge\fR or \fIunexport\fR commands, the
 225 pin numbers are \fBalways\fR native BCM_GPIO numbers and never wiringPi
 226 pin numbers.
 227
 228 .SH "SEE ALSO"
 229
 230 .LP
 231 WiringPi's home page
 232 .IP
 233 https://projects.drogon.net/raspberry-pi/wiringpi/
 234
 235 .SH AUTHOR
 236
 237 Gordon Henderson
 238
 239 .SH "REPORTING BUGS"
 240
 241 Report bugs to <projects@drogon.net>
 242
 243 .SH COPYRIGHT
 244
 245 Copyright (c) 2012 Gordon Henderson
 246 This is free software; see the source for copying conditions. There is NO
 247 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.