Skip to content

Commit 58f1de8

Browse files
committed
Add README to repo.
1 parent dd815ce commit 58f1de8

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
SNAPpy Includes for the Pyduino Development Board
2+
===================================
3+
4+
Introduction
5+
------------
6+
7+
`pyduino-includes` is a SNAPpy library that is designed to make development for the Synapse Pyduino board easier. It
8+
allows references to the nifty Pyduino IO names (like D3, AD0, or SCL) instead of the underlying SNAPpy GPIO numbers.
9+
10+
Installation
11+
------------
12+
13+
The easiest way to install `pyduino-includes` is using
14+
[pip](https://pip.pypa.io/en/latest/installing.html):
15+
16+
pip install git+ssh://[email protected]/tyler.crumpton/pyduino-includes.git@master
17+
18+
Alternatively you can download the source, extract it, and install it:
19+
20+
python setup.py install
21+
22+
(Eventually the package will be pushed to our pip repo, and won't require GitLab access.)
23+
24+
Usage
25+
-------------
26+
27+
In order to use the nice IO names, simply import `pyduino-includes` in your SNAPpy script like this:
28+
29+
```python
30+
from PyduinoIncludes import *
31+
32+
def drive_d4_pin_high():
33+
setPinDir(D4 ,True)
34+
writePin(D4 ,True)
35+
```
36+
37+
Pins can be referenced as follows:
38+
39+
| Pin Type | Pyduino IO Name |
40+
|----------|-----------------|
41+
| Digital | D0 - D13 |
42+
| Analog | A0 - A5 |
43+
| i2c | SDA, SCL |
44+

0 commit comments

Comments
 (0)