diff options
| author | Peter Hinch <peter@hinch.me.uk> | 2018-10-08 06:05:11 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-10-15 00:17:54 +1100 |
| commit | 759853f2a111d18eb9b6a9d40c5fd31501f64e53 (patch) | |
| tree | 737eac10f4197c27592bc2d27a4c2ea4fea586ef /docs | |
| parent | 7de9211b80fa6aa647ffe8f4c2dfa9e0aee8b685 (diff) | |
docs/machine.Pin: Document "hard" argument of Pin.irq method.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/machine.Pin.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/library/machine.Pin.rst b/docs/library/machine.Pin.rst index 387d0f73f..a355a6f7c 100644 --- a/docs/library/machine.Pin.rst +++ b/docs/library/machine.Pin.rst @@ -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 @@ -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 |