aboutsummaryrefslogtreecommitdiff
path: root/circuitpython/shared-bindings/supervisor/Runtime.c
diff options
context:
space:
mode:
Diffstat (limited to 'circuitpython/shared-bindings/supervisor/Runtime.c')
-rw-r--r--circuitpython/shared-bindings/supervisor/Runtime.c131
1 files changed, 131 insertions, 0 deletions
diff --git a/circuitpython/shared-bindings/supervisor/Runtime.c b/circuitpython/shared-bindings/supervisor/Runtime.c
new file mode 100644
index 0000000..55217ec
--- /dev/null
+++ b/circuitpython/shared-bindings/supervisor/Runtime.c
@@ -0,0 +1,131 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Michael Schroeder
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include <stdbool.h>
+#include "py/obj.h"
+#include "py/enum.h"
+#include "py/runtime.h"
+#include "py/objproperty.h"
+
+#include "shared-bindings/supervisor/RunReason.h"
+#include "shared-bindings/supervisor/Runtime.h"
+
+#if (CIRCUITPY_USB)
+#include "tusb.h"
+#endif
+
+STATIC supervisor_run_reason_t _run_reason;
+
+// TODO: add REPL to description once it is operational
+
+//| class Runtime:
+//| """Current status of runtime objects.
+//|
+//| Usage::
+//|
+//| import supervisor
+//| if supervisor.runtime.serial_connected:
+//| print("Hello World!")"""
+//|
+
+//| def __init__(self) -> None:
+//| """You cannot create an instance of `supervisor.Runtime`.
+//| Use `supervisor.runtime` to access the sole instance available."""
+//| ...
+//|
+
+//| usb_connected: bool
+//| """Returns the USB enumeration status (read-only)."""
+//|
+STATIC mp_obj_t supervisor_runtime_get_usb_connected(mp_obj_t self) {
+ #if CIRCUITPY_USB
+ return mp_obj_new_bool(tud_ready());
+ #else
+ return mp_const_false;
+ #endif
+}
+MP_DEFINE_CONST_FUN_OBJ_1(supervisor_runtime_get_usb_connected_obj, supervisor_runtime_get_usb_connected);
+
+MP_PROPERTY_GETTER(supervisor_runtime_usb_connected_obj,
+ (mp_obj_t)&supervisor_runtime_get_usb_connected_obj);
+
+//| serial_connected: bool
+//| """Returns the USB serial communication status (read-only)."""
+//|
+STATIC mp_obj_t supervisor_runtime_get_serial_connected(mp_obj_t self) {
+ return mp_obj_new_bool(common_hal_supervisor_runtime_get_serial_connected());
+}
+MP_DEFINE_CONST_FUN_OBJ_1(supervisor_runtime_get_serial_connected_obj, supervisor_runtime_get_serial_connected);
+
+MP_PROPERTY_GETTER(supervisor_runtime_serial_connected_obj,
+ (mp_obj_t)&supervisor_runtime_get_serial_connected_obj);
+
+//| serial_bytes_available: int
+//| """Returns the whether any bytes are available to read
+//| on the USB serial input. Allows for polling to see whether
+//| to call the built-in input() or wait. (read-only)"""
+//|
+STATIC mp_obj_t supervisor_runtime_get_serial_bytes_available(mp_obj_t self) {
+ return mp_obj_new_bool(common_hal_supervisor_runtime_get_serial_bytes_available());
+}
+MP_DEFINE_CONST_FUN_OBJ_1(supervisor_runtime_get_serial_bytes_available_obj, supervisor_runtime_get_serial_bytes_available);
+
+MP_PROPERTY_GETTER(supervisor_runtime_serial_bytes_available_obj,
+ (mp_obj_t)&supervisor_runtime_get_serial_bytes_available_obj);
+
+supervisor_run_reason_t supervisor_get_run_reason(void) {
+ return _run_reason;
+}
+
+void supervisor_set_run_reason(supervisor_run_reason_t run_reason) {
+ _run_reason = run_reason;
+}
+
+//| run_reason: RunReason
+//| """Returns why CircuitPython started running this particular time."""
+//|
+STATIC mp_obj_t supervisor_runtime_get_run_reason(mp_obj_t self) {
+ return cp_enum_find(&supervisor_run_reason_type, _run_reason);
+}
+MP_DEFINE_CONST_FUN_OBJ_1(supervisor_runtime_get_run_reason_obj, supervisor_runtime_get_run_reason);
+
+MP_PROPERTY_GETTER(supervisor_runtime_run_reason_obj,
+ (mp_obj_t)&supervisor_runtime_get_run_reason_obj);
+
+STATIC const mp_rom_map_elem_t supervisor_runtime_locals_dict_table[] = {
+ { MP_ROM_QSTR(MP_QSTR_usb_connected), MP_ROM_PTR(&supervisor_runtime_usb_connected_obj) },
+ { MP_ROM_QSTR(MP_QSTR_serial_connected), MP_ROM_PTR(&supervisor_runtime_serial_connected_obj) },
+ { MP_ROM_QSTR(MP_QSTR_serial_bytes_available), MP_ROM_PTR(&supervisor_runtime_serial_bytes_available_obj) },
+ { MP_ROM_QSTR(MP_QSTR_run_reason), MP_ROM_PTR(&supervisor_runtime_run_reason_obj) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(supervisor_runtime_locals_dict, supervisor_runtime_locals_dict_table);
+
+const mp_obj_type_t supervisor_runtime_type = {
+ .base = { &mp_type_type },
+ .name = MP_QSTR_Runtime,
+ .locals_dict = (mp_obj_dict_t *)&supervisor_runtime_locals_dict,
+};