Improve documentation for `rtc`.

- Add examples for `rtc.RTC.datetime`.
- Add type for `rtc.RTC.calibration`.
- Expand on use cases for `rtc.set_time_source`.
crypto-aes
Thea Flowers 3 years ago
parent af1fab1915
commit 4a55c48dbf
No known key found for this signature in database
GPG Key ID: 3CA6321E8CACD921

@ -57,7 +57,23 @@ STATIC mp_obj_t rtc_rtc_make_new(const mp_obj_type_t *type, size_t n_args, const
//| .. attribute:: datetime
//|
//| The date and time of the RTC.
//| The current date and time of the RTC as a `time.struct_time`.
//|
//| This must be set to the current date and time whenever the board loses power::
//|
//| import rtc
//| import time
//|
//| r = rtc.RTC()
//| r.datetime = rtctime.struct_time((2019, 5, 29, 15, 14, 15, 0, -1, -1))
//|
//|
//| Once set, the RTC will automatically update this value as time passes. You can read this
//| property to get a snapshot of the current time::
//|
//| current_time = r.datetime
//| print(current_time)
//| # struct_time(tm_year=2019, tm_month=5, ...)
//|
STATIC mp_obj_t rtc_rtc_obj_get_datetime(mp_obj_t self_in) {
timeutils_struct_time_t tm;
@ -83,9 +99,10 @@ const mp_obj_property_t rtc_rtc_datetime_obj = {
//| .. attribute:: calibration
//|
//| The RTC calibration value.
//| The RTC calibration value as an `int`.
//|
//| A positive value speeds up the clock and a negative value slows it down.
//| Range and value is hardware specific, but one step is often approx. 1 ppm.
//| Range and value is hardware specific, but one step is often approximately 1 ppm.
//|
STATIC mp_obj_t rtc_rtc_obj_get_calibration(mp_obj_t self_in) {
int calibration = common_hal_rtc_get_calibration();

@ -36,12 +36,13 @@
//|
//| .. module:: rtc
//| :synopsis: Real Time Clock
//| :platform: SAMD21
//| :platform: SAMD21, SAMD51, nRF52
//|
//| The `rtc` module provides support for a Real Time Clock.
//| It also backs the `time.time()` and `time.localtime()` functions using the onboard RTC if present.
//| The `rtc` module provides support for a Real Time Clock. You can access and manage the
//| RTC using :class:`rtc.RTC`. It also backs the :func:`time.time` and :func:`time.localtime`
//| functions using the onboard RTC if present.
//|
//| Libraries
//| Classes
//|
//| .. toctree::
//| :maxdepth: 3
@ -63,10 +64,9 @@ mp_obj_t rtc_get_time_source_time(void) {
//| .. function:: set_time_source(rtc)
//|
//| Sets the rtc time source used by time.localtime().
//| The default is `rtc.RTC()`.
//|
//| Example usage::
//| Sets the RTC time source used by :func:`time.localtime`.
//| The default is :class:`rtc.RTC`, but it's useful to use this to override the
//| time source for testing purposes. For example::
//|
//| import rtc
//| import time

Loading…
Cancel
Save