Serial communication from the CPX to the extension

ThirdPartyNotices.txt

@@ -21,8 +21,10 @@ This project incorporates components from the projects listed below. The origina
 14. Python for Win32 (https://github.com/mhammond/pywin32)
 15. Playsound (https://github.com/TaylorSMarks/playsound)
 16. pytest (https://docs.pytest.org/en/latest/)
-17. Python-Socketio (https://github.com/miguelgrinberg/python-socketio/)
-18. Requests (https://github.com/psf/requests)
+17. VS Code Arduino (https://github.com/Microsoft/vscode-arduino)
+18. EventEmitter2 (https://github.com/EventEmitter2/EventEmitter2)
+19. Python-Socketio (https://github.com/miguelgrinberg/python-socketio/)
+20. Requests (https://github.com/psf/requests)
 
 
 %% Files from the Python Project NOTICES, INFORMATION, AND LICENSE BEGIN HERE
@@ -2349,6 +2351,55 @@ SOFTWARE.
 END OF pytest NOTICES, INFORMATION, AND LICENSE
 
 
+%% VS Code Arduino NOTICES, INFORMATION, AND LICENSE BEGIN HERE
+=============================================
+------------------------------------------ START OF LICENSE -----------------------------------------
+
+vscode-arduino
+
+Copyright (c) Microsoft Corporation
+
+All rights reserved. 
+
+MIT License
+
+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.
+
+----------------------------------------------- END OF LICENSE ------------------------------------------
+=============================================
+END OF vscode-arduino NOTICES, INFORMATION, AND LICENSE
+
+
+%% EventEmitter2 NOTICES, INFORMATION, AND LICENSE BEGIN HERE
+=============================================
+The MIT License (MIT)
+
+Copyright (c) 2016 Paolo Fragomeni <http://www.github.com/0x00a> and Contributors
+
+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.
+=============================================
+END OF EventEmitter2 NOTICES, INFORMATION, AND LICENSE
+
+
 %% Python-Socketio NOTICES, INFORMATION, AND LICENSE BEGIN HERE
 =============================================
 The MIT License (MIT)
@@ -2391,4 +2442,4 @@ Copyright 2018 Kenneth Reitz
   See the License for the specific language governing permissions and
   limitations under the License.
 =============================================
-END OF Requests NOTICES, INFORMATION, AND LICENSE
+END OF Requests NOTICES, INFORMATION, AND LICENSE

locales/en/package.i18n.json

@@ -1,9 +1,13 @@
 {
+  "pacificaExtension.commands.changeBaudRate": "Change Baud Rate",
+  "pacificaExtension.commands.closeSerialMonitor": "Close Serial Monitor",
   "pacificaExtension.commands.label": "Pacifica",
+  "pacificaExtension.commands.openSerialMonitor": "Open Serial Monitor",
   "pacificaExtension.commands.openSimulator": "Open Simulator",
   "pacificaExtension.commands.runSimulator": "Run Simulator",
   "pacificaExtension.commands.newFile": "New File",
   "pacificaExtension.commands.runDevice": "Deploy to Device",
+  "pacificaExtension.commands.selectSerialPort": "Select Serial Port",
   "pacificaExtension.configuration.title": "Pacfica configuration",
   "pacificaExtension.configuration.properties.open": "Whether to show 'Open Simulator' icon in editor title menu.",
   "pacificaExtension.configuration.properties.device": "Whether to show 'Run Device' icon in editor title menu.",

misc/usbmapping.json

@@ -0,0 +1,18 @@
+[
+    {
+        "index_file": "https://adafruit.github.io/arduino-board-index/package_adafruit_index.json",
+        "boards": [
+            {
+                "vid": "239a",
+                "pid": [
+                    "8019"
+                ],
+                "name": "Adafruit Circuit Playground Express",
+                "package": "adafruit",
+                "architecture": "samd",
+                "id": "cpx"
+            }
+
+        ]
+    }
+]

package.json

@@ -24,16 +24,33 @@
     "vscode-nls": "^4.0.0"
   },
   "activationEvents": [
+    "onCommand:pacifica.openSerialMonitor",
     "onCommand:pacifica.openSimulator",
     "onCommand:pacifica.runSimulator",
     "onCommand:pacifica.newFile",
     "onCommand:pacifica.runDevice",
     "onCommand:pacifica.runSimulatorEditorButton",
+    "onCommand:pacifica.selectSerialPort",
     "onDebug"
   ],
   "main": "./out/extension.js",
   "contributes": {
     "commands": [
+      {
+        "command": "pacifica.changeBaudRate",
+        "title": "%pacificaExtension.commands.changeBaudRate%",
+        "category": "%pacificaExtension.commands.label%"
+      },
+      {
+        "command": "pacifica.closeSerialMonitor",
+        "title": "%pacificaExtension.commands.closeSerialMonitor%",
+        "category": "%pacificaExtension.commands.label%"
+      },
+      {
+        "command": "pacifica.openSerialMonitor",
+        "title": "%pacificaExtension.commands.openSerialMonitor%",
+        "category": "%pacificaExtension.commands.label%"
+      },
       {
         "command": "pacifica.openSimulator",
         "title": "%pacificaExtension.commands.openSimulator%",
@@ -70,6 +87,11 @@
           "light": "./assets/light-theme/save-to-board.svg",
           "dark": "./assets/dark-theme/save-to-board.svg"
         }
+      },
+      {
+        "command": "pacifica.selectSerialPort",
+        "title": "%pacificaExtension.commands.selectSerialPort%",
+        "category": "%pacificaExtension.commands.label%"
       }
     ],
     "menus": {
@@ -101,6 +123,10 @@
       "type": "object",
       "title": "%pacificaExtension.configuration.title%",
       "properties": {
+        "pacifica.enableUSBDetection": {
+          "type": "boolean",
+          "default": true
+        },
         "pacifica.showOpenIconInEditorTitleMenu": {
           "type": "boolean",
           "default": true,
@@ -255,6 +281,7 @@
     "@types/open": "^6.1.0",
     "@types/socket.io": "^2.1.2",
     "compare-versions": "^3.5.1",
+    "eventemitter2": "^5.0.1",
     "open": "^6.4.0",
     "os": "^0.1.1",
     "react": "^16.8.6",

package.nls.json

@@ -1,9 +1,13 @@
 {
+  "pacificaExtension.commands.changeBaudRate": "Change Baud Rate",
+  "pacificaExtension.commands.closeSerialMonitor": "Close Serial Monitor",
   "pacificaExtension.commands.label": "Pacifica",
+  "pacificaExtension.commands.openSerialMonitor": "Open Serial Monitor",
   "pacificaExtension.commands.openSimulator": "Open Simulator",
   "pacificaExtension.commands.runSimulator": "Run Simulator",
   "pacificaExtension.commands.newFile": "New File",
   "pacificaExtension.commands.runDevice": "Deploy to Device",
+  "pacificaExtension.commands.selectSerialPort": "Select Serial Port",
   "pacificaExtension.configuration.title": "Pacfica configuration",
   "pacificaExtension.configuration.properties.open": "Whether to show 'Open Simulator' icon in editor title menu.",
   "pacificaExtension.configuration.properties.device": "Whether to show 'Run Device' icon in editor title menu.",

src/constants.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 
 import * as nls from "vscode-nls";
+import * as path from "path";
 import { MessageItem } from "vscode";
 
 export const DEFAULT_SERVER_PORT: number = 5678;
@@ -18,10 +19,27 @@ export const CONSTANTS = {
     PYTHON_LAUNCHER: "py -3"
   },
   ERROR: {
+    COMPORT_UNKNOWN_ERROR: "Writing to COM port (GetOverlappedResult): Unknown error code 121",
+    CPX_FILE_ERROR: localize(
+      "error.cpxFileFormat",
+      "The cpx.json file format is not correct."
+    ),
     DEBUGGING_SESSION_IN_PROGESS: localize(
       "error.debuggingSessionInProgress",
       "[ERROR] A debugging session is currently in progress, please stop it before running your code. \n"
     ),
+    FAILED_TO_OPEN_SERIAL_PORT: (port: string): string => {
+      return localize(
+        "error.failedToOpenSerialPort",
+        `[ERROR] Failed to open serial port ${port}.`
+      )
+    },
+    FAILED_TO_OPEN_SERIAL_PORT_DUE_TO: (port: string, error: any) => {
+      return localize(
+        "error.failedToOpenSerialPortDueTo",
+        `[ERROR] Failed to open serial port ${port} due to error: ${error}. \n`
+      )
+    },
     INCORRECT_FILE_NAME_FOR_DEVICE: localize(
       "error.incorrectFileNameForDevice",
       '[ERROR] Can\'t deploy to your Circuit Playground Express device, please rename your file to "code.py" or "main.py". \n'
@@ -59,7 +77,17 @@ export const CONSTANTS = {
     )
   },
   INFO: {
+    CLOSED_SERIAL_PORT: (port: string) => {
+      return localize(
+        "info.closedSerialPort",
+        `[DONE] Closed the serial port - ${port} \n`
+      );
+    },
     COMPLETED_MESSAGE: "Completed",
+    CPX_JSON_ALREADY_GENERATED: localize(
+      "info.cpxJsonAlreadyGenerated",
+      "cpx.json has already been generated."
+    ),
     DEPLOY_DEVICE: localize(
       "info.deployDevice",
       "\n[INFO] Deploying code to the device...\n"
@@ -76,7 +104,6 @@ export const CONSTANTS = {
       "info.extensionActivated",
       "Congratulations, your extension Adafruit_Simulator is now active!"
     ),
-
     FILE_SELECTED: (filePath: string) => {
       return localize(
         "info.fileSelected",
@@ -99,6 +126,22 @@ export const CONSTANTS = {
       "info.newFile",
       "New to Python or the Circuit Playground Express? We are here to help!"
     ),
+    OPENED_SERIAL_PORT: (port: string) => {
+      return localize(
+        "info.openedSerialPort",
+        `[INFO] Opened the serial port - ${port} \n`
+      );
+    },
+    OPENING_SERIAL_PORT: (port: string) => {
+      return localize(
+        "info.openingSerialPort",
+        `[STARTING] Opening the serial port - ${port} \n`
+      );
+    },
+    PLEASE_OPEN_FOLDER: localize(
+      "info.pleaseOpenFolder",
+      "Please open a folder first."
+    ),
     REDIRECT: localize("info.redirect", "You are being redirected."),
     RUNNING_CODE: localize("info.runningCode", "Running user code"),
     THIRD_PARTY_WEBSITE: localize(
@@ -123,16 +166,55 @@ export const CONSTANTS = {
     TUTORIALS:
       "https://learn.adafruit.com/circuitpython-made-easy-on-circuit-playground-express/circuit-playground-express-library"
   },
+  MISC: {
+    SELECT_PORT_PLACEHOLDER: localize(
+      "misc.selectPortPlaceholder",
+      "Select a serial port"
+    ),
+    SERIAL_MONITOR_NAME: localize(
+      "misc.serialMonitorName",
+      "Pacifica Serial Monitor"
+    )
+  },
   NAME: localize("name", "Pacifica Simulator"),
   WARNING: {
     ACCEPT_AND_RUN: localize(
       "warning.agreeAndRun",
       "By selecting ‘Agree and Run’, you understand the extension executes Python code on your local computer, which may be a potential security risk."
+    ),
+    INVALID_BAUD_RATE: localize(
+      "warning.invalidBaudRate",
+      "Invalid baud rate, keep baud rate unchanged."
+    ),
+    NO_RATE_SELECTED: localize(
+      "warning.noRateSelected",
+      "No rate is selected, keep baud rate unchanged."
+    ),
+    NO_SERIAL_PORT_SELECTED: localize(
+      "warning.noSerialPortSelected",
+      "No serial port was selected, please select a serial port first"
+    ),
+    SERIAL_MONITOR_ALREADY_OPENED: (port: string) => {
+      return localize(
+        "warning.serialMonitorAlreadyOpened",
+        `Serial monitor is already opened for ${port} \n`
+      )
+    },
+    SERIAL_MONITOR_NOT_STARTED: localize(
+      "warning.serialMonitorNotStarted",
+      "Serial monitor has not been started."
+    ),
+    SERIAL_PORT_NOT_STARTED: localize(
+      "warning.serialPortNotStarted",
+      "Serial port has not been started."
     )
   }
 };
 
-// Need the different events we want to track and the name of it
+export enum CONFIG_KEYS {
+  ENABLE_USB_DETECTION = "pacifica.enableUSBDetection"
+}
+
 export enum TelemetryEventName {
   FAILED_TO_OPEN_SIMULATOR = "SIMULATOR.FAILED_TO_OPEN",
 
@@ -193,6 +275,9 @@ export namespace DialogResponses {
   export const DONT_SHOW: MessageItem = {
     title: localize("dialogResponses.dontShowAgain", "Don't Show Again")
   };
+  export const NO: MessageItem = {
+    title: localize("dialogResponses.No", "No")
+  };
   export const PRIVACY_STATEMENT: MessageItem = {
     title: localize("info.privacyStatement", "Privacy Statement")
   };
@@ -208,11 +293,22 @@ export namespace DialogResponses {
   export const INSTALL_PYTHON: MessageItem = {
     title: localize("dialogResponses.installPython", "Install from python.org")
   };
+  export const YES: MessageItem = {
+    title: localize("dialogResponses.Yes", "Yes")
+  };
 }
 
+export const CPX_CONFIG_FILE = path.join(".vscode", "cpx.json");
+
 export const USER_CODE_NAMES = {
   CODE_PY: "code.py",
   MAIN_PY: "main.py"
 };
 
+export const STATUS_BAR_PRIORITY = {
+  PORT: 20,
+  OPEN_PORT: 30,
+  BAUD_RATE: 40,
+};
+
 export default CONSTANTS;

src/cpxWorkspace.ts

@@ -0,0 +1,22 @@
+import * as fs from "fs";
+import * as path from "path";
+import * as vscode from "vscode";
+
+export class CPXWorkspace {
+    static get rootPath(): string|undefined {
+        const workspaceFolders = vscode.workspace.workspaceFolders;
+        if (!workspaceFolders || workspaceFolders.length === 0) {
+            return undefined;
+        }
+
+        for (const workspaceFolder of workspaceFolders) {
+            const workspaceFolderPath = workspaceFolder.uri.fsPath;
+            const cpxConfigPath = path.join(workspaceFolderPath, ".vscode", "cpx.json");
+            if (fs.existsSync(cpxConfigPath)) {
+                return workspaceFolderPath;
+            }
+        }
+
+        return workspaceFolders[0].uri.fsPath;
+    }
+}