QUERY · ISSUE

Class RTC on ESP32 documentation bug

openby sengpwopened 2019-11-26updated 2025-10-17

docsport-esp32

RTC.datetime
Testing showed that the 8-tuple has the following format:
(year, month, dayofmonth, dayofweek (0..6, mon=0), hours, minutes, seconds, subseconds)
Not sure about the content/validity of "subseconds", cause this can be set to any value, even bigger 255.
Tested on firmware versions:
esp32spiram-idf3-20190529-v1.11.bin
esp32spiram-idf3-20191126-v1.11-607-g01e5802ee.bin

But documentation says:
Datetime is a tuple of the form:
(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])
This is definitely wrong, documentation of pyb.RTC also does not match, cause there weekday is in range 1-7. Can not test this cause only ESP32 available.

CANDIDATE · PULL REQUEST

docs: Make the machine.RTC reflect reality on esp8266

closedby deshipuopened 2016-08-20updated 2019-08-31

The documentation for machine.RTC is completely worng, not only
specifying wrong method names, but also wrong order of values in
the time tuple. Updated based on the source code.

Assessment

S Sonnet · high

Both items address incorrect machine.RTC documentation in docs/library/machine.RTC.rst, specifically the wrong time tuple format. However, the PR (#2334) targets esp8266 specifically ("reflect reality on esp8266"), while the query issue (#5361) reports the bug on ESP32. The PR was filed before the issue (lower number), meaning it didn't resolve the ESP32 problem — the issue was filed later precisely because the ESP32 docs were still wrong. The underlying documentation structure is shared, so the PR is clearly relevant context, but it does not fix the ESP32-specific tuple format (dayofweek range 0-6, subseconds field) that the issue reports.

Suggested action

Leave issue #5361 open. The esp8266 fix in PR #2334 provides a template for how to correct the ESP32 RTC docs. A follow-up PR should update docs/library/machine.RTC.rst (and likely docs/esp32/quickref.rst) to document the ESP32 tuple format: (year, month, dayofmonth, dayofweek 0-6, hours, minutes, seconds, subseconds). Reference PR #2334 as prior art.

Class RTC on ESP32 documentation bug

docs: Make the machine.RTC reflect reality on esp8266

Keyboard