Working Backend and Frontend for CLUE Screen (#266)

Initial backend and frontend for CLUE screen work

Author: andreamah

adafruit-circuitpython-display-text-DSX_CUSTOM_MAR172020.tar.gz

@@ -35,6 +35,9 @@ gulp.task("clean", () => {
 
 const pythonToMove = [
   "./src/adafruit_circuitplayground/*.*",
+  "./src/clue/*.*",
+  "./src/clue/!(test)/**/*",
+  "./src/base_circuitpython/**/*",
   "./src/micropython/*.*",
   "./src/micropython/microbit/*.*",
   "./src/micropython/microbit/!(test)/**/*",

gulpfile.js

@@ -3,7 +3,6 @@
     "deviceSimulatorExpressExtension.commands.common.label": "Device Simulator Express",
     "deviceSimulatorExpressExtension.commands.common.runSimulator": "Run Simulator",
     "deviceSimulatorExpressExtension.commands.common.gettingStarted": "Getting Started",
-
     "deviceSimulatorExpressExtension.commands.common.changeBaudRate": "Change Baud Rate",
     "deviceSimulatorExpressExtension.commands.common.closeSerialMonitor": "Close Serial Monitor",
     "deviceSimulatorExpressExtension.commands.common.openSerialMonitor": "Open Serial Monitor",
@@ -14,8 +13,10 @@
     "deviceSimulatorExpressExtension.commands.microbit.deployToDevice": "[micro:bit] Deploy to Device",
     "deviceSimulatorExpressExtension.commands.microbit.openSimulator": "[micro:bit] Open Simulator",
     "deviceSimulatorExpressExtension.commands.microbit.newFile": "[micro:bit] New File",
+    "deviceSimulatorExpressExtension.commands.clue.openSimulator": "[Clue] Open Simulator",
+    "deviceSimulatorExpressExtension.commands.clue.newFile": "[Clue] New File",
     "deviceSimulatorExpressExtension.configuration.title": "Device Simulator Express configuration",
     "deviceSimulatorExpressExtension.configuration.properties.configEnvOnChange": "When you change the Python interpreter, the Device Simulator Express will automatically configure itself for the required dependencies.",
     "deviceSimulatorExpressExtension.configuration.properties.debuggerPort": "The port the Server will listen on for communication with the debugger.",
     "deviceSimulatorExpressExtension.configuration.properties.dependencyChecker": "Whether or not to ask if we can download dependencies. If unchecked, the extension will default to never download dependencies, except when automatically creating a virtual environment in the extension files."
-}
+}

locales/en/package.i18n.json

@@ -41,6 +41,8 @@
         "onCommand:deviceSimulatorExpress.microbit.deployToDevice",
         "onCommand:deviceSimulatorExpress.microbit.newFile",
         "onCommand:deviceSimulatorExpress.microbit.openSimulator",
+        "onCommand:deviceSimulatorExpress.clue.newFile",
+        "onCommand:deviceSimulatorExpress.clue.openSimulator",
         "onDebug"
     ],
     "main": "./out/extension.js",
@@ -110,6 +112,16 @@
                 "command": "deviceSimulatorExpress.microbit.newFile",
                 "title": "%deviceSimulatorExpressExtension.commands.microbit.newFile%",
                 "category": "%deviceSimulatorExpressExtension.commands.common.label%"
+            },
+            {
+                "command": "deviceSimulatorExpress.clue.openSimulator",
+                "title": "%deviceSimulatorExpressExtension.commands.clue.openSimulator%",
+                "category": "%deviceSimulatorExpressExtension.commands.common.label%"
+            },
+            {
+                "command": "deviceSimulatorExpress.clue.newFile",
+                "title": "%deviceSimulatorExpressExtension.commands.clue.newFile%",
+                "category": "%deviceSimulatorExpressExtension.commands.common.label%"
             }
         ],
         "colors": [
@@ -342,4 +354,4 @@
     "extensionDependencies": [
         "ms-python.python"
     ]
-}
+}

package.json

@@ -3,7 +3,6 @@
     "deviceSimulatorExpressExtension.commands.common.label": "Device Simulator Express",
     "deviceSimulatorExpressExtension.commands.common.runSimulator": "Run Simulator",
     "deviceSimulatorExpressExtension.commands.common.gettingStarted": "Getting Started",
-
     "deviceSimulatorExpressExtension.commands.common.changeBaudRate": "Change Baud Rate",
     "deviceSimulatorExpressExtension.commands.common.closeSerialMonitor": "Close Serial Monitor",
     "deviceSimulatorExpressExtension.commands.common.openSerialMonitor": "Open Serial Monitor",
@@ -14,8 +13,10 @@
     "deviceSimulatorExpressExtension.commands.microbit.deployToDevice": "[micro:bit] Deploy to Device",
     "deviceSimulatorExpressExtension.commands.microbit.openSimulator": "[micro:bit] Open Simulator",
     "deviceSimulatorExpressExtension.commands.microbit.newFile": "[micro:bit] New File",
+    "deviceSimulatorExpressExtension.commands.clue.openSimulator": "[Clue] Open Simulator",
+    "deviceSimulatorExpressExtension.commands.clue.newFile": "[Clue] New File",
     "deviceSimulatorExpressExtension.configuration.title": "Device Simulator Express configuration",
     "deviceSimulatorExpressExtension.configuration.properties.configEnvOnChange": "When you change the Python interpreter, the Device Simulator Express will automatically configure itself for the required dependencies.",
     "deviceSimulatorExpressExtension.configuration.properties.debuggerPort": "The port the Server will listen on for communication with the debugger.",
     "deviceSimulatorExpressExtension.configuration.properties.dependencyChecker": "Whether or not to ask for dependency downloads. If unchecked, the extension will default to never download dependencies, except when automatically creating a virtual environment in the extension files."
-}
+}

package.nls.json

@@ -0,0 +1,6 @@
+import pathlib
+import os
+import sys
+
+abs_path = pathlib.Path(__file__).parent.absolute()
+sys.path.insert(0, os.path.join(abs_path))

src/base_circuitpython/__init__.py

@@ -0,0 +1,8 @@
+CPX = "CPX"
+CLUE = "CLUE"
+PIXELS = "pixels"
+
+CLUE_PIN = "D18"
+
+IMG_DIR_NAME = "img"
+SCREEN_HEIGHT_WIDTH = 240

src/base_circuitpython/base_cp_constants.py

@@ -0,0 +1,19 @@
+# dummy class for references to board display to work
+# https://learn.adafruit.com/arduino-to-circuitpython/the-board-module
+
+
+class Display:
+    def __init__(self):
+        pass
+
+    def show(self, group):
+        group.draw()
+
+
+DISPLAY = Display()
+
+# deafult pin,
+# shows that this could
+# refer to the CPX
+# or CLUE neopixel pin
+NEOPIXEL = "D00"

src/base_circuitpython/board.py

@@ -0,0 +1,17 @@
+# dummy class for neopixel library to work
+
+# original implementation docs for digitalio:
+# https://circuitpython.readthedocs.io/en/5.0.x/shared-bindings/digitalio/__init__.html
+
+
+class DigitalInOut:
+    def __init__(self, pin):
+        self.pin = pin
+        pass
+
+    def deinit(self):
+        pass
+
+
+class Direction:
+    OUTPUT = 0

src/base_circuitpython/digitalio.py

@@ -0,0 +1,12 @@
+# Displayio implementation loosely based on the
+# displayio package in Adafruit CircuitPython
+
+# https://circuitpython.readthedocs.io/en/5.0.x/shared-bindings/displayio/__init__.html
+
+from .bitmap import Bitmap
+from .color_type import ColorType
+from .group import Group
+from .palette import Palette
+
+# references to img and bmp_img are for testing purposes
+from .tile_grid import TileGrid, img, bmp_img

src/base_circuitpython/displayio/__init__.py

@@ -0,0 +1,54 @@
+from . import constants as CONSTANTS
+
+# Bitmap implementation loosely based on the
+# displayio.Bitmap class in Adafruit CircuitPython
+
+# https://circuitpython.readthedocs.io/en/5.0.x/shared-bindings/displayio/Bitmap.html
+
+# The colour of a certain pixel is interpreted
+# within the TileGrid instance that the object
+# lives within. Each pixel is an integer value
+# that refers to the colours in the palette via index.
+
+
+class Bitmap:
+    def __init__(self, width, height, value_count=255):
+        self.__width = width
+        self.__height = height
+        self.values = bytearray(width * height)
+
+    @property
+    def width(self):
+        return self.__width
+
+    @property
+    def height(self):
+        return self.__height
+
+    def __setitem__(self, index, value):
+        if isinstance(index, tuple):
+            if index[0] >= self.width or index[1] >= self.height:
+                raise IndexError(CONSTANTS.PIXEL_OUT_OF_BOUNDS)
+
+            index = index[0] + index[1] * self.width
+
+        try:
+            self.values[index] = value
+        except IndexError:
+            raise IndexError(CONSTANTS.PIXEL_OUT_OF_BOUNDS)
+
+    def __getitem__(self, index):
+
+        if isinstance(index, tuple):
+            if index[0] >= self.width or index[1] >= self.height:
+                raise IndexError(CONSTANTS.PIXEL_OUT_OF_BOUNDS)
+
+            index = index[0] + index[1] * self.width
+
+        try:
+            return self.values[index]
+        except IndexError:
+            raise IndexError(CONSTANTS.PIXEL_OUT_OF_BOUNDS)
+
+    def __len__(self):
+        return self.width * self.height

src/base_circuitpython/displayio/bitmap.py

@@ -0,0 +1,12 @@
+# Datatype for the items within a palette
+class ColorType:
+    def __init__(self, rgb888):
+        self.rgb888 = rgb888
+        self.transparent = False
+
+    def __eq__(self, other):
+        return (
+            isinstance(other, ColorType)
+            and self.rgb888 == other.rgb888
+            and self.transparent == other.transparent
+        )

src/base_circuitpython/displayio/color_type.py

@@ -0,0 +1,11 @@
+PIXEL_OUT_OF_BOUNDS = "pixel coordinates out of bounds"
+PALETTE_OUT_OF_RANGE = "Palette index out of range"
+TILE_OUT_OF_BOUNDS = "Tile index out of bounds"
+INCORR_SUBCLASS = "Layer must be a Group or TileGrid subclass."
+LAYER_ALREADY_IN_GROUP = "Layer already in a group."
+GROUP_FULL = "Group Full"
+
+SCREEN_HEIGHT_WIDTH = 240
+
+CLUE = "CLUE"
+BASE_64 = "display_base64"

src/base_circuitpython/displayio/constants.py

@@ -0,0 +1,96 @@
+import base64
+from io import BytesIO
+from PIL import Image
+import adafruit_display_text
+
+from .tile_grid import TileGrid, bmp_img, img
+from . import constants as CONSTANTS
+
+import common
+
+# Group implementation loosely based on the
+# displayio.Group class in Adafruit CircuitPython
+# (with only the functions needed for the CLUE)
+
+# https://circuitpython.readthedocs.io/en/5.0.x/shared-bindings/displayio/Group.html
+
+
+class Group:
+    def __init__(self, max_size, scale=1, auto_write=True):
+        self.__contents = []
+        self.max_size = max_size
+        self.scale = scale
+        self.auto_write = auto_write
+        self.in_group = False
+
+    def append(self, item):
+        if len(self.__contents) == self.max_size:
+            raise RuntimeError(CONSTANTS.GROUP_FULL)
+        elif not isinstance(item, TileGrid) and not isinstance(item, Group):
+            raise ValueError(CONSTANTS.INCORR_SUBCLASS)
+        elif item.in_group:
+            raise ValueError(CONSTANTS.LAYER_ALREADY_IN_GROUP)
+
+        self.__contents.append(item)
+        item.in_group = True
+        if self.auto_write:
+            self.draw(show=True)
+
+    def __getitem__(self, index):
+        return self.__contents[index]
+
+    def __setitem__(self, index, val):
+        self.__contents[index] = val
+
+    def draw(self, x=0, y=0, scale=None, show=False):
+        # this function is not a part of the orignal implementation
+        # it is what prints itself and its children to the frontend
+        if scale is None:
+            scale = self.scale
+        else:
+            scale *= self.scale
+
+        try:
+            if isinstance(self, adafruit_display_text.label.Label):
+                # adafruit_display_text has some positioning considerations
+                # that need to be handled.
+
+                # found manually, display must be positioned upwards
+                # 1 unit (1 unit * scale = scale)
+                y -= scale
+
+                # group is positioned against anchored_position (default (0,0)),
+                # which is positioned against anchor_point
+
+                x += self._anchor_point[0]
+                y += self._anchor_point[1]
+                if self._boundingbox is not None and self.anchored_position is not None:
+                    x += self.anchored_position[0]
+                    y += self.anchored_position[1]
+        except AttributeError:
+            pass
+
+        for elem in self.__contents:
+            if isinstance(elem, Group):
+                elem.draw(x, y, scale, False)
+            else:
+                elem.draw(x, y, scale)
+
+        if show:
+            self.show()
+
+    def show(self):
+        # sends current bmp_img to the frontend
+        buffered = BytesIO()
+        img.save(buffered, format="BMP")
+        byte_base64 = base64.b64encode(buffered.getvalue())
+        img_str = str(byte_base64)[2:-1]
+
+        sendable_json = {CONSTANTS.BASE_64: img_str}
+        common.utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)
+
+    def __len__(self):
+        if not self.__contents:
+            return 0
+        else:
+            return len(self.__contents)

src/base_circuitpython/displayio/group.py

@@ -0,0 +1,40 @@
+from .color_type import ColorType
+from . import constants as CONSTANTS
+
+# Palette implementation loosely based on the
+# displayio.Palette class in Adafruit CircuitPython
+# (with only the functions needed for the CLUE)
+
+# https://circuitpython.readthedocs.io/en/5.0.x/shared-bindings/displayio/Palette.html
+
+
+class Palette:
+    def __init__(self, color_count):
+        self.color_count = color_count
+        self.__contents = []
+
+        # set all colours to black by default
+        for i in range(self.color_count):
+            self.__contents.append(ColorType((0, 0, 0)))
+
+    def __getitem__(self, index):
+        if index >= self.color_count:
+            raise IndexError(CONSTANTS.PALETTE_OUT_OF_RANGE)
+
+        return self.__contents[index].rgb888
+
+    def __setitem__(self, index, value):
+        if index >= self.color_count:
+            raise IndexError(CONSTANTS.PALETTE_OUT_OF_RANGE)
+
+        self.__contents[index].rgb888 = value
+
+    def make_transparent(self, index):
+        self.__toggle_transparency(index, True)
+
+    def make_opaque(self, index):
+        self.__toggle_transparency(index, False)
+
+    def __toggle_transparency(self, index, transparency):
+        if self.__contents[index]:
+            self.__contents[index].transparent = transparency