changed alarm.time API

Author: dhalbert

locale/circuitpython.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-11-21 12:36-0500\n"
+"POT-Creation-Date: 2020-11-25 15:08-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -17,13 +17,6 @@ msgstr ""
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: main.c
-msgid ""
-"\n"
-"\n"
-"------ soft reboot ------\n"
-msgstr ""
-
 #: main.c
 msgid ""
 "\n"
@@ -849,6 +842,10 @@ msgstr ""
 msgid "Expected an Address"
 msgstr ""
 
+#: shared-bindings/alarm/__init__.c
+msgid "Expected an alarm"
+msgstr ""
+
 #: shared-module/_pixelbuf/PixelBuf.c
 #, c-format
 msgid "Expected tuple of length %d, got %d"
@@ -1440,6 +1437,10 @@ msgid ""
 "%d bpp given"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm/__init__.c
+msgid "Only one alarm.time alarm can be set."
+msgstr ""
+
 #: shared-module/displayio/ColorConverter.c
 msgid "Only one color can be transparent at a time"
 msgstr ""
@@ -1497,6 +1498,10 @@ msgstr ""
 msgid "Pin number already reserved by EXTI"
 msgstr ""
 
+#: ports/esp32s2/common-hal/alarm/__init__.c
+msgid "PinAlarm deep sleep not yet implemented"
+msgstr ""
+
 #: shared-bindings/rgbmatrix/RGBMatrix.c
 #, c-format
 msgid ""
@@ -2449,10 +2454,6 @@ msgstr ""
 msgid "division by zero"
 msgstr ""
 
-#: ports/esp32s2/common-hal/alarm/time/DurationAlarm.c
-msgid "duration out of range"
-msgstr ""
-
 #: py/objdeque.c
 msgid "empty"
 msgstr ""
@@ -3354,6 +3355,10 @@ msgstr ""
 msgid "small int overflow"
 msgstr ""
 
+#: main.c
+msgid "soft reboot\n"
+msgstr ""
+
 #: extmod/ulab/code/numerical/numerical.c
 msgid "sort argument must be an ndarray"
 msgstr ""

main.c

@@ -321,7 +321,9 @@ STATIC bool run_code_py(safe_mode_t safe_mode) {
     ESP_LOGI("main", "common_hal_alarm_enable_deep_sleep_alarms()");
     #if CIRCUITPY_ALARM
     // Enable pin or time alarms before sleeping.
-    common_hal_alarm_enable_deep_sleep_alarms();
+    // If immediate_wake is true, then there's alarm that would trigger immediately,
+    // so don't sleep.
+    bool immediate_wake = !common_hal_alarm_enable_deep_sleep_alarms();
     #endif
 
 
@@ -332,6 +334,7 @@ STATIC bool run_code_py(safe_mode_t safe_mode) {
         // It's ok to deep sleep if we're not connected to a host, but we need to make sure
         // we're giving enough time for USB enumeration to happen.
         bool deep_sleep_allowed =
+            !immediate_wake &&
             (ok || supervisor_workflow_get_allow_deep_sleep_on_error()) &&
             (!supervisor_workflow_active() || supervisor_workflow_get_allow_deep_sleep_when_connected()) &&
             (supervisor_ticks_ms64() > CIRCUITPY_USB_ENUMERATION_DELAY * 1024);
@@ -576,7 +579,7 @@ int __attribute__((used)) main(void) {
         }
         if (exit_code == PYEXEC_FORCED_EXIT) {
             if (!first_run) {
-                serial_write_compressed(translate("\n\n------ soft reboot ------\n"));
+                serial_write_compressed(translate("soft reboot\n"));
             }
             first_run = false;
             skip_repl = run_code_py(safe_mode);

ports/esp32s2/common-hal/alarm/__init__.c

@@ -25,13 +25,15 @@
  * THE SOFTWARE.
  */
 
+#include "py/obj.h"
 #include "py/objtuple.h"
 #include "py/runtime.h"
 
 #include "shared-bindings/alarm/__init__.h"
 #include "shared-bindings/alarm/pin/PinAlarm.h"
-#include "shared-bindings/alarm/time/DurationAlarm.h"
+#include "shared-bindings/alarm/time/MonotonicTimeAlarm.h"
 #include "shared-bindings/microcontroller/__init__.h"
+#include "shared-bindings/time/__init__.h"
 
 #include "esp_sleep.h"
 
@@ -49,8 +51,8 @@ mp_obj_t common_hal_alarm_get_wake_alarm(void) {
     switch (esp_sleep_get_wakeup_cause()) {
         case ESP_SLEEP_WAKEUP_TIMER: {
             // Wake up from timer.
-            alarm_time_duration_alarm_obj_t *timer = m_new_obj(alarm_time_duration_alarm_obj_t);
-            timer->base.type = &alarm_time_duration_alarm_type;
+            alarm_time_monotonic_time_alarm_obj_t *timer = m_new_obj(alarm_time_monotonic_time_alarm_obj_t);
+            timer->base.type = &alarm_time_monotonic_time_alarm_type;
             return timer;
         }
 
@@ -84,7 +86,7 @@ void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *ala
         if (MP_OBJ_IS_TYPE(alarms[i], &alarm_pin_pin_alarm_type)) {
             mp_raise_NotImplementedError(translate("PinAlarm deep sleep not yet implemented"));
         }
-        if (MP_OBJ_IS_TYPE(alarms[i], &alarm_time_duration_alarm_type)) {
+        else if (MP_OBJ_IS_TYPE(alarms[i], &alarm_time_monotonic_time_alarm_type)) {
             if (time_alarm_set) {
                 mp_raise_ValueError(translate("Only one alarm.time alarm can be set."));
             }
@@ -95,14 +97,25 @@ void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *ala
     _deep_sleep_alarms = mp_obj_new_tuple(n_alarms, alarms);
 }
 
-void common_hal_alarm_enable_deep_sleep_alarms(void) {
+// Return false if we should wake up immediately because a time alarm is in the past
+// or otherwise already triggered.
+bool common_hal_alarm_enable_deep_sleep_alarms(void) {
     for (size_t i = 0; i < _deep_sleep_alarms->len; i++) {
         mp_obj_t alarm = _deep_sleep_alarms->items[i];
-        if (MP_OBJ_IS_TYPE(alarm, &alarm_time_duration_alarm_type)) {
-            alarm_time_duration_alarm_obj_t *duration_alarm = MP_OBJ_TO_PTR(alarm);
-            esp_sleep_enable_timer_wakeup(
-                (uint64_t) (duration_alarm->duration * 1000000.0f));
+        if (MP_OBJ_IS_TYPE(alarm, &alarm_pin_pin_alarm_type)) {
+            // TODO: handle pin alarms
+            mp_raise_NotImplementedError(translate("PinAlarm deep sleep not yet implemented"));
+        }
+        else if (MP_OBJ_IS_TYPE(alarm, &alarm_time_monotonic_time_alarm_type)) {
+            alarm_time_monotonic_time_alarm_obj_t *monotonic_time_alarm = MP_OBJ_TO_PTR(alarm);
+            mp_float_t now = uint64_to_float(common_hal_time_monotonic());
+            // Compute a relative time in the future from now.
+            mp_float_t duration_secs = now - monotonic_time_alarm->monotonic_time;
+            if (duration_secs <= 0.0f) {
+                return false;
+            }
+            esp_sleep_enable_timer_wakeup((uint64_t) (duration_secs * 1000000));
         }
-        // TODO: handle pin alarms
     }
+    return true;
 }

ports/esp32s2/common-hal/alarm/pin/PinAlarm.c

@@ -3,7 +3,6 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 @microDev1 (GitHub)
  * Copyright (c) 2020 Dan Halbert for Adafruit Industries
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -38,7 +37,7 @@ void common_hal_alarm_pin_pin_alarm_construct(alarm_pin_pin_alarm_obj_t *self, c
     self->pull = pull;
 }
 
-const mp_obj_tuple_t *common_hal_alarm_pin_pin_alarm_get_pins(alarm_pin_pin_alarm_obj_t *self) {
+mp_obj_tuple_t *common_hal_alarm_pin_pin_alarm_get_pins(alarm_pin_pin_alarm_obj_t *self) {
     return self->pins;
 }
 

ports/esp32s2/common-hal/alarm/time/DurationAlarm.c renamed to ports/esp32s2/common-hal/alarm/time/MonotonicTimeAlarm.c

@@ -3,7 +3,6 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 @microDev1 (GitHub)
  * Copyright (c) 2020 Dan Halbert for Adafruit Industries
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -29,23 +28,12 @@
 
 #include "py/runtime.h"
 
-#include "shared-bindings/alarm/time/DurationAlarm.h"
+#include "shared-bindings/alarm/time/MonotonicTimeAlarm.h"
 
-void common_hal_alarm_time_duration_alarm_construct(alarm_time_duration_alarm_obj_t *self, mp_float_t duration) {
-    self->duration = duration;
+void common_hal_alarm_time_monotonic_time_alarm_construct(alarm_time_monotonic_time_alarm_obj_t *self, mp_float_t monotonic_time) {
+    self->monotonic_time = monotonic_time;
 }
 
-mp_float_t common_hal_alarm_time_duration_alarm_get_duration(alarm_time_duration_alarm_obj_t *self) {
-    return self->duration;
-}
-
-void common_hal_alarm_time_duration_alarm_enable(alarm_time_duration_alarm_obj_t *self) {
-    if (esp_sleep_enable_timer_wakeup((uint64_t) (self->duration * 1000000)) == ESP_ERR_INVALID_ARG) {
-        mp_raise_ValueError(translate("duration out of range"));
-    }
-}
-
-void common_hal_alarm_time_duration_alarm_disable (alarm_time_duration_alarm_obj_t *self) {
-    (void) self;
-    esp_sleep_disable_wakeup_source(ESP_SLEEP_WAKEUP_TIMER);
+mp_float_t common_hal_alarm_time_monotonic_time_alarm_get_monotonic_time(alarm_time_monotonic_time_alarm_obj_t *self) {
+    return self->monotonic_time;
 }

ports/esp32s2/common-hal/alarm/time/DurationAlarm.h renamed to ports/esp32s2/common-hal/alarm/time/MonotonicTimeAlarm.h

@@ -3,7 +3,6 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2020 @microDev1 (GitHub)
  * Copyright (c) 2020 Dan Halbert for Adafruit Industries
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -30,5 +29,5 @@
 
 typedef struct {
     mp_obj_base_t base;
-    mp_float_t duration;  // seconds
-} alarm_time_duration_alarm_obj_t;
+    mp_float_t monotonic_time;      // values compatible with time.monotonic_time()
+} alarm_time_monotonic_time_alarm_obj_t;

py/circuitpy_defns.mk

@@ -303,7 +303,7 @@ SRC_COMMON_HAL_ALL = \
 	_pew/__init__.c \
 	alarm/__init__.c \
 	alarm/pin/PinAlarm.c \
-	alarm/time/DurationAlarm.c \
+	alarm/time/MonotonicTimeAlarm.c \
 	analogio/AnalogIn.c \
 	analogio/AnalogOut.c \
 	analogio/__init__.c \

py/obj.h

@@ -679,6 +679,7 @@ mp_obj_t mp_obj_new_bytearray_by_ref(size_t n, void *items);
 #if MICROPY_PY_BUILTINS_FLOAT
 mp_obj_t mp_obj_new_int_from_float(mp_float_t val);
 mp_obj_t mp_obj_new_complex(mp_float_t real, mp_float_t imag);
+extern mp_float_t uint64_to_float(uint64_t ui64);
 #endif
 mp_obj_t mp_obj_new_exception(const mp_obj_type_t *exc_type);
 mp_obj_t mp_obj_new_exception_arg1(const mp_obj_type_t *exc_type, mp_obj_t arg);

py/objfloat.c

@@ -333,6 +333,13 @@ mp_obj_t mp_obj_float_binary_op(mp_binary_op_t op, mp_float_t lhs_val, mp_obj_t
     return mp_obj_new_float(lhs_val);
 }
 
+// Convert a uint64_t to a 32-bit float without invoking the double-precision math routines,
+// which are large.
+mp_float_t uint64_to_float(uint64_t ui64) {
+    // 4294967296 = 2^32
+    return (mp_float_t) ((uint32_t) (ui64 >> 32) * 4294967296.0f + (uint32_t) (ui64 & 0xffffffff));
+}
+
 #pragma GCC diagnostic pop
 
 #endif // MICROPY_PY_BUILTINS_FLOAT

shared-bindings/alarm/__init__.c

@@ -29,7 +29,7 @@
 
 #include "shared-bindings/alarm/__init__.h"
 #include "shared-bindings/alarm/pin/PinAlarm.h"
-#include "shared-bindings/alarm/time/DurationAlarm.h"
+#include "shared-bindings/alarm/time/MonotonicTimeAlarm.h"
 
 //| """Power-saving light and deep sleep. Alarms can be set to wake up from sleep.
 //|
@@ -60,7 +60,7 @@
 void validate_objs_are_alarms(size_t n_args, const mp_obj_t *objs) {
     for (size_t i = 0; i < n_args; i++) {
         if (MP_OBJ_IS_TYPE(objs[i], &alarm_pin_pin_alarm_type) ||
-            MP_OBJ_IS_TYPE(objs[i], &alarm_time_duration_alarm_type)) {
+            MP_OBJ_IS_TYPE(objs[i], &alarm_time_monotonic_time_alarm_type)) {
             continue;
         }
         mp_raise_TypeError_varg(translate("Expected an alarm"));
@@ -86,7 +86,9 @@ MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(alarm_sleep_until_alarms_obj, 1, MP_OBJ_FUN_
 //|     When awakened, the microcontroller will restart and run ``boot.py`` and ``code.py``
 //|     from the beginning.
 //|
-//|     The alarm that caused the wake-up is available as `alarm.wake_alarm`.
+//|     An alarm equivalent to the one that caused the wake-up is available as `alarm.wake_alarm`.
+//|     Its type and/or attributes may not correspond exactly to the original alarm.
+//|     For time-base alarms, currently, an `alarm.time.MonotonicTimeAlarm()` is created.
 //|
 //|     If you call this routine more than once, only the last set of alarms given will be used.
 //|     """
@@ -121,7 +123,7 @@ STATIC const mp_obj_module_t alarm_pin_module = {
 STATIC const mp_map_elem_t alarm_time_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_time) },
 
-    { MP_ROM_QSTR(MP_QSTR_DurationAlarm), MP_OBJ_FROM_PTR(&alarm_time_duration_alarm_type) },
+    { MP_ROM_QSTR(MP_QSTR_MonotonicTimeAlarm), MP_OBJ_FROM_PTR(&alarm_time_monotonic_time_alarm_type) },
 };
 
 STATIC MP_DEFINE_CONST_DICT(alarm_time_globals, alarm_time_globals_table);