Commits

Tino de Bruijn committed 2b79dee

Added README

  • Participants
  • Parent commits 0728abd

Comments (0)

Files changed (1)

+-*- restructuredtext -*-
+
+=========
+pyFirmata
+=========
+
+Usage
+=====
+
+.. code-block:: python
+
+    >>> from pyfirmata import Board, util
+    >>> board = Board('/dev/tty.usbserial-A6008rIF')
+    >>> board.digital[13].write(1)
+
+To use analog ports, it is probably handy to start an iterator thread. Otherwise the board will keep sending data to your serial, until it overflows::
+
+    >>> it = util.Iterator(board)
+    >>> it.start()
+    >>> board.analog[0].enable_reporting()
+    >>> board.analog[0].read()
+    0.661440304938
+    
+If you use a pin more often, it can be worth it to use the ``get_pin`` method of the board. It let's you specify what pin you need by a string, composed of 'a' or 'd' (depending on wether you need an analog or digital pin), the pin number, and the mode ('i' for input, 'o' for output, 'p' for pwm). All seperated by ``:``. Eg. ``a:0:i`` for analog 0 as input, or ``d:3:p`` for digital pin 3 as pwm.::
+
+    >>> analog_0 = board.get_pin('a:0:i')
+    >>> analog_0.read()
+    0.661440304938
+    >>> pin3 = board.get_pin('d:3:p')
+    >>> pin3.write(0.6)
+