diff options
Diffstat (limited to 'docs/library/machine.RTC.rst')
| -rw-r--r-- | docs/library/machine.RTC.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst index ad0b0759e..a45718903 100644 --- a/docs/library/machine.RTC.rst +++ b/docs/library/machine.RTC.rst @@ -62,10 +62,13 @@ Methods Get the number of milliseconds left before the alarm expires. -.. method:: RTC.cancel(alarm_id=0) +.. method:: RTC.alarm_cancel(alarm_id=0) Cancel a running alarm. + The mimxrt port also exposes this function as ``RTC.cancel(alarm_id=0)``, but this is + scheduled to be removed in MicroPython 2.0. + .. method:: RTC.irq(*, trigger, handler=None, wake=machine.IDLE) Create an irq object triggered by a real time clock alarm. |