From 57de9da35233b4120a00386c52485e68bbc931fb Mon Sep 17 00:00:00 2001 From: Amirreza Hamzavi Date: Sun, 1 Oct 2023 14:30:15 +0330 Subject: [PATCH] docs/library/machine.RTC: Add docs for RTC.memory() method. Co-Authored-By: glenn20 Signed-off-by: Amirreza Hamzavi --- docs/library/machine.RTC.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst index be2be2eee5..fcd78f1c39 100644 --- a/docs/library/machine.RTC.rst +++ b/docs/library/machine.RTC.rst @@ -75,6 +75,21 @@ Methods - ``wake`` specifies the sleep mode from where this interrupt can wake up the system. +.. method:: RTC.memory([data]) + + ``RTC.memory(data)`` will write *data* to the RTC memory, where *data* is any + object which supports the buffer protocol (including `bytes`, `bytearray`, + `memoryview` and `array.array`). ``RTC.memory()`` reads RTC memory and returns + a `bytes` object. + + Data written to RTC user memory is persistent across restarts, including + `machine.soft_reset()` and `machine.deepsleep()`. + + The maximum length of RTC user memory is 2048 bytes by default on esp32, + and 492 bytes on esp8266. + + Availability: esp32, esp8266 ports. + Constants ---------