Merge pull request microsoft#294 from microsoft/users/t-anmah/clue-debugger

Clue Debugger

Author: xnkevinnguyen

src/adafruit_circuitplayground/express.py

@@ -46,8 +46,7 @@ def __init__(self):
             "touch": [False] * 7,
             "shake": False,
         }
-        self.__debug_mode = False
-        self.pixels = Pixel(self.__state, self.__debug_mode)
+        self.pixels = Pixel(self.__state)
 
     @property
     def acceleration(self):
@@ -113,7 +112,7 @@ def light(self):
         return self.__state["light"]
 
     def __show(self):
-        if self.__debug_mode:
+        if utils.debug_mode:
             common.debugger_communication_client.debug_send_to_simulator(
                 self.__state, CONSTANTS.CPX
             )

src/adafruit_circuitplayground/pixel.py

@@ -12,16 +12,15 @@
 
 
 class Pixel:
-    def __init__(self, state, debug_mode=False):
+    def __init__(self, state):
         self.__state = state
         self.auto_write = True
-        self.__debug_mode = debug_mode
         self.telemetry_state = False
 
     def show(self):
         # Send the state to the extension so that React re-renders the Webview
         # or send the state to the debugger (within this library)
-        if self.__debug_mode:
+        if utils.debug_mode:
             common.debugger_communication_client.debug_send_to_simulator(
                 self.__state, CONSTANTS.CPX
             )
@@ -32,9 +31,6 @@ def __show_if_auto_write(self):
         if self.auto_write:
             self.show()
 
-    def __set_debug_mode(self, debug_mode):
-        self.__debug_mode = debug_mode
-
     def __getitem__(self, index):
         if type(index) is not slice:
             if not self.__valid_index(index):

src/adafruit_circuitplayground/test/test_pixel.py

@@ -16,11 +16,6 @@ def setup_method(self):
             }
         )
 
-    @pytest.mark.parametrize("debug_mode", [True, False])
-    def test_set_debug_mode(self, debug_mode):
-        self.pixel._Pixel__set_debug_mode(debug_mode)
-        assert debug_mode == self.pixel._Pixel__debug_mode
-
     def test_get_item_out_of_bounds(self):
         with pytest.raises(IndexError):
             p = self.pixel[3]

src/base_circuitpython/displayio/group.py

@@ -288,4 +288,22 @@ def __show(self, img):
         img_str = str(byte_base64)[2:-1]
 
         sendable_json = {CONSTANTS.BASE_64: img_str}
-        common.utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)
+
+        if common.utils.debug_mode:
+            common.debugger_communication_client.debug_send_to_simulator(
+                sendable_json, CONSTANTS.CLUE
+            )
+        else:
+            common.utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)
+
+    def __len__(self):
+        if not self.__contents:
+            return 0
+        else:
+            return len(self.__contents)
+
+    def pop(self, i=-1):
+        item = self.__contents.pop(i)
+        item.parent = None
+        self.elem_changed()
+        return item

src/base_circuitpython/neopixel_write.py

@@ -8,7 +8,7 @@
 import sys
 import os
 
-from common import utils
+import common
 from adafruit_circuitplayground import cp
 import base_cp_constants as CONSTANTS
 
@@ -30,7 +30,12 @@ def neopixel_write(gpio, buf):
 
 def send_clue(buf):
     sendable_json = {CONSTANTS.PIXELS: tuple(buf)}
-    utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)
+    if common.utils.debug_mode:
+        common.debugger_communication_client.debug_send_to_simulator(
+            sendable_json, CONSTANTS.CLUE
+        )
+    else:
+        common.utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)
 
 
 def send_cpx(buf):

src/clue/adafruit_slideshow.py

@@ -8,6 +8,7 @@
 import collections
 from random import shuffle
 from common import utils
+from common import debugger_communication_client
 from common.telemetry import telemetry_py
 from common.telemetry_events import TelemetryEvent
 import board
@@ -380,4 +381,10 @@ def __send(self, img):
         img_str = str(byte_base64)[2:-1]
 
         sendable_json = {CONSTANTS.BASE_64: img_str}
-        utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)
+
+        if utils.debug_mode:
+            debugger_communication_client.debug_send_to_simulator(
+                sendable_json, CONSTANTS.CLUE
+            )
+        else:
+            utils.send_to_simulator(sendable_json, CONSTANTS.CLUE)

src/common/debugger_communication_client.py

@@ -5,20 +5,34 @@
 import json
 import socketio
 import copy
+import pathlib
 
 from . import constants as CONSTANTS
 from . import utils
 import threading
-
+import os
+import python_constants as TOPLEVEL_CONSTANTS
 
 from adafruit_circuitplayground.express import cpx
 from adafruit_circuitplayground.constants import CPX
 
+# add ref for micropython and clue
+abs_path_to_parent_dir = os.path.dirname(
+    os.path.join(pathlib.Path(__file__).parent, "..", "..")
+)
+sys.path.insert(
+    0, os.path.join(abs_path_to_parent_dir, TOPLEVEL_CONSTANTS.MICROPYTHON_LIBRARY_NAME)
+)
+
+sys.path.insert(0, os.path.join(abs_path_to_parent_dir, TOPLEVEL_CONSTANTS.CLUE_DIR))
+
 from microbit.__model.microbit_model import __mb as mb
 from microbit.__model.constants import MICROBIT
 
+from base_circuitpython.base_cp_constants import CLUE
+from adafruit_clue import clue
 
-device_dict = {CPX: cpx, MICROBIT: mb}
+device_dict = {CPX: cpx, MICROBIT: mb, CLUE: clue}
 processing_state_event = threading.Event()
 previous_state = {}
 

src/common/utils.py

@@ -10,6 +10,7 @@
 previous_state = {}
 
 abs_path_to_user_file = ""
+debug_mode = False
 
 
 def update_state_with_device_name(state, device_name):

src/debug_user_code.py

@@ -26,15 +26,17 @@
 )
 sys.path.insert(0, abs_path_to_micropython_lib)
 
+# Insert absolute path to library for CLUE into sys.path
+sys.path.insert(0, os.path.join(abs_path_to_parent_dir, CONSTANTS.CLUE))
+
+# Insert absolute path to Circuitpython libraries for CLUE into sys.path
+sys.path.insert(0, os.path.join(abs_path_to_parent_dir, CONSTANTS.CIRCUITPYTHON))
+
 # This import must happen after the sys.path is modified
-from adafruit_circuitplayground.express import cpx
-from microbit.__model.microbit_model import __mb as mb
 from common import debugger_communication_client
 
-
 ## Execute User Code ##
 
-
 # Get user's code path
 abs_path_to_code_file = ""
 if len(sys.argv) > 1 and sys.argv[1]:
@@ -52,9 +54,7 @@
 
 # Init API variables
 utils.abs_path_to_user_file = abs_path_to_code_file
-cpx._Express__debug_mode = True
-cpx.pixels._Pixel__set_debug_mode(True)
-mb._MicrobitModel__set_debug_mode(True)
+utils.debug_mode = True
 
 # Execute the user's code file
 with open(abs_path_to_code_file, encoding="utf8") as user_code_file:

src/micropython/microbit/__model/display.py

@@ -21,7 +21,6 @@ def __init__(self):
 
         self.__current_pid = None
         self.__lock = threading.Lock()
-        self.__debug_mode = False
 
     def scroll(self, value, delay=150, wait=True, loop=False, monospace=False):
         """
@@ -352,7 +351,7 @@ def __create_scroll_image(images):
     def __update_client(self):
         sendable_json = {"leds": self.__get_array()}
 
-        if self.__debug_mode:
+        if common.utils.debug_mode:
             common.debugger_communication_client.debug_send_to_simulator(
                 sendable_json, CONSTANTS.MICROBIT
             )