gpio/gpio.1

   1 .TH GPIO 1 "September 2015" wiringPi "Command-Line access to Raspberry Pi's GPIO"
   2
   3 .SH NAME
   4 gpio \- Command-line access to Raspberry Pi's GPIO
   5
   6 .SH SYNOPSIS
   7 .B gpio
   8 .B \-v
   9 .PP
  10 .B gpio
  11 .B [ \-g | \-1 ]
  12 .B mode/read/write/aread/awrite/wb/pwm/clock ...
  13 .PP
  14 .B gpio
  15 .B [ \-x extension:params ]
  16 .B mode/read/write/aread/awrite/pwm/pwmTone ...
  17 .PP
  18 .B gpio
  19 .B [ \-p ]
  20 .B read/write/toggle/wb
  21 .B ...
  22 .PP
  23 .B gpio
  24 .B readall
  25 .PP
  26 .B gpio
  27 .B unexportall/exports
  28 .PP
  29 .B gpio
  30 .B export/edge/unexport
  31 .B ...
  32 .PP
  33 .B gpio
  34 .B wfi
  35 .B ...
  36 .PP
  37 .B gpio
  38 .B drive
  39 group value
  40 .PP
  41 .B gpio
  42 .B usbp
  43 high | low
  44 .PP
  45 .B gpio
  46 .B pwm-bal/pwm-ms
  47 .PP
  48 .B gpio
  49 .B pwmr
  50 range
  51 .PP
  52 .B gpio
  53 .B load \ i2c/spi ...
  54 .PP
  55 .B gpio
  56 .B gbr
  57 channel
  58 .PP
  59 .B gpio
  60 .B gbw
  61 channel value
  62
  63 .SH DESCRIPTION
  64
  65 .B GPIO
  66 is a swiss army knife of a command line tool to allow the user easy
  67 access to the GPIO pins on the Raspberry Pi and the SPI A/D and D/A
  68 converters on the Gertboard. It's designed for simple testing and
  69 diagnostic purposes, but can be used in shell scripts for general if
  70 somewhat slow control of the GPIO pins.
  71
  72 It can also control the IO's on the PiFace IO board and load the SPI and I2C
  73 kernel modules if required.
  74
  75 Additionally, it can be used to set the exports in the \fI/sys/class/gpio\fR
  76 system directory to allow subsequent programs to use the \fR/sys/class/gpio\fR
  77 interface without needing to be run as root.
  78
  79 .SH OPTIONS
  80
  81 .TP
  82 .B \-v
  83 Output the current version including the board revision of the Raspberry Pi.
  84
  85 .TP
  86 .B \-g
  87 Use the BCM_GPIO pins numbers rather than wiringPi pin numbers.
  88 \fINote:\fR The BCM_GPIO pin numbers are always used with the
  89 export and edge commands.
  90
  91 .TP
  92 .B \-1
  93 Use the physical pin numbers rather than wiringPi pin numbers.
  94 \fINote:\fR that this applies to the P1 connector only. It is not possible to
  95 use pins on the Revision 2 P5 connector this way, and as with \-g the
  96 BCM_GPIO pin numbers are always used with the export and edge commands.
  97
  98 .TP
  99 .B \-x extension
 100 This causes the named extension to be initialised. Extensions
 101 comprise of a name (e.g. mcp23017) followed by a colon, then the
 102 pin-base, then more optional parameters depending on the extension type.
 103 See the web page on http://wiringpi.com/the-gpio-utility/
 104
 105 .TP
 106 .B \-p
 107 Use the PiFace interface board and its corresponding pin numbers. The PiFace
 108 will always appear at pin number 200 in the gpio command. You can assign any
 109 pin numbers you like in your own programs though.
 110
 111 .TP
 112 .B read <pin>
 113 Read the digital value of the given pin and print 0 or 1 to represent the
 114 respective logic levels.
 115
 116 .TP
 117 .B write <pin> <value>
 118 Write the given value (0 or 1) to the pin. You need to set the pin
 119 to output mode first.
 120
 121 .TP
 122 .B aread <pin>
 123 Read the analog value of the given pin. This needs to be uses in
 124 conjunction with a -x flag to add in an extension that handles analog
 125 inputs.  respective logic levels.
 126
 127 e.g. gpio -x mcp3002:200:0 aread 200
 128
 129 will read the first analog input on an mcp3002 SPI ADC chip.
 130
 131 .TP
 132 .B awrite <pin> <value>
 133 Write the analog value to the given pin. This needs to be used in
 134 conjunction with a -x flag to add in an extension that handles analog
 135 inputs.  respective logic levels.
 136
 137 e.g. gpio -x mcp4802:200:0 awrite 200 128
 138
 139 will write the value 128 to the first DAC port on an mcp4802 chip on
 140 the Pi's SPI bus 0.
 141
 142
 143 .TP
 144 .B wb <value>
 145 Write the given byte to the 8 main GPIO pins. You can prefix it with 0x
 146 to specify a hexadecimal number. You need to set pins to output mode
 147 first.
 148
 149 .TP
 150 .B readall
 151 Output a table of all GPIO pins values. The values represent the actual values read
 152 if the pin is in input mode, or the last value written if the pin is in output
 153 mode.
 154
 155 The readall command is usable with an extension module (via the -x parameter),
 156 but it's unable to determine pin modes or states, so will perform both a
 157 digital and analog read on each pin in-turn.
 158
 159 .TP
 160 .B pwm <pin> <value>
 161 Write a PWM value (0-1023) to the given pin. The pin needs to be put
 162 into PWM mode first.
 163
 164 .TP
 165 .B clock <pin> <frequency>
 166 Set the output frequency on the given pin. The pin needs to be put into
 167 clock mode first.
 168
 169 .TP
 170 .B mode <pin> <mode>
 171 Set a pin into \fIinput\fR, \fIoutput\fR or \fIpwm\fR mode. Can also
 172 use the literals \fIup\fR, \fIdown\fR or \fItri\fR to set the internal
 173 pull-up, pull-down or tristate (off) controls.
 174
 175 The ALT modes can also be set using \fIalt0\fR, \fIalt1\fR,  ... \fIalt5\fR.
 176
 177 .TP
 178 .B unexportall
 179 Un-Export all the GPIO pins in the /sys/class/gpio directory.
 180
 181 .TP
 182 .B exports
 183 Print a list (if any) of all the exported GPIO pins and their current values.
 184
 185 .TP
 186 .B export
 187 Export a GPIO pin in the \fI/sys/class/gpio\fR directory. Use like the
 188 mode command above however only \fIin\fR, \fIout\fR, \fIhigh\fR and
 189 \fRlow\fR are supported at this time. Note that the pin number is the
 190 \fBBCM_GPIO\fR number and not the wiringPi number. The \fIhigh\fR and
 191 \fIlow\fR commands pre-set the output value at the same time as the
 192 export to output mode.
 193
 194 Once a GPIO pin has been exported, the \fBgpio\fR program changes the
 195 ownership of the \fI/sys/class/gpio/gpioX/value\fR and if present in
 196 later kernels, the \fI/sys/class/gpio/gpioX/edge\fR pseudo files to
 197 that of the user running the \fBgpio\fR program. This means that you
 198 can have a small script of gpio exports to setup the gpio pins as your
 199 program requires without the need to run anything as root, or with the
 200 sudo command.
 201
 202 .TP
 203 .B edge
 204 This exports a GPIO pin in the \fI/sys/class/gpio\fR directory, set
 205 the direction to input and set the edge interrupt method to \fInone\fR,
 206 \fIrising\fR, \fIfalling\fR or \fIboth\fR.  Use like the export command
 207 above and note that \fBBCM_GPIO\fR pin number is used not not wiringPi pin
 208 numbering.
 209
 210 Like the export commands above, ownership is set to that of the
 211 calling user, allowing subsequent access from user programs without
 212 requiring root/sudo.
 213
 214 .TP
 215 .B unexport
 216 Un-Export a GPIO pin in the /sys/class/gpio directory.
 217
 218 .TP
 219 .B wfi <pin> <mode>
 220 This set the given pin to the supplied interrupt mode: rising, falling
 221 or both then waits for the interrupt to happen. It's a non-busy wait,
 222 so does not consume and CPU while it's waiting.
 223
 224 .TP
 225 .B drive
 226 group value
 227
 228 Change the pad driver value for the given pad group to the supplied drive
 229 value. Group is 0, 1 or 2 and value is 0-7. Do not use unless you are
 230 absolutely sure you know what you're doing.
 231
 232 .TP
 233 .B usbp
 234 high | low
 235
 236 Change the USB current limiter to high (1.2 amps) or low (the default, 600mA)
 237 This is only applicable to the model B+
 238
 239 .TP
 240 .B pwm-bal/pwm-ms
 241 Change the PWM mode to balanced (the default) or mark:space ratio (traditional)
 242
 243 .TP
 244 .B pwmr
 245 Change the PWM range register. The default is 1024.
 246
 247 .TP
 248 .B load i2c [baudrate]
 249 This loads the i2c or drivers into the kernel and changes the permissions
 250 on the associated /dev/ entries so that the current user has access to
 251 them. Optionally it will set the I2C baudrate to that supplied in Kb/sec
 252 (or as close as the Pi can manage) The default speed is 100Kb/sec.
 253
 254 Note: On recent kernels with the device tree enabled you should use the
 255 raspi-config program to load/unload the I2C device at boot time.
 256 (or disable the device tree to continue to use this method)
 257
 258 .TP
 259 .B load spi
 260 This loads the spi drivers into the kernel and changes the permissions
 261 on the associated /dev/ entries so that the current user has access to
 262 them. It used to have the ability to change the buffer size from the
 263 default of 4096 bytes to an arbitrary value, however for some time the
 264 Pi Foundation have compiled the SPI device driver into the kernel and
 265 this has fixed the buffer size. The way to change it now is to edit
 266 the /boot/cmdline.txt file and add on spdev.bufsiz=8192 to set it to
 267 e.g. 8192 bytes then reboot.
 268
 269 Note: On recent kernels with the device tree enabled you should use the
 270 raspi-config program to load/unload the SPI device at boot time.
 271 (or disable the device tree to continue to use this method)
 272
 273 .TP
 274 .B gbr
 275 channel
 276
 277 This reads the analog to digital converter on the Gertboard on the given
 278 channel. The board jumpers need to be in-place to do this operation.
 279
 280 .TP
 281 .B gbw
 282 channel value
 283
 284 This writes the supplied value to the output channel on the Gertboards
 285 SPI digital to analogue converter.
 286 The board jumpers need to be in-place to do this operation.
 287
 288
 289 .SH "WiringPi vs. BCM_GPIO Pin numbering vs. Physical pin numbering"
 290
 291 .PP
 292 The quickest way to get a list of the pin differences is to run the command
 293 .TP
 294 gpio readall
 295
 296 .SH FILES
 297
 298 .TP 2.2i
 299 .I gpio
 300 executable
 301
 302 .SH EXAMPLES
 303 .TP 2.2i
 304 gpio mode 4 output # Set pin 4 to output
 305 .PP
 306 gpio -g mode 23 output # Set GPIO pin 23 to output (same as WiringPi pin 4)
 307 .PP
 308 gpio mode 1 pwm # Set pin 1 to PWM mode
 309 .PP
 310 gpio pwm 1 512 # Set pin 1 to PWM value 512 - half brightness
 311 .PP
 312 gpio export 17 out # Set GPIO Pin 17 to output
 313 .PP
 314 gpio export 0 in # Set GPIO Pin 0 (SDA0) to input.
 315 .PP
 316 gpio -g read 0 # Read GPIO Pin 0 (SDA0)
 317
 318 .SH "NOTES"
 319
 320 When using the \fIexport\fR, \fIedge\fR or \fIunexport\fR commands, the
 321 pin numbers are \fBalways\fR native BCM_GPIO numbers and never wiringPi
 322 pin numbers.
 323
 324 As of kernels 4.1.7, a user-level GPIO access mechanism is available,
 325 however wiringPi will not use this by default - because at this time
 326 there appears to be issues when trying to program the PWM or clock output
 327 hardware. If you can live without PWM or GPIO clocks and you want to use
 328 the GPIO from a non-root program, then you need to make sure that the
 329 module \fIbcm2835_gpiomem\fR is loaded at boot time. This should happen
 330 automatically when you enable the device tree in raspi-config. You may
 331 also need some additional information in /etc/udev/rules.d/ to change the
 332 mode and ownership of the /dev/gpiomem file. Finally, you need to set
 333 the environment variable \fIWIRINGPI_GPIOMEM\fR. This will go-away
 334 in future releases once the /dev/gpiomem interface is fully operational.
 335
 336 .SH "SEE ALSO"
 337
 338 .LP
 339 WiringPi's home page
 340 .IP
 341 http://wiringpi.com/
 342
 343 .SH AUTHOR
 344
 345 Gordon Henderson
 346
 347 .SH "REPORTING BUGS"
 348
 349 Please report bugs to <projects@drogon.net>
 350
 351 .SH COPYRIGHT
 352
 353 Copyright (c) 2012-2015 Gordon Henderson
 354 This is free software; see the source for copying conditions. There is NO
 355 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 356
 357 .SH TRADEMARKS AND ACKNOWLEDGEMENTS
 358
 359 Raspberry Pi is a trademark of the Raspberry Pi Foundation. See
 360 http://raspberrypi.org/ for full details.