aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/detachinterrupt.rst
blob: 82ce974451a99751fd0b1e9293cfc2394aca9ac2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.. _lang-detachinterrupt:

detachInterrupt()
=================

Used to disable an interrupt specified with
:ref:`lang-attachinterrupt`\ .

Library Documentation
---------------------

.. FIXME [Breathe] once we can get the correct detachInterupt(),
.. replace with doxygenfunction.

.. cpp:function:: void detachInterrupt(uint8 pin)

   Disable any registered external interrupt on the given pin.

   *Parameters*

       - ``pin`` Maple pin number

Arduino Compatibility
---------------------

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:`lang-attachinterrupt` to set up your interrupt handler, so
just call ``detachInterrupt()`` with the same pin argument you gave to
``attachInterrupt()``.

See Also
--------

- :ref:`attachInterrupt() <lang-attachInterrupt>`
- :ref:`external-interrupts`

.. include:: /arduino-cc-attribution.txt