aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/pulsein.rst
diff options
context:
space:
mode:
authorPerry Hung <iperry@gmail.com>2011-01-24 23:23:29 -0500
committerPerry Hung <iperry@gmail.com>2011-01-24 23:23:29 -0500
commitc48689d34809943a5907884bd287cea9ae275352 (patch)
treed49ff06b0d4b81f6ab0eac8060d178ce7542476c /docs/source/arduino/pulsein.rst
parent64431fd4b59cb8656365f1fad5f679cd4d756239 (diff)
parenta9b2d70bc7799ca96c1673b18fe3012b1a4dd329 (diff)
downloadlibrambutan-c48689d34809943a5907884bd287cea9ae275352.tar.gz
librambutan-c48689d34809943a5907884bd287cea9ae275352.zip
Merge remote branch 'leaf/master'
Diffstat (limited to 'docs/source/arduino/pulsein.rst')
-rw-r--r--docs/source/arduino/pulsein.rst79
1 files changed, 0 insertions, 79 deletions
diff --git a/docs/source/arduino/pulsein.rst b/docs/source/arduino/pulsein.rst
deleted file mode 100644
index 568d992..0000000
--- a/docs/source/arduino/pulsein.rst
+++ /dev/null
@@ -1,79 +0,0 @@
-.. _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);
- }
-
-