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 · ISSUE

Update documenation of machine.RTC

closedby nagylzsopened 2018-04-10updated 2019-12-17

port-esp8266

The documentation has incorrect signature. There is no RTC.init method. The RTC.datetime method has a different signature: it has no tzinfo parameter, and the "day of week" parameter follows the day parameter (instead of the hour).

For details see: https://stackoverflow.com/questions/49757733/micropython-on-esp8266-rtc-does-not-have-an-init-method/49758737#49758737

Assessment

S Sonnet · high

Both issues report the same documentation error: machine.RTC.datetime() is documented with the wrong tuple format (listing tzinfo/microsecond instead of the actual (year, month, day, dayofweek, hours, minutes, seconds, subseconds) layout). #3710 targets esp8266 and additionally notes the non-existent RTC.init() method; #5361 targets esp32 and also questions the dayofweek range. The core defect — wrong datetime tuple signature in the docs — is identical. A single documentation fix for machine.RTC would address both. They are not marked DUPLICATE because they are on different ports and #3710 covers an additional issue (RTC.init), so there is a small chance port-specific behaviour justifies separate tracking.

Suggested action

Close #5361 as a duplicate of the older #3710, or merge their content into a single documentation fix. If a PR correcting the machine.RTC.datetime tuple format has since been merged, close both issues against that PR.

Class RTC on ESP32 documentation bug

Update documenation of machine.RTC

Keyboard