Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-10 05:57:16 +01:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

ports: Fix machine.RTC.init() method so argument order matches the docs.

Browse Source 
This commit makes the argument ordering of `machine.RTC.init()` the same
for all the ports that implement arguments to this method: cc3200, esp32,
mimxrt and samd.  The cc3200 argument ordering is used, which matches the
documentation.

Also document the availability and the differing semantics for the stm32
and renesas-ra port.

Signed-off-by: robert-hh <robert@hammelrath.com>
This commit is contained in:
robert-hh
2023-01-28 15:19:37 +01:00
committed by Damien George
parent 0302cd65e8
commit f4e4599523
4 changed files with 31 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/library/machine.RTC.rst
View File

@@ -42,7 +42,14 @@ Methods
Initialise the RTC. Datetime is a tuple of the form:
``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
``(year, month, day, hour, minute, second, microsecond, tzinfo)``
All eight arguments must be present. The ``microsecond`` and ``tzinfo``
values are currently ignored but might be used in the future.
Availability: CC3200, ESP32, MIMXRT, SAMD. The rtc.init() method on
the stm32 and renesas-ra ports just (re-)starts the RTC and does not
accept arguments.
.. method:: RTC.now()