aboutsummaryrefslogtreecommitdiff
path: root/circuitpython/shared-bindings/qrio
diff options
context:
space:
mode:
Diffstat (limited to 'circuitpython/shared-bindings/qrio')
-rw-r--r--circuitpython/shared-bindings/qrio/PixelPolicy.c56
-rw-r--r--circuitpython/shared-bindings/qrio/PixelPolicy.h39
-rw-r--r--circuitpython/shared-bindings/qrio/QRDecoder.c149
-rw-r--r--circuitpython/shared-bindings/qrio/QRDecoder.h37
-rw-r--r--circuitpython/shared-bindings/qrio/QRInfo.c64
-rw-r--r--circuitpython/shared-bindings/qrio/QRInfo.h31
-rw-r--r--circuitpython/shared-bindings/qrio/__init__.c59
-rw-r--r--circuitpython/shared-bindings/qrio/__init__.h27
8 files changed, 462 insertions, 0 deletions
diff --git a/circuitpython/shared-bindings/qrio/PixelPolicy.c b/circuitpython/shared-bindings/qrio/PixelPolicy.c
new file mode 100644
index 0000000..6887081
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/PixelPolicy.c
@@ -0,0 +1,56 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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 "shared-bindings/qrio/__init__.h"
+#include "shared-bindings/qrio/PixelPolicy.h"
+#include "py/obj.h"
+#include "py/enum.h"
+
+//| class PixelPolicy:
+//| EVERY_BYTE: PixelPolicy
+//| """The input buffer to `QRDecoder.decode` consists of greyscale values in every byte"""
+//|
+//| EVEN_BYTES: PixelPolicy
+//| """The input buffer to `QRDecoder.decode` consists of greyscale values in positions 0, 2, …, and ignored bytes in positions 1, 3, …. This can decode directly from YUV images where the even bytes hold the Y (luminance) data."""
+//|
+//| ODD_BYTES: PixelPolicy
+//| """The input buffer to `QRDecoder.decode` consists of greyscale values in positions 1, 3, …, and ignored bytes in positions 0, 2, …. This can decode directly from YUV images where the odd bytes hold the Y (luminance) data"""
+//|
+
+MAKE_ENUM_VALUE(qrio_pixel_policy_type, qrio_pixel_policy, EVERY_BYTE, QRIO_EVERY_BYTE);
+MAKE_ENUM_VALUE(qrio_pixel_policy_type, qrio_pixel_policy, EVEN_BYTES, QRIO_EVEN_BYTES);
+MAKE_ENUM_VALUE(qrio_pixel_policy_type, qrio_pixel_policy, ODD_BYTES, QRIO_EVEN_BYTES);
+
+MAKE_ENUM_MAP(qrio_pixel_policy) {
+ MAKE_ENUM_MAP_ENTRY(qrio_pixel_policy, EVERY_BYTE),
+ MAKE_ENUM_MAP_ENTRY(qrio_pixel_policy, EVEN_BYTES),
+ MAKE_ENUM_MAP_ENTRY(qrio_pixel_policy, ODD_BYTES),
+};
+STATIC MP_DEFINE_CONST_DICT(qrio_pixel_policy_locals_dict, qrio_pixel_policy_locals_table);
+
+MAKE_PRINTER(qrio, qrio_pixel_policy);
+
+MAKE_ENUM_TYPE(qrio, PixelPolicy, qrio_pixel_policy);
diff --git a/circuitpython/shared-bindings/qrio/PixelPolicy.h b/circuitpython/shared-bindings/qrio/PixelPolicy.h
new file mode 100644
index 0000000..8be5dde
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/PixelPolicy.h
@@ -0,0 +1,39 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler for Adafruit Industries
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include "py/enum.h"
+#include "py/obj.h"
+#include "py/objnamedtuple.h"
+
+extern const mp_obj_type_t qrio_pixel_policy_type;
+
+typedef enum {
+ QRIO_EVERY_BYTE, QRIO_EVEN_BYTES, QRIO_ODD_BYTES
+} qrio_pixel_policy_t;
+
+extern const cp_enum_obj_t qrio_pixel_policy_EVERY_BYTE_obj;
diff --git a/circuitpython/shared-bindings/qrio/QRDecoder.c b/circuitpython/shared-bindings/qrio/QRDecoder.c
new file mode 100644
index 0000000..d2d4785
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/QRDecoder.c
@@ -0,0 +1,149 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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 "shared-bindings/qrio/__init__.h"
+#include "shared-bindings/qrio/QRDecoder.h"
+#include "shared-module/qrio/QRDecoder.h"
+
+#include "py/obj.h"
+#include "py/objproperty.h"
+#include "py/enum.h"
+
+//| class QRDecoder:
+//|
+//| def __init__(self, width: int, height: int) -> None:
+//| """Construct a QRDecoder object
+//|
+//| :param int width: The pixel width of the image to decode
+//| :param int height: The pixel height of the image to decode
+//| """
+//| ...
+
+STATIC mp_obj_t qrio_qrdecoder_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args_in) {
+ enum { ARG_width, ARG_height };
+ static const mp_arg_t allowed_args[] = {
+ { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 0} },
+ { MP_QSTR_height, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 0} },
+ };
+ mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+ mp_arg_parse_all_kw_array(n_args, n_kw, args_in, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+ qrio_qrdecoder_obj_t *self = m_new_obj(qrio_qrdecoder_obj_t);
+ self->base.type = &qrio_qrdecoder_type_obj;
+ shared_module_qrio_qrdecoder_construct(self, args[ARG_width].u_int, args[ARG_height].u_int);
+
+ return self;
+}
+
+//| def decode(self, buffer: ReadableBuffer, pixel_policy: PixelPolicy = PixelPolicy.EVERY_BYTE) -> List[QRInfo]:
+//| """Decode zero or more QR codes from the given image. The size of the buffer must be at least ``length``×``width`` bytes for `EVERY_BYTE`, and 2×``length``×``width`` bytes for `EVEN_BYTES` or `ODD_BYTES`."""
+//|
+STATIC mp_obj_t qrio_qrdecoder_decode(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+ qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
+
+ enum { ARG_buffer, ARG_pixel_policy };
+ static const mp_arg_t allowed_args[] = {
+ { MP_QSTR_buffer, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_int = 0} },
+ { MP_QSTR_pixel_policy, MP_ARG_OBJ, {.u_obj = MP_ROM_PTR((mp_obj_t *)&qrio_pixel_policy_EVERY_BYTE_obj)} },
+ };
+ mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+ mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+ mp_buffer_info_t bufinfo;
+ mp_get_buffer_raise(args[ARG_buffer].u_obj, &bufinfo, MP_BUFFER_READ);
+
+ int width = shared_module_qrio_qrdecoder_get_width(self);
+ int height = shared_module_qrio_qrdecoder_get_height(self);
+
+ // verify that the buffer is big enough
+ int sz = width * height;
+ qrio_pixel_policy_t policy = cp_enum_value(&qrio_pixel_policy_type, args[ARG_pixel_policy].u_obj);
+ if (policy != QRIO_EVERY_BYTE) {
+ sz *= 2;
+ }
+ mp_get_index(mp_obj_get_type(args[ARG_buffer].u_obj), bufinfo.len, MP_OBJ_NEW_SMALL_INT(sz - 1), false);
+
+ return shared_module_qrio_qrdecoder_decode(self, &bufinfo, policy);
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(qrio_qrdecoder_decode_obj, 1, qrio_qrdecoder_decode);
+
+//| width: int
+//| """The width of image the decoder expects"""
+//|
+STATIC mp_obj_t qrio_qrdecoder_get_width(mp_obj_t self_in) {
+ qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ return mp_obj_new_int(shared_module_qrio_qrdecoder_get_width(self));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(qrio_qrdecoder_get_width_obj, qrio_qrdecoder_get_width);
+
+STATIC mp_obj_t qrio_qrdecoder_set_width(mp_obj_t self_in, mp_obj_t width_in) {
+ qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ int width = mp_obj_get_int(width_in);
+ shared_module_qrio_qrdecoder_set_width(self, width);
+ return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(qrio_qrdecoder_set_width_obj, qrio_qrdecoder_set_width);
+
+MP_PROPERTY_GETSET(qrio_qrdecoder_width_obj,
+ (mp_obj_t)&qrio_qrdecoder_get_width_obj,
+ (mp_obj_t)&qrio_qrdecoder_set_width_obj);
+
+//| height: int
+//| """The height of image the decoder expects"""
+//|
+STATIC mp_obj_t qrio_qrdecoder_get_height(mp_obj_t self_in) {
+ qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ return mp_obj_new_int(shared_module_qrio_qrdecoder_get_height(self));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(qrio_qrdecoder_get_height_obj, qrio_qrdecoder_get_height);
+
+STATIC mp_obj_t qrio_qrdecoder_set_height(mp_obj_t self_in, mp_obj_t height_in) {
+ qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+ int height = mp_obj_get_int(height_in);
+ shared_module_qrio_qrdecoder_set_height(self, height);
+ return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(qrio_qrdecoder_set_height_obj, qrio_qrdecoder_set_height);
+
+MP_PROPERTY_GETSET(qrio_qrdecoder_height_obj,
+ (mp_obj_t)&qrio_qrdecoder_get_height_obj,
+ (mp_obj_t)&qrio_qrdecoder_set_height_obj);
+
+STATIC const mp_rom_map_elem_t qrio_qrdecoder_locals_table[] = {
+ { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_QRDecoder) },
+ { MP_ROM_QSTR(MP_QSTR_width), MP_ROM_PTR(&qrio_qrdecoder_width_obj) },
+ { MP_ROM_QSTR(MP_QSTR_height), MP_ROM_PTR(&qrio_qrdecoder_height_obj) },
+ { MP_ROM_QSTR(MP_QSTR_decode), MP_ROM_PTR(&qrio_qrdecoder_decode_obj) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(qrio_qrdecoder_locals, qrio_qrdecoder_locals_table);
+
+const mp_obj_type_t qrio_qrdecoder_type_obj = {
+ { &mp_type_type },
+ .name = MP_QSTR_QRDecoder,
+ .make_new = qrio_qrdecoder_make_new,
+ .locals_dict = (mp_obj_dict_t *)&qrio_qrdecoder_locals,
+};
diff --git a/circuitpython/shared-bindings/qrio/QRDecoder.h b/circuitpython/shared-bindings/qrio/QRDecoder.h
new file mode 100644
index 0000000..0b01aeb
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/QRDecoder.h
@@ -0,0 +1,37 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler for Adafruit Industries
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include "py/obj.h"
+
+typedef struct qrio_qrdecoder_obj qrio_qrdecoder_obj_t;
+
+extern const mp_obj_type_t qrio_qrdecoder_type_obj;
+
+void common_hal_qrio_qrdecoder_construct(qrio_qrdecoder_obj_t *self);
+
+mp_obj_t common_hal_qrio_qrdecoder_decode(qrio_qrdecoder_obj_t *self, int width, int height, mp_buffer_info_t *buf);
diff --git a/circuitpython/shared-bindings/qrio/QRInfo.c b/circuitpython/shared-bindings/qrio/QRInfo.c
new file mode 100644
index 0000000..8eb0387
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/QRInfo.c
@@ -0,0 +1,64 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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 "shared-bindings/qrio/__init__.h"
+#include "shared-bindings/qrio/QRInfo.h"
+#include "py/obj.h"
+#include "py/enum.h"
+
+//| class QRInfo:
+//| """Information about a decoded QR code"""
+//|
+//| payload: bytes
+//| """The content of the QR code"""
+//|
+//| data_type: Union[str, int]
+//| """The encoding of the payload as a string (if a standard encoding) or int (if not standard)"""
+
+const mp_obj_namedtuple_type_t qrio_qrinfo_type_obj = {
+ .base = {
+ .base = {
+ .type = &mp_type_type
+ },
+ .flags = MP_TYPE_FLAG_EXTENDED,
+ .name = MP_QSTR_QRInfo,
+ .print = namedtuple_print,
+ .parent = &mp_type_tuple,
+ .make_new = namedtuple_make_new,
+ .attr = namedtuple_attr,
+ MP_TYPE_EXTENDED_FIELDS(
+ .unary_op = mp_obj_tuple_unary_op,
+ .binary_op = mp_obj_tuple_binary_op,
+ .subscr = mp_obj_tuple_subscr,
+ .getiter = mp_obj_tuple_getiter,
+ ),
+ },
+ .n_fields = 2,
+ .fields = {
+ MP_QSTR_payload,
+ MP_QSTR_data_type,
+ },
+};
diff --git a/circuitpython/shared-bindings/qrio/QRInfo.h b/circuitpython/shared-bindings/qrio/QRInfo.h
new file mode 100644
index 0000000..956cb42
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/QRInfo.h
@@ -0,0 +1,31 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler for Adafruit Industries
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include "py/objnamedtuple.h"
+
+extern const mp_obj_namedtuple_type_t qrio_qrinfo_type_obj;
diff --git a/circuitpython/shared-bindings/qrio/__init__.c b/circuitpython/shared-bindings/qrio/__init__.c
new file mode 100644
index 0000000..04c86fd
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/__init__.c
@@ -0,0 +1,59 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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 "shared-bindings/qrio/__init__.h"
+#include "shared-bindings/qrio/QRDecoder.h"
+#include "shared-bindings/qrio/QRInfo.h"
+#include "shared-bindings/qrio/PixelPolicy.h"
+#include "py/obj.h"
+#include "py/enum.h"
+
+//| """Low-level QR code decoding
+//|
+//| Provides the `QRDecoder` object used for decoding QR codes. For more
+//| information about working with QR codes, see
+//| `this Learn guide <https://learn.adafruit.com/scan-qr-codes-with-circuitpython>`_.
+//|
+//| .. note:: This module only handles decoding QR codes. If you are looking
+//| to generate a QR code, use the
+//| `adafruit_miniqr library <https://github.com/adafruit/Adafruit_CircuitPython_miniQR>`_"""
+//|
+
+STATIC const mp_rom_map_elem_t qrio_module_globals_table[] = {
+ { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_qrio) },
+ { MP_ROM_QSTR(MP_QSTR_QRInfo), MP_ROM_PTR(&qrio_qrinfo_type_obj) },
+ { MP_ROM_QSTR(MP_QSTR_QRDecoder), MP_ROM_PTR(&qrio_qrdecoder_type_obj) },
+ { MP_ROM_QSTR(MP_QSTR_PixelPolicy), MP_ROM_PTR(&qrio_pixel_policy_type) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(qrio_module_globals, qrio_module_globals_table);
+
+const mp_obj_module_t qrio_module = {
+ .base = { &mp_type_module },
+ .globals = (mp_obj_dict_t *)&qrio_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_qrio, qrio_module, CIRCUITPY_QRIO);
diff --git a/circuitpython/shared-bindings/qrio/__init__.h b/circuitpython/shared-bindings/qrio/__init__.h
new file mode 100644
index 0000000..be9b3ae
--- /dev/null
+++ b/circuitpython/shared-bindings/qrio/__init__.h
@@ -0,0 +1,27 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler for Adafruit Industries
+ *
+ * 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.
+ */
+
+#pragma once