summaryrefslogtreecommitdiff
path: root/docs/library/machine.RTC.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/machine.RTC.rst')
-rw-r--r--docs/library/machine.RTC.rst68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst
new file mode 100644
index 000000000..fcfc14f50
--- /dev/null
+++ b/docs/library/machine.RTC.rst
@@ -0,0 +1,68 @@
+.. _machine.RTC:
+
+class RTC -- real time clock
+============================
+
+The RTC is and independent clock that keeps track of the date
+and time.
+
+Example usage::
+
+ rtc = machine.RTC()
+ rtc.datetime((2014, 5, 1, 4, 13, 0, 0, 0))
+ print(rtc.datetime())
+
+
+Constructors
+------------
+
+.. class:: machine.RTC(id=0, ...)
+
+ Create an RTC object. See init for parameters of initialization.
+
+Methods
+-------
+
+.. method:: rtc.init(id, datetime)
+
+ Initialise the RTC. Datetime is a tuple of the form:
+
+ ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
+
+.. method:: rtc.now()
+
+ Get get the current datetime tuple.
+
+.. 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)
+
+ 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)
+
+ Get the number of milliseconds left before the alarm expires.
+
+.. method:: rtc.cancel(alarm_id=0)
+
+ Cancel a running alarm.
+
+.. method:: rtc.irq(\*, trigger, handler=None, wake=machine.IDLE)
+
+ Create an irq object triggered by a real time clock alarm.
+
+ - ``trigger`` must be ``RTC.ALARM0``
+ - ``handler`` is the function to be called when the callback is triggered.
+ - ``wake`` specifies the sleep mode from where this interrupt can wake
+ up the system.
+
+Constants
+---------
+
+.. data:: RTC.ALARM0
+
+ irq trigger source