aboutsummaryrefslogtreecommitdiffstats
path: root/source/arduino/detachinterrupt.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-10-25 21:15:28 -0400
committerMarti Bolivar <mbolivar@mit.edu>2010-11-17 12:44:28 -0500
commit2d429e75ce69e77f8c95490ac03881ec9aa0354a (patch)
treea3b810a6c75625b07a4b976e5d1e319c60e19a6b /source/arduino/detachinterrupt.rst
parent30ac55d80c18e93f9c39a6dd850c10f9e7fd92ac (diff)
downloadlibrambutan-2d429e75ce69e77f8c95490ac03881ec9aa0354a.tar.gz
librambutan-2d429e75ce69e77f8c95490ac03881ec9aa0354a.zip
arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed
Diffstat (limited to 'source/arduino/detachinterrupt.rst')
-rw-r--r--source/arduino/detachinterrupt.rst32
1 files changed, 20 insertions, 12 deletions
diff --git a/source/arduino/detachinterrupt.rst b/source/arduino/detachinterrupt.rst
index f0342df..f770de1 100644
--- a/source/arduino/detachinterrupt.rst
+++ b/source/arduino/detachinterrupt.rst
@@ -1,26 +1,34 @@
.. _arduino-detachinterrupt:
-detachInterrupt(interrupt)
-==========================
+detachInterrupt()
+=================
-Description
------------
+Used to disable an interrupt specified with
+:ref:`arduino-attachinterrupt`\ .
-Turns off the given interrupt.
+Library Documentation
+---------------------
+.. doxygenfunction:: detachInterrupt
-Parameters
-----------
+Arduino Compatibility
+---------------------
-interrupt: the number of interrupt to disable (0 or 1).
+There is one important difference between the Maple version of
+detachInterrupt and the Arduino version. On the Maple, the argument
+to ``detachInterrupt()`` is the *pin* on which the interrupt is
+attached, while on the Arduino, the argument is the *interrupt
+number*, which is different from the pin the interrupt is enabled on.
+If you're calling this function, you've already called
+:ref:`arduino-attachinterrupt` to set up your interrupt handler, so
+just call ``detachInterrupt()`` with the same pin argument you gave to
+``attachInterrupt()``.
-
-See also
+See Also
--------
-
-- `attachInterrupt <http://arduino.cc/en/Reference/AttachInterrupt>`_\ ()
+- :ref:`attachInterrupt() <arduino-attachInterrupt>`