From 22ff1db8a76c7047b61a424ae1fa5f43697fcb34 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@mit.edu>
Date: Wed, 20 Oct 2010 06:46:52 -0400
Subject: initial check-in of arduino docs in RST format (converted using
 wget+pandoc)

---
 docs/source/arduino/pulsein.rst | 79 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 docs/source/arduino/pulsein.rst

(limited to 'docs/source/arduino/pulsein.rst')

diff --git a/docs/source/arduino/pulsein.rst b/docs/source/arduino/pulsein.rst
new file mode 100644
index 0000000..568d992
--- /dev/null
+++ b/docs/source/arduino/pulsein.rst
@@ -0,0 +1,79 @@
+.. _arduino-pulsein:
+
+pulseIn()
+=========
+
+Description
+-----------
+
+Reads a pulse (either HIGH or LOW) on a pin. For example, if
+**value** is **HIGH**, **pulseIn()** waits for the pin to go
+**HIGH**, starts timing, then waits for the pin to go **LOW** and
+stops timing. Returns the length of the pulse in microseconds.
+Gives up and returns 0 if no pulse starts within a specified time
+out.
+
+
+
+The timing of this function has been determined empirically and
+will probably show errors in longer pulses. Works on pulses from 10
+microseconds to 3 minutes in length.
+
+
+
+Syntax
+------
+
+pulseIn(pin, value)
+pulseIn(pin, value, timeout)
+
+
+
+Parameters
+----------
+
+pin: the number of the pin on which you want to read the pulse.
+(*int*)
+
+
+
+value: type of pulse to read: either
+`HIGH <http://arduino.cc/en/Reference/Constants>`_ or
+`LOW <http://arduino.cc/en/Reference/Constants>`_. (*int*)
+
+
+
+timeout (optional): the number of microseconds to wait for the
+pulse to start; default is one second (*unsigned long*)
+
+
+
+Returns
+-------
+
+the length of the pulse (in microseconds) or 0 if no pulse started
+before the timeout (*unsigned long*)
+
+
+
+Example
+-------
+
+::
+
+     
+    
+    int pin = 7;
+    unsigned long duration;
+    
+    void setup()
+    {
+      pinMode(pin, INPUT);
+    }
+    
+    void loop()
+    {
+      duration = pulseIn(pin, HIGH);
+    }
+
+
-- 
cgit v1.2.3