diff options
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/network.rst | 4 | ||||
| -rw-r--r-- | docs/library/pyb.Pin.rst | 8 | ||||
| -rw-r--r-- | docs/library/pyb.RTC.rst | 4 |
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst index 99a300dbe..1b00c4f0d 100644 --- a/docs/library/network.rst +++ b/docs/library/network.rst @@ -336,12 +336,12 @@ class WLAN Returns a list of the devices currently connected. Each item in the list is a tuple of ``(ssid, mac)``. - .. method:: wlan.callback(wakes) + .. method:: wlan.callback(wake_from) Create a callback to be triggered when a WLAN event occurs during ``pyb.Sleep.SUSPENDED`` mode. Events are triggered by socket activity or by WLAN connection/disconnection. - - ``wakes`` can only be ``pyb.Sleep.SUSPENDED``. + - ``wake_from`` must be ``pyb.Sleep.SUSPENDED``. Returns a callback object. 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 diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst index 478731247..4b5f4e6b4 100644 --- a/docs/library/pyb.RTC.rst +++ b/docs/library/pyb.RTC.rst @@ -90,12 +90,12 @@ Methods .. only:: port_wipy - .. method:: rtc.callback(\*, value, handler=None, wakes=pyb.Sleep.ACTIVE) + .. method:: rtc.callback(\*, value, handler=None, wake_from=pyb.Sleep.ACTIVE) Create a callback object triggered by a real time clock alarm. - ``value`` is the alarm timeout in milliseconds. This parameter is required. - ``handler`` is the function to be called when the callback is triggered. - - ``wakes`` specifies the power mode from where this interrupt can wake + - ``wake_from`` specifies the power mode from where this interrupt can wake up the system. |