Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,23 @@ while True:
board.digitalWrite(13, "HIGH")
time.sleep(1)
```
Any function or command that you would run in `void setup()` you will run right after the import statements. The `while True:` functions as the `void loop()`. That is why the Serial initalization and `pinMode` occured earlier.

## Requirements:
- [Python](http://python.org/) 2.3 or higher (Python 3.x not yet tested, but would probably work)
- [pyserial](http://pyserial.sourceforge.net/) 2.6 or higher
- Any [Arduino compatible microcontroller](https://www.sparkfun.com/categories/242) with at least 14KB of flash memory

## Installation:
Either run `pip install arduino-python` from a command line, or run `python setup.py
build install` from the source directory to install this library.
### Using PIP
Run `pip install arduino-python` from a command line

### Build and Install from source:
Clone the repo: `git clone https://github.com/thearn/Python-Arduino-Command-API.git`
Navigate to the directory
Run `python setup.py build install`

***NOTE: On Linux systems, you must use `python setup.py build install` only if you have python2 specifically installed. Run `python` to see the verison. Many linux distros come with `python` aliased to `python3`***

## Setup:
1. Verify that your Arduino board communicates at the baud rate specified in the
Expand Down