aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/unimplemented/pulsein.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/unimplemented/pulsein.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/lang/unimplemented/pulsein.rst')
-rw-r--r--docs/source/lang/unimplemented/pulsein.rst82
1 files changed, 0 insertions, 82 deletions
diff --git a/docs/source/lang/unimplemented/pulsein.rst b/docs/source/lang/unimplemented/pulsein.rst
deleted file mode 100644
index 2b52428..0000000
--- a/docs/source/lang/unimplemented/pulsein.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-.. _lang-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);
- }
-
-
-
-
-.. include:: /lang/cc-attribution.txt