Skip to content

Commit

Permalink
docs/machine.Pin: Document "hard" argument of Pin.irq method.
Browse files Browse the repository at this point in the history
  • Loading branch information
peterhinch authored and dpgeorge committed Oct 14, 2018
1 parent 7de9211 commit 759853f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/library/machine.Pin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Methods

Availability: WiPy.

.. method:: Pin.irq(handler=None, trigger=(Pin.IRQ_FALLING | Pin.IRQ_RISING), \*, priority=1, wake=None)
.. method:: Pin.irq(handler=None, trigger=(Pin.IRQ_FALLING | Pin.IRQ_RISING), \*, priority=1, wake=None, hard=False)

Configure an interrupt handler to be called when the trigger source of the
pin is active. If the pin mode is ``Pin.IN`` then the trigger source is
Expand Down Expand Up @@ -213,6 +213,10 @@ Methods
These values can also be OR'ed together to make a pin generate interrupts in
more than one power mode.

- ``hard`` if true a hardware interrupt is used. This reduces the delay
between the pin change and the handler being called. Hard interrupt
handlers may not allocate memory; see :ref:`isr_rules`.

This method returns a callback object.

Constants
Expand Down

0 comments on commit 759853f

Please sign in to comment.