Skip to content
This repository was archived by the owner on Jun 14, 2024. It is now read-only.

Commit ba857ab

Browse files
add other docs
1 parent bf951e1 commit ba857ab

File tree

3 files changed

+49
-1
lines changed

3 files changed

+49
-1
lines changed

docs/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
# Documentation on PowerShell IoT
22

3-
This folder contains documentation on how to get started with PowerShell IoT and general usage. For examples, go [here](/Examples)!
3+
This folder contains documentation on how to get started with PowerShell IoT and general usage. For examples, go [here](/Examples)!
4+
5+
## Table of contents
6+
7+
* [Raspberry Pi 3 Pin layout](/docs/rpi3_pin_layout.md)
8+
* [API reference](/docs/api_reference.md)

docs/api_reference.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# API Reference
2+
3+
Coming soon... Need to hook this up to platyps.

docs/rpi3_pin_layout.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Pin layout
2+
3+
PowerShell IoT uses Wiring Pi under the hood.
4+
As such, it follow the Wiring Pi scheme for pin identification.
5+
For all of the `Pin` parameters in this module, use the WiringPi/wPi number listed in the following diagram:
6+
7+
## Image reference
8+
9+
![Raspberry Pi 3 pin layout](https://ocw.cs.pub.ro/courses/_media/iot/labs/pins-raspberrypi.png?w=700&tok=35c802)
10+
11+
## Text reference
12+
13+
```plaintext
14+
+-----+-----+---------+------+---+---Pi 3---+---+------+---------+-----+-----+
15+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
16+
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
17+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
18+
| 2 | 8 | SDA.1 | ALT0 | 1 | 3 || 4 | | | 5v | | |
19+
| 3 | 9 | SCL.1 | ALT0 | 1 | 5 || 6 | | | 0v | | |
20+
| 4 | 7 | GPIO. 7 | IN | 1 | 7 || 8 | 0 | IN | TxD | 15 | 14 |
21+
| | | 0v | | | 9 || 10 | 1 | IN | RxD | 16 | 15 |
22+
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
23+
| 27 | 2 | GPIO. 2 | OUT | 0 | 13 || 14 | | | 0v | | |
24+
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
25+
| | | 3.3v | | | 17 || 18 | 1 | IN | GPIO. 5 | 5 | 24 |
26+
| 10 | 12 | MOSI | IN | 0 | 19 || 20 | | | 0v | | |
27+
| 9 | 13 | MISO | IN | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
28+
| 11 | 14 | SCLK | IN | 0 | 23 || 24 | 1 | IN | CE0 | 10 | 8 |
29+
| | | 0v | | | 25 || 26 | 1 | IN | CE1 | 11 | 7 |
30+
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
31+
| 5 | 21 | GPIO.21 | IN | 1 | 29 || 30 | | | 0v | | |
32+
| 6 | 22 | GPIO.22 | IN | 1 | 31 || 32 | 0 | IN | GPIO.26 | 26 | 12 |
33+
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
34+
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
35+
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
36+
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
37+
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
38+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
39+
+-----+-----+---------+------+---+---Pi 3---+---+------+---------+-----+-----+
40+
```

0 commit comments

Comments
 (0)