add circuitpython code

4 files changed, 308 insertions, 0 deletions

diff --git a/circuitpython/shared-bindings/rtc/RTC.c b/circuitpython/shared-bindings/rtc/RTC.c
new file mode 100644
index 0000000..b07f90b
--- /dev/null
+++ b/circuitpython/shared-bindings/rtc/RTC.c
@@ -0,0 +1,133 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Noralf Trønnes
+ * SPDX-FileCopyrightText: Copyright (c) 2013, 2014 Damien P. George
+ *
+ * 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 <string.h>
+
+#include "py/obj.h"
+#include "py/objproperty.h"
+#include "py/runtime.h"
+#include "shared/timeutils/timeutils.h"
+#include "shared-bindings/rtc/__init__.h"
+#include "shared-bindings/rtc/RTC.h"
+#include "shared-bindings/time/__init__.h"
+#include "supervisor/shared/translate.h"
+
+const rtc_rtc_obj_t rtc_rtc_obj = {{&rtc_rtc_type}};
+
+//| class RTC:
+//|     """Real Time Clock"""
+//|
+//|     def __init__(self) -> None:
+//|         """This class represents the onboard Real Time Clock. It is a singleton and will always return the same instance."""
+//|         ...
+//|
+STATIC mp_obj_t rtc_rtc_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
+    // No arguments
+    mp_arg_check_num(n_args, n_kw, 0, 0, false);
+
+    // return constant object
+    return (mp_obj_t)&rtc_rtc_obj;
+}
+
+//|     datetime: time.struct_time
+//|     """The current date and time of the RTC as a `time.struct_time`.
+//|
+//|     This must be set to the current date and time whenever the board loses power::
+//|
+//|       import rtc
+//|       import time
+//|
+//|       r = rtc.RTC()
+//|       r.datetime = time.struct_time((2019, 5, 29, 15, 14, 15, 0, -1, -1))
+//|
+//|
+//|     Once set, the RTC will automatically update this value as time passes. You can read this
+//|     property to get a snapshot of the current time::
+//|
+//|       current_time = r.datetime
+//|       print(current_time)
+//|       # struct_time(tm_year=2019, tm_month=5, ...)"""
+//|
+STATIC mp_obj_t rtc_rtc_obj_get_datetime(mp_obj_t self_in) {
+    timeutils_struct_time_t tm;
+    common_hal_rtc_get_time(&tm);
+    return struct_time_from_tm(&tm);
+}
+MP_DEFINE_CONST_FUN_OBJ_1(rtc_rtc_get_datetime_obj, rtc_rtc_obj_get_datetime);
+
+STATIC mp_obj_t rtc_rtc_obj_set_datetime(mp_obj_t self_in, mp_obj_t datetime) {
+    timeutils_struct_time_t tm;
+    struct_time_to_tm(datetime, &tm);
+    common_hal_rtc_set_time(&tm);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(rtc_rtc_set_datetime_obj, rtc_rtc_obj_set_datetime);
+
+MP_PROPERTY_GETSET(rtc_rtc_datetime_obj,
+    (mp_obj_t)&rtc_rtc_get_datetime_obj,
+    (mp_obj_t)&rtc_rtc_set_datetime_obj);
+
+//|     calibration: int
+//|     """The RTC calibration value as an `int`.
+//|
+//|     A positive value speeds up the clock and a negative value slows it down.
+//|     Range and value is hardware specific, but one step is often approximately 1 ppm::
+//|
+//|       import rtc
+//|       import time
+//|
+//|       r = rtc.RTC()
+//|       r.calibration = 1"""
+//|
+STATIC mp_obj_t rtc_rtc_obj_get_calibration(mp_obj_t self_in) {
+    int calibration = common_hal_rtc_get_calibration();
+    return mp_obj_new_int(calibration);
+}
+MP_DEFINE_CONST_FUN_OBJ_1(rtc_rtc_get_calibration_obj, rtc_rtc_obj_get_calibration);
+
+STATIC mp_obj_t rtc_rtc_obj_set_calibration(mp_obj_t self_in, mp_obj_t calibration) {
+    common_hal_rtc_set_calibration(mp_obj_get_int(calibration));
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(rtc_rtc_set_calibration_obj, rtc_rtc_obj_set_calibration);
+
+MP_PROPERTY_GETSET(rtc_rtc_calibration_obj,
+    (mp_obj_t)&rtc_rtc_get_calibration_obj,
+    (mp_obj_t)&rtc_rtc_set_calibration_obj);
+
+STATIC const mp_rom_map_elem_t rtc_rtc_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_datetime), MP_ROM_PTR(&rtc_rtc_datetime_obj) },
+    { MP_ROM_QSTR(MP_QSTR_calibration), MP_ROM_PTR(&rtc_rtc_calibration_obj) },
+};
+STATIC MP_DEFINE_CONST_DICT(rtc_rtc_locals_dict, rtc_rtc_locals_dict_table);
+
+const mp_obj_type_t rtc_rtc_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_RTC,
+    .make_new = rtc_rtc_make_new,
+    .locals_dict = (mp_obj_dict_t *)&rtc_rtc_locals_dict,
+};
diff --git a/circuitpython/shared-bindings/rtc/RTC.h b/circuitpython/shared-bindings/rtc/RTC.h
new file mode 100644
index 0000000..ede824f
--- /dev/null
+++ b/circuitpython/shared-bindings/rtc/RTC.h
@@ -0,0 +1,50 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Noralf Trønnes
+ *
+ * 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.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_RTC_RTC_H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_RTC_RTC_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "py/obj.h"
+#include "shared/timeutils/timeutils.h"
+
+extern void common_hal_rtc_get_time(timeutils_struct_time_t *tm);
+extern void common_hal_rtc_set_time(timeutils_struct_time_t *tm);
+
+extern int common_hal_rtc_get_calibration(void);
+extern void common_hal_rtc_set_calibration(int calibration);
+
+extern const mp_obj_type_t rtc_rtc_type;
+
+typedef struct _rtc_rtc_obj_t {
+    mp_obj_base_t base;
+} rtc_rtc_obj_t;
+
+extern const rtc_rtc_obj_t rtc_rtc_obj;
+
+#endif  // MICROPY_INCLUDED_SHARED_BINDINGS_RTC_RTC_H
diff --git a/circuitpython/shared-bindings/rtc/__init__.c b/circuitpython/shared-bindings/rtc/__init__.c
new file mode 100644
index 0000000..0220745
--- /dev/null
+++ b/circuitpython/shared-bindings/rtc/__init__.c
@@ -0,0 +1,90 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Noralf Trønnes
+ * SPDX-FileCopyrightText: Copyright (c) 2013, 2014 Damien P. George
+ *
+ * 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 "py/obj.h"
+#include "py/runtime.h"
+#include "shared-bindings/rtc/__init__.h"
+#include "shared-bindings/rtc/RTC.h"
+#include "shared-bindings/time/__init__.h"
+
+//| """Real Time Clock
+//|
+//| The `rtc` module provides support for a Real Time Clock. You can access and manage the
+//| RTC using :class:`rtc.RTC`. It also backs the :func:`time.time` and :func:`time.localtime`
+//| functions using the onboard RTC if present."""
+//|
+
+void rtc_reset(void) {
+    MP_STATE_VM(rtc_time_source) = (mp_obj_t)&rtc_rtc_obj;
+}
+
+mp_obj_t rtc_get_time_source_time(void) {
+    mp_obj_t datetime = mp_load_attr(MP_STATE_VM(rtc_time_source), MP_QSTR_datetime);
+    timeutils_struct_time_t tm;
+    struct_time_to_tm(datetime, &tm);
+    // This sets tm_wday and tm_yday
+    return struct_time_from_tm(&tm);
+}
+
+//| def set_time_source(rtc: RTC) -> None:
+//|     """Sets the RTC time source used by :func:`time.localtime`.
+//|     The default is :class:`rtc.RTC`, but it's useful to use this to override the
+//|     time source for testing purposes. For example::
+//|
+//|       import rtc
+//|       import time
+//|
+//|       class RTC(object):
+//|           @property
+//|           def datetime(self):
+//|               return time.struct_time((2018, 3, 17, 21, 1, 47, 0, 0, 0))
+//|
+//|       r = RTC()
+//|       rtc.set_time_source(r)"""
+//|     ...
+//|
+STATIC mp_obj_t rtc_set_time_source(mp_obj_t time_source) {
+    MP_STATE_VM(rtc_time_source) = time_source;
+
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_1(rtc_set_time_source_obj, rtc_set_time_source);
+
+STATIC const mp_rom_map_elem_t rtc_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_rtc) },
+    { MP_ROM_QSTR(MP_QSTR_set_time_source), MP_ROM_PTR(&rtc_set_time_source_obj) },
+    { MP_ROM_QSTR(MP_QSTR_RTC), MP_ROM_PTR(&rtc_rtc_type) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(rtc_module_globals, rtc_module_globals_table);
+
+const mp_obj_module_t rtc_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&rtc_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_rtc, rtc_module, CIRCUITPY_RTC);
diff --git a/circuitpython/shared-bindings/rtc/__init__.h b/circuitpython/shared-bindings/rtc/__init__.h
new file mode 100644
index 0000000..04f8f8b
--- /dev/null
+++ b/circuitpython/shared-bindings/rtc/__init__.h
@@ -0,0 +1,35 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Noralf Trønnes
+ *
+ * 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.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_RTC___INIT___H
+#define MICROPY_INCLUDED_SHARED_BINDINGS_RTC___INIT___H
+
+#include "py/obj.h"
+
+extern void rtc_reset(void);
+extern mp_obj_t rtc_get_time_source_time(void);
+
+#endif  // MICROPY_INCLUDED_SHARED_BINDINGS_RTC___INIT___H