djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/machine.Pin: Document "hard" argument of Pin.irq method.

Browse Source
This commit is contained in:
Peter Hinch 2018-10-08 06:05:11 +01:00 committed by Damien George
parent 7de9211b80
commit 759853f2a1
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/library/machine.Pin.rst
View File

@ -179,7 +179,7 @@ Methods
Availability: WiPy. 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 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 pin is active. If the pin mode is ``Pin.IN`` then the trigger source is
@ -213,6 +213,10 @@ Methods
These values can also be OR'ed together to make a pin generate interrupts in These values can also be OR'ed together to make a pin generate interrupts in
more than one power mode. 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. This method returns a callback object.
Constants Constants