Skip to content
This repository was archived by the owner on Oct 26, 2019. It is now read-only.

Commit 699426a

Browse files
authored
Merge pull request #1 from patrickgardella/master
Add explanations to the README.md and sample code files clarifying wh…
2 parents 9089f9b + 5fee35b commit 699426a

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ Alternatively you can install from pip with:
1616
sudo pip install adafruit-ws2801
1717

1818
Note that the pip install method **won't** install the example code.
19+
20+
## Pin numbering
21+
22+
The library (and the sample code) use the Broadcom BCM GPIO pin numbering scheme, rather than the physical pin numbering scheme. The [Adafruit T-Cobbler breakout board](https://www.adafruit.com/products/1754), for example, uses the BCM scheme. See [https://pinout.xyz](https://pinout.xyz/) for a quick-reference image.

examples/rainbow.py

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
# Configure the count of pixels:
1414
PIXEL_COUNT = 10
1515

16+
# The WS2801 library makes use of the BCM pin numbering scheme. See the README.md for details.
17+
1618
# Specify a software SPI connection for Raspberry Pi on the following pins:
1719
PIXEL_CLOCK = 18
1820
PIXEL_DOUT = 23

examples/simpletest.py

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
# Configure the count of pixels:
1414
PIXEL_COUNT = 10
1515

16+
# The WS2801 library makes use of the BCM pin numbering scheme. See the README.md for details.
17+
1618
# Specify a software SPI connection for Raspberry Pi on the following pins:
1719
PIXEL_CLOCK = 18
1820
PIXEL_DOUT = 23

0 commit comments

Comments
 (0)