Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSayamindu Dasgupta <sayamindu@gmail.com>2009-12-19 12:53:52 (GMT)
committer Sayamindu Dasgupta <sayamindu@gmail.com>2009-12-19 12:53:52 (GMT)
commitee372858b5010dcdebb278b39c8d86bb5acd2fb7 (patch)
tree9beaa3ff7316e693f4391be9e7e060c20b5182bf
parentd7b5b616fb7371089988d7d81bb9292cb4815d1d (diff)
Add a Arduino specific README file
-rw-r--r--README.arduino18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.arduino b/README.arduino
new file mode 100644
index 0000000..9c9e98c
--- /dev/null
+++ b/README.arduino
@@ -0,0 +1,18 @@
+Usage
+=====
+
+Communication with Arduino boards is done via the Firmata[1] protocol.
+You will need to prepare your board by using the standard Arduino IDE
+to upload the latest Firmata code (version 2.1 is recommended). Note that
+the version of Firmata supplied with v17 of the IDE is a bit buggy.
+
+The board usually shows up as /dev/ttyUSBx (x is number) in a Linux system,
+assuming that the connection is over USB-serial. Your user account needs to
+be in the 'uucp' group to access the device. Also, the baud-rate is very
+important for things to work. The baud-rate in the Firmata code, and the
+rate specified in the taarduino.py file should match.
+
+The device name is hardcoded to /dev/ttyUSB0, edit taarduino.py to use
+something else. Patches to autodetect the correct device are most welcome :-).
+
+[1] http://www.firmata.org