Merge branch 'dev' into users/t-xunguy/currently-running

Author: xnkevinnguyen

gulpfile.js

@@ -35,8 +35,9 @@ gulp.task("clean", () => {
 
 const pythonToMove = [
   "./src/adafruit_circuitplayground/*.*",
-  "./src/microbit/*.*",
-  "./src/microbit/!(test)/**/*",
+  "./src/micropython/*.*",
+  "./src/micropython/microbit/*.*",
+  "./src/micropython/microbit/!(test)/**/*",
   "./src/*.py",
   "./src/common/*.py",
   "./src/dev-requirements.txt",

package-lock.json

@@ -86,7 +86,7 @@ def tapped(self):
         """  Not Implemented!
         """
         telemetry_py.send_telemetry(TelemetryEvent.CPX_API_TAPPED)
-        raise NotImplementedError(CONSTANTS.NOT_IMPLEMENTED_ERROR)
+        utils.print_for_unimplemented_functions("tapped")
 
     @property
     def red_led(self):
@@ -154,12 +154,12 @@ def touch_A6(self):
     def touch_A7(self):
         return self.__touch(7)
 
-    def adjust_touch_threshold(self, adjustement):
+    def adjust_touch_threshold(self, adjustment):
         """Not implemented!
         The CPX Simulator doesn't use capacitive touch threshold.
         """
         telemetry_py.send_telemetry(TelemetryEvent.CPX_API_ADJUST_THRESHOLD)
-        raise NotImplementedError(CONSTANTS.NOT_IMPLEMENTED_ERROR)
+        utils.print_for_unimplemented_functions(Express.adjust_touch_threshold.__name__)
 
     def shake(self, shake_threshold=30):
         telemetry_py.send_telemetry(TelemetryEvent.CPX_API_SHAKE)
@@ -192,19 +192,19 @@ def play_tone(self, frequency, duration):
         """ Not Implemented!
         """
         telemetry_py.send_telemetry(TelemetryEvent.CPX_API_PLAY_TONE)
-        raise NotImplementedError(CONSTANTS.NOT_IMPLEMENTED_ERROR)
+        utils.print_for_unimplemented_functions(Express.play_tone.__name__)
 
     def start_tone(self, frequency):
         """ Not Implemented!
         """
         telemetry_py.send_telemetry(TelemetryEvent.CPX_API_START_TONE)
-        raise NotImplementedError(CONSTANTS.NOT_IMPLEMENTED_ERROR)
+        utils.print_for_unimplemented_functions(Express.start_tone.__name__)
 
     def stop_tone(self):
         """ Not Implemented!
         """
         telemetry_py.send_telemetry(TelemetryEvent.CPX_API_STOP_TONE)
-        raise NotImplementedError(CONSTANTS.NOT_IMPLEMENTED_ERROR)
+        utils.print_for_unimplemented_functions(Express.stop_tone.__name__)
 
     def update_state(self, new_state):
         for event in CONSTANTS.ALL_EXPECTED_INPUT_EVENTS:

src/adafruit_circuitplayground/express.py

@@ -14,8 +14,8 @@
 from adafruit_circuitplayground.express import cpx
 from adafruit_circuitplayground.constants import CPX
 
-from microbit.__model.microbit_model import __mb as mb
-from microbit.__model.constants import MICROBIT
+from micropython.microbit.__model.microbit_model import __mb as mb
+from micropython.microbit.__model.constants import MICROBIT
 
 
 device_dict = {CPX: cpx, MICROBIT: mb}

src/common/debugger_communication_client.py

@@ -31,3 +31,12 @@ class TelemetryEvent(enum.Enum):
     MICROBIT_API_IMAGE_OTHER = "MICROBIT.API.IMAGE.OTHER"
     MICROBIT_API_IMAGE_STATIC = "MICROBIT.API.IMAGE.STATIC"
     MICROBIT_API_BUTTON = "MICROBIT.API.BUTTON"
+    MICROBIT_API_COMPASS = "MICROBIT.API.COMPASS"
+    MICROBIT_API_I2C = "MICROBIT.API.I2C"
+    MICROBIT_API_SPI = "MICROBIT.API.SPI"
+    MICROBIT_API_AUDIO = "MICROBIT.API.AUDIO"
+    MICROBIT_API_MUSIC = "MICROBIT.API.MUSIC"
+    MICROBIT_API_NEOPIXEL = "MICROBIT.API.NEOPIXEL"
+    MICROBIT_API_RADIO = "MICROBIT.API.RADIO"
+    MICROBIT_API_SPEECH = "MICROBIT.API.SPEECH"
+    MICROBIT_API_UTIME = "MICROBIT.API.UTIME"

src/common/telemetry_events.py

@@ -2,7 +2,7 @@
 
 from unittest import mock
 
-from .. import constants as CONSTANTS
+from common import constants as CONSTANTS
 from common import utils
 
 

src/adafruit_circuitplayground/test/test_utils.py renamed to src/common/test/test_utils.py

@@ -47,3 +47,16 @@ def escape_if_OSX(file_name):
     if sys.platform == CONSTANTS.MAC_OS:
         file_name = file_name.replace(" ", "%20")
     return file_name
+
+
+def print_for_unimplemented_functions(function_name, one_more_call=False):
+    # Frame 0 is this function call
+    # Frame 1 is the call that calls this function, which is a microbit function
+    # Frame 2 is the call that calls the microbit function, which is in the user's file
+    # If one_more_call is True, then there is another frame between what was originally supposed to be frame 1 and 2.
+    frame_no = 2 if not one_more_call else 3
+    line_number = sys._getframe(frame_no).f_lineno
+    user_file_name = sys._getframe(frame_no).f_code.co_filename
+    print(
+        f"'{function_name}' on line {line_number} in {user_file_name} is not implemented in the simulator but it will work on the actual device!"
+    )

src/common/utils.py

@@ -121,6 +121,7 @@ export const CONSTANTS = {
     FILESYSTEM: {
         OUTPUT_DIRECTORY: "out",
         PYTHON_VENV_DIR: "venv",
+        MICROPYTHON_DIRECTORY: "micropython",
     },
     INFO: {
         ALREADY_SUCCESSFUL_INSTALL: localize(

src/constants.ts

@@ -11,14 +11,19 @@
 # will propagate errors if dependencies aren't sufficient
 check_python_dependencies.check_for_dependencies()
 
-# Insert absolute path to Adafruit library into sys.path
 abs_path_to_parent_dir = os.path.dirname(os.path.abspath(__file__))
-abs_path_to_lib = os.path.join(abs_path_to_parent_dir, CONSTANTS.LIBRARY_NAME)
-sys.path.insert(0, abs_path_to_lib)
 
-# Insert absolute path to python libraries into sys.path
-abs_path_to_parent_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.insert(0, abs_path_to_lib)
+# Insert absolute path to Adafruit library for CPX into sys.path
+abs_path_to_adafruit_lib = os.path.join(
+    abs_path_to_parent_dir, CONSTANTS.ADAFRUIT_LIBRARY_NAME
+)
+sys.path.insert(0, abs_path_to_adafruit_lib)
+
+# Insert absolute path to Micropython libraries for micro:bit into sys.path
+abs_path_to_micropython_lib = os.path.join(
+    abs_path_to_parent_dir, CONSTANTS.MICROPYTHON_LIBRARY_NAME
+)
+sys.path.insert(0, abs_path_to_micropython_lib)
 
 # This import must happen after the sys.path is modified
 from adafruit_circuitplayground.express import cpx

src/debug_user_code.py

@@ -1273,7 +1273,10 @@ const handleNewFileErrorTelemetry = () => {
 const updatePythonExtraPaths = () => {
     updateConfigLists(
         "python.autoComplete.extraPaths",
-        [__dirname],
+        [
+            __dirname,
+            path.join(__dirname, CONSTANTS.FILESYSTEM.MICROPYTHON_DIRECTORY),
+        ],
         vscode.ConfigurationTarget.Global
     );
 };
@@ -1283,12 +1286,20 @@ const updatePylintArgs = (context: vscode.ExtensionContext) => {
         context.extensionPath,
         CONSTANTS.FILESYSTEM.OUTPUT_DIRECTORY
     );
+    const micropythonPath: string = utils.createEscapedPath(
+        context.extensionPath,
+        CONSTANTS.FILESYSTEM.OUTPUT_DIRECTORY,
+        CONSTANTS.FILESYSTEM.MICROPYTHON_DIRECTORY
+    );
 
     // update pylint args to extend system path
     // to include python libs local to extention
     updateConfigLists(
         "python.linting.pylintArgs",
-        ["--init-hook", `import sys; sys.path.append(\"${outPath}\")`],
+        [
+            "--init-hook",
+            `import sys; sys.path.extend([\"${outPath}\",\"${micropythonPath}\"])`,
+        ],
         vscode.ConfigurationTarget.Workspace
     );
 };

src/extension.ts

@@ -0,0 +1,39 @@
+from common import utils
+from common.telemetry import telemetry_py
+from common.telemetry_events import TelemetryEvent
+
+# The implementation is based off of https://microbit-micropython.readthedocs.io/en/v1.0.1/audio.html.
+
+
+def play(source, wait=True, pin="pin0", return_pin=None):
+    """
+    This function is not implemented in the simulator.
+    
+    Play the source to completion.
+
+    ``source`` is an iterable, each element of which must be an ``AudioFrame``.
+
+    If ``wait`` is ``True``, this function will block until the source is exhausted.
+
+    ``pin`` specifies which pin the speaker is connected to.
+
+    ``return_pin`` specifies a differential pin to connect to the speaker
+    instead of ground.
+    """
+    utils.print_for_unimplemented_functions(play.__name__)
+    telemetry_py.send_telemetry(TelemetryEvent.MICROBIT_API_AUDIO)
+
+
+class AudioFrame:
+    """
+    This class is not implemented in the simulator.
+
+    An ``AudioFrame`` object is a list of 32 samples each of which is a signed byte
+    (whole number between -128 and 127).
+
+    It takes just over 4 ms to play a single frame.
+    """
+
+    def __init__(self):
+        utils.print_for_unimplemented_functions(AudioFrame.__init__.__qualname__)
+        telemetry_py.send_telemetry(TelemetryEvent.MICROBIT_API_AUDIO)

src/microbit/test/__init__.py renamed to src/micropython/__init__.py

@@ -6,7 +6,24 @@
 accelerometer = __mb.accelerometer
 button_a = __mb.button_a
 button_b = __mb.button_b
+compass = __mb.compass
 display = __mb.display
+i2c = __mb.i2c
+spi = __mb.spi
+
+
+def panic(n):
+    """
+    Enter a panic mode. Requires restart. Pass in an arbitrary integer <= 255 to indicate a status
+    """
+    __mb.panic(n)
+
+
+def reset():
+    """
+    Restart the board.
+    """
+    __mb.reset()
 
 
 def sleep(n):