summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.RTC.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.RTC.rst
parent4c5bfe2d10cd8397e970c4c23f6c15b97133fcc0 (diff)
downloadmicropython-ea5061e409449118ed45ce2956800780631bcf9e.tar.gz
micropython-ea5061e409449118ed45ce2956800780631bcf9e.zip
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.RTC.rst')
-rw-r--r--docs/library/pyb.RTC.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst
index 478731247a..4b5f4e6b40 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.