Gordons Projects

--> Projects Top-Level GIT

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