summaryrefslogtreecommitdiff
path: root/docs/library/pyb.Pin.rst
diff options
context:
space:
mode:
authorDaniel Campora <daniel@wipy.io>2015-08-11 11:18:02 +0200
committerDaniel Campora <daniel@wipy.io>2015-08-16 20:17:52 +0200
commitea5061e409449118ed45ce2956800780631bcf9e (patch)
tree107417699e361857372ec07670ae68770cf75832 /docs/library/pyb.Pin.rst
parent4c5bfe2d10cd8397e970c4c23f6c15b97133fcc0 (diff)
cc3200: Improve callback API.
Rename "wakes" param to "wake_from" and make "value" an object instead of an integer.
Diffstat (limited to 'docs/library/pyb.Pin.rst')
-rw-r--r--docs/library/pyb.Pin.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst
index 00a65126d..90de1f6f8 100644
--- a/docs/library/pyb.Pin.rst
+++ b/docs/library/pyb.Pin.rst
@@ -284,15 +284,15 @@ Methods
- ``priority`` level of the interrupt. Can take values in the range 1-7.
Higher values represent higher priorities.
- ``handler`` is an optional function to be called when new characters arrive.
- - ``wakes`` selects the power mode in which this interrupt can wake up the
+ - ``wake_from`` selects the power mode in which this interrupt can wake up the
board. Please note:
- - If ``wakes=pyb.Sleep.ACTIVE`` any pin can wake the board.
- - If ``wakes=pyb.Sleep.SUSPENDED`` pins ``GP2``, ``GP4``, ``GP10``,
+ - If ``wake_from=pyb.Sleep.ACTIVE`` any pin can wake the board.
+ - If ``wake_from=pyb.Sleep.SUSPENDED`` pins ``GP2``, ``GP4``, ``GP10``,
``GP11``, GP17`` or ``GP24`` can wake the board. Note that only 1
of this pins can be enabled as a wake source at the same time, so, only
the last enabled pin as a ``pyb.Sleep.SUSPENDED`` wake source will have effect.
- - If ``wakes=pyb.Sleep.SUSPENDED`` pins ``GP2``, ``GP4``, ``GP10``,
+ - If ``wake_from=pyb.Sleep.SUSPENDED`` pins ``GP2``, ``GP4``, ``GP10``,
``GP11``, ``GP17`` and ``GP24`` can wake the board. In this case all of the
6 pins can be enabled as a ``pyb.Sleep.HIBERNATE`` wake source at the same time.
- Values can be ORed to make a pin generate interrupts in more than one power