33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |  |
41 |
42 |
43 |
44 | $projectname
45 | $projectnumber
46 |
47 | $projectbrief
48 | |
49 |
50 |
51 |
52 |
53 | $projectbrief
54 | |
55 |
56 |
57 |
58 |
59 | $searchbox |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/documentation/i2c.dox:
--------------------------------------------------------------------------------
1 | /**
2 |
3 | @page i2c I2C (BSC)
4 | "The Broadcom Serial Controller (BSC) controller is a master, fast-mode
5 | (400Kb/s) BSC controller. The Broadcom Serial Control bus is a proprietary
6 | bus compliant with the Philips® I2C bus/interface version 2.1 January 2000."
7 | BCM2835 ARM Peripherals
8 |
9 | @section i2c_pinout_rev1 I2C on Rev1 P1 Header
10 | The Raspberry Pi has I2C functionality available at GPIO00, SDA and
11 | GPI01, SCL.
12 |
13 | _______
14 | 3V3 | 1 2 | 5V
15 | SDA (BSC0) | 3 4 | DNC
16 | SCL (BSC0) | 5 6 | GND
17 | GPIO04 | 7 8 | GPIO14
18 | DNC | 9 10 | GPIO15
19 | GPIO17 | 11 12 | GPIO18
20 | GPIO21 | 13 14 | DNC
21 | GPIO22 | 15 16 | GPIO23
22 | DNC | 17 18 | GPIO24
23 | GPIO10 | 19 20 | DNC
24 | GPIO09 | 21 22 | GPIO25
25 | GPIO11 | 23 24 | GPIO08
26 | DNC | 25 26 | GPIO07
27 | _______
28 |
29 |
30 |
31 |
32 | @section i2c_pinout_rev2 I2C on Rev2 P1 Header
33 | The Raspberry Pi has I2C functionality available at GPIO02, SDA and
34 | GPI03, SCL.
35 |
36 | _______
37 | 3V3 | 1 2 | 5V
38 | SDA (BSC1) | 3 4 | 5V
39 | SCL (BSC1) | 5 6 | GND
40 | GPIO04 | 7 8 | GPIO14
41 | GND | 9 10 | GPIO15
42 | GPIO17 | 11 12 | GPIO18
43 | GPIO27 | 13 14 | GND
44 | GPIO22 | 15 16 | GPIO23
45 | 3V3 | 17 18 | GPIO24
46 | GPIO10 | 19 20 | GND
47 | GPIO09 | 21 22 | GPIO25
48 | GPIO11 | 23 24 | GPIO08
49 | GND | 25 26 | GPIO07
50 | _______
51 |
52 |
53 |
54 | @section i2c_revision PCB Revisions
55 | @note This library should automatically detect the correct BSC module to use.
56 | Since the pins for both revisions are physically located in the same spot on
57 | the header, this should be transparent to the user.
58 | */
59 |
--------------------------------------------------------------------------------
/documentation/mainpage.dox:
--------------------------------------------------------------------------------
1 | /**
2 |
3 | @brief The library provided here allows basic input / output control over the
4 | GPIO pins of a Raspberry Pi (rev1 and rev2) from C. The pins are
5 | accessed from memory mapped pointer to /dev/mem (see man mmap).
6 |
7 | @mainpage
8 | @section getting_started Getting Started
9 |
10 | @subsection getting_started_build Building the library: librpigpio.a
11 |
12 | To build the library file change directory to src (assuming you are at the top
13 | level directory of RaspberryPi-GPIO) type "make" in the terminal:
14 |
15 |
16 | cd src
17 | make
18 |
19 |
20 | If this command was successful you should see a new directory called library
21 | now exists at the root level. librpigpio.a should be found in this directory;
22 | library/librpigpio.a.
23 |
24 | @subsection getting_started_examples Examples
25 | There is example code provided in the directory examples. To compile this code
26 | change directory to examples and type "make".
27 |
28 |
29 | cd examples
30 | make
31 |
32 |
33 | You should see a new folder - called output - is created in examples. The
34 | example binaries can be found within this folder - examples/output/.
35 |
36 | To execute one of the examples you must first give it execute permissions.
37 |
38 | chmod +x output/\
39 |
40 |
41 | The examples should be run as root.
42 |
43 |
44 | sudo ./output/\
45 |
46 |
47 | @section ack Acknowledgements
48 | Some of the code was based upon an example by Dom and Gert which was found
49 | at: http://elinux.org/RPi_Low-level_peripherals#Introduction.
50 | Thanks to github user sjaeckel for his large part in adding support for
51 | the rev2 PCB layout.
52 |
53 | @section copy Copyright
54 | This program is free software: you can redistribute it and/or modify
55 | it under the terms of the GNU General Public License as published by
56 | the Free Software Foundation, either version 3 of the License, or
57 | (at your option) any later version.
58 | This program is distributed in the hope that it will be useful,
59 | but WITHOUT ANY WARRANTY; without even the implied warranty of
60 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
61 | GNU General Public License for more details.
62 | You should have received a copy of the GNU General Public License
63 | along with this program. If not, see
.
64 |
65 | @section refs References
66 | elinux Wiki on Raspberry Pi GPIO: http://elinux.org/RPi_Low-level_peripherals#Introduction \n
67 | Raspberry Pi blog post on GPIO: http://www.raspberrypi-spy.co.uk/2012/06/simple-guide-to-the-rpi-gpio-header-and-pins/ \n
68 | Datasheet: http://www.raspberrypi.org/wp-content/uploads/2012/02/BCM2835-ARM-Peripherals.pdf
69 | */
70 |
71 |
--------------------------------------------------------------------------------
/documentation/usepage.dox:
--------------------------------------------------------------------------------
1 | /**
2 | @page advice Advice on Use
3 |
4 | @section advice_include Including the Library
5 |
6 | To use this library you must:
7 |
8 | @par Correctly Include the Header File
9 | The header file rpiGpio.h must be included in whatever source files use a GPIO
10 | function i.e. \#include "rpiGpio.h". You will also need to ensure that your
11 | compiler can find this header file. In GCC you can include the path
12 | to the directory the header resides with -I\
. E.g.
13 |
14 | gcc -I/path/to/RaspberryPi-GPIO-C/include/ -o \ \
15 | \
16 |
23 | gcc -I/path/to/RaspberryPi-GPIO-C/include/ -o \ \
24 | \
25 | \
26 |
34 | gcc -I/path/to/RaspberryPi-GPIO-C/include/ \
35 | -L/path/to/RaspberryPi-GPIO-C/library \
36 | -o outputfile \ \
37 | -lRpiGpio
38 |