diff options
author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-06-08 01:33:49 +0300 |
---|---|---|
committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2016-06-08 01:33:49 +0300 |
commit | 7d7243f44c68c5c1bfeba160a1650174c744722f (patch) | |
tree | bec296a71da5412f7e74ad06de8709696b027422 /docs/library/machine.RTC.rst | |
parent | 93968bd6fb15d1d49e0c2e4a2d412250cc653057 (diff) |
docs/machine.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class
name.
Diffstat (limited to 'docs/library/machine.RTC.rst')
-rw-r--r-- | docs/library/machine.RTC.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst index 684f31aa0..219ca273d 100644 --- a/docs/library/machine.RTC.rst +++ b/docs/library/machine.RTC.rst @@ -24,35 +24,35 @@ Constructors Methods ------- -.. method:: rtc.init(datetime) +.. method:: RTC.init(datetime) Initialise the RTC. Datetime is a tuple of the form: ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])`` -.. method:: rtc.now() +.. method:: RTC.now() Get get the current datetime tuple. -.. method:: rtc.deinit() +.. method:: RTC.deinit() Resets the RTC to the time of January 1, 2015 and starts running it again. -.. method:: rtc.alarm(id, time, /*, repeat=False) +.. method:: RTC.alarm(id, time, /*, repeat=False) Set the RTC alarm. Time might be either a milllisecond value to program the alarm to current time + time_in_ms in the future, or a datetimetuple. If the time passed is in milliseconds, repeat can be set to ``True`` to make the alarm periodic. -.. method:: rtc.alarm_left(alarm_id=0) +.. method:: RTC.alarm_left(alarm_id=0) Get the number of milliseconds left before the alarm expires. -.. method:: rtc.cancel(alarm_id=0) +.. method:: RTC.cancel(alarm_id=0) Cancel a running alarm. -.. method:: rtc.irq(\*, trigger, handler=None, wake=machine.IDLE) +.. method:: RTC.irq(\*, trigger, handler=None, wake=machine.IDLE) Create an irq object triggered by a real time clock alarm. |