Skip to content
This repository was archived by the owner on Dec 23, 2021. It is now read-only.

Commit 9c9bc37

Browse files
vandyliuvandyliu
authored
Deploy to Clue and Deploy Command Pallete Refactoring (#279)
1 parent ff89634 commit 9c9bc37

9 files changed

+465
-342
lines changed

‎locales/en/out/constants.i18n.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"error.debuggerServerInitFailed": "Warning : The Debugger Server cannot be opened. Please try to free the port {0} if it's already in use or select another one in your Settings 'Device Simulator Express: Debugger Server Port' and start another debug session.\n You can still debug your code but you won't be able to use the Simulator.",
1515
"error.debuggingSessionInProgress": "[ERROR] A debugging session is currently in progress, please stop it before running your code. \n",
1616
"error.noDevice": "No plugged in boards detected. Please double check if your board is connected and/or properly formatted",
17-
"error.noFileToRun": "\n[ERROR] We can't find the .py file to run on simulator. Open up a new .py file, or browse through some examples\n",
17+
"error.noFileToRun": "\n[ERROR] We can't find the .py file to run. Open up a new .py file, or browse through some examples\n",
18+
"error.noFileToDeploy": "\n[ERROR] We can't find a Python file to deploy to your device.\n",
1819
"error.noFolderCreated": "In order to use the Serial Monitor, you need to open a folder and reload VS Code.",
1920
"error.noProgramFoundDebug": "Cannot find a program to debug.",
2021
"error.noPythonPath": "We found that you don't have Python 3 installed on your computer, please install the latest version, add it to your PATH and try again.",
@@ -28,6 +29,7 @@
2829
"info.installPythonDependencies": "Do you want us to try and install this extensions dependencies for you?",
2930
"error.invalidFileExtensionDebug": "The file you tried to run isn\\'t a Python file.",
3031
"info.newFile": "New to Python or the Circuit Playground Express? We are here to help!",
32+
"info.noDeviceChosenToDeployTo": "\n[INFO] No device was selected to deploy to.\n",
3133
"info.redirect": "You are being redirected.",
3234
"info.runningCode": "Running user code",
3335
"info.privacyStatement": "Privacy Statement",

‎locales/en/package.i18n.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
"deviceSimulatorExpressExtension.commands.common.closeSerialMonitor": "Close Serial Monitor",
88
"deviceSimulatorExpressExtension.commands.common.openSerialMonitor": "Open Serial Monitor",
99
"deviceSimulatorExpressExtension.commands.common.selectSerialPort": "Select Serial Port",
10+
"deviceSimulatorExpressExtension.commands.common.deployToDevice": "Deploy to Device",
1011
"deviceSimulatorExpressExtension.commands.cpx.openSimulator": "[Circuit Playground Express] Open Simulator",
1112
"deviceSimulatorExpressExtension.commands.cpx.newFile": "[Circuit Playground Express] New File",
12-
"deviceSimulatorExpressExtension.commands.cpx.deployToDevice": "[Circuit Playground Express] Deploy to Device",
13-
"deviceSimulatorExpressExtension.commands.microbit.deployToDevice": "[micro:bit] Deploy to Device",
1413
"deviceSimulatorExpressExtension.commands.microbit.openSimulator": "[micro:bit] Open Simulator",
1514
"deviceSimulatorExpressExtension.commands.microbit.newFile": "[micro:bit] New File",
1615
"deviceSimulatorExpressExtension.commands.clue.openSimulator": "[Clue] Open Simulator",

‎package.json

+3-9
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,9 @@
3535
"onCommand:deviceSimulatorExpress.common.runSimulator",
3636
"onCommand:deviceSimulatorExpress.common.selectSerialPort",
3737
"onCommand:deviceSimulatorExpress.common.gettingStarted",
38-
"onCommand:deviceSimulatorExpress.cpx.deployToDevice",
38+
"onCommand:deviceSimulatorExpress.common.deployToDevice",
3939
"onCommand:deviceSimulatorExpress.cpx.newFile",
4040
"onCommand:deviceSimulatorExpress.cpx.openSimulator",
41-
"onCommand:deviceSimulatorExpress.microbit.deployToDevice",
4241
"onCommand:deviceSimulatorExpress.microbit.newFile",
4342
"onCommand:deviceSimulatorExpress.microbit.openSimulator",
4443
"onCommand:deviceSimulatorExpress.clue.newFile",
@@ -84,8 +83,8 @@
8483
"category": "%deviceSimulatorExpressExtension.commands.common.label%"
8584
},
8685
{
87-
"command": "deviceSimulatorExpress.cpx.deployToDevice",
88-
"title": "%deviceSimulatorExpressExtension.commands.cpx.deployToDevice%",
86+
"command": "deviceSimulatorExpress.common.deployToDevice",
87+
"title": "%deviceSimulatorExpressExtension.commands.common.deployToDevice%",
8988
"category": "%deviceSimulatorExpressExtension.commands.common.label%"
9089
},
9190
{
@@ -98,11 +97,6 @@
9897
"title": "%deviceSimulatorExpressExtension.commands.cpx.openSimulator%",
9998
"category": "%deviceSimulatorExpressExtension.commands.common.label%"
10099
},
101-
{
102-
"command": "deviceSimulatorExpress.microbit.deployToDevice",
103-
"title": "%deviceSimulatorExpressExtension.commands.microbit.deployToDevice%",
104-
"category": "%deviceSimulatorExpressExtension.commands.common.label%"
105-
},
106100
{
107101
"command": "deviceSimulatorExpress.microbit.openSimulator",
108102
"title": "%deviceSimulatorExpressExtension.commands.microbit.openSimulator%",

‎package.nls.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
"deviceSimulatorExpressExtension.commands.common.closeSerialMonitor": "Close Serial Monitor",
88
"deviceSimulatorExpressExtension.commands.common.openSerialMonitor": "Open Serial Monitor",
99
"deviceSimulatorExpressExtension.commands.common.selectSerialPort": "Select Serial Port",
10+
"deviceSimulatorExpressExtension.commands.common.deployToDevice": "Deploy to Device",
1011
"deviceSimulatorExpressExtension.commands.cpx.openSimulator": "[Circuit Playground Express] Open Simulator",
1112
"deviceSimulatorExpressExtension.commands.cpx.newFile": "[Circuit Playground Express] New File",
12-
"deviceSimulatorExpressExtension.commands.cpx.deployToDevice": "[Circuit Playground Express] Deploy to Device",
13-
"deviceSimulatorExpressExtension.commands.microbit.deployToDevice": "[micro:bit] Deploy to Device",
1413
"deviceSimulatorExpressExtension.commands.microbit.openSimulator": "[micro:bit] Open Simulator",
1514
"deviceSimulatorExpressExtension.commands.microbit.newFile": "[micro:bit] New File",
1615
"deviceSimulatorExpressExtension.commands.clue.openSimulator": "[Clue] Open Simulator",

‎src/constants.ts

+26-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ export const CONSTANTS = {
3535
MICROBIT: "micro:bit",
3636
CLUE: "CLUE",
3737
},
38+
DEVICE_NAME_FORMAL: {
39+
CPX: "Circuit Playground Express",
40+
MICROBIT: "micro:bit",
41+
CLUE: "CLUE",
42+
},
3843
ERROR: {
3944
BAD_PYTHON_PATH:
4045
'Your interpreter is not pointing to a valid Python executable. Please select a different interpreter (CTRL+SHIFT+P and type "python.selectInterpreter") and restart the application',
@@ -88,12 +93,16 @@ export const CONSTANTS = {
8893
),
8994
NO_DEVICE: localize(
9095
"error.noDevice",
91-
"No plugged in boards detected. Please double check if your board is connected and/or properly formatted"
96+
"The device is not detected. Please double check if your board is connected and/or properly formatted"
9297
),
9398
NO_FILE_TO_RUN: localize(
9499
"error.noFileToRun",
95100
'[ERROR] We can\'t find a Python file to run. Please make sure you select or open a new ".py" code file, or use the "New File" command to get started and see useful links.\n'
96101
),
102+
NO_FILE_TO_DEPLOY: localize(
103+
"error.noFileToDeploy",
104+
"[ERROR] We can't find a Python file to deploy to your device.\n"
105+
),
97106
NO_FOLDER_OPENED: localize(
98107
"error.noFolderCreated",
99108
"In order to use the Serial Monitor, you need to open a folder and reload VS Code."
@@ -189,6 +198,10 @@ export const CONSTANTS = {
189198
"info.newFile",
190199
"New to Python or the Circuit Playground Express? We are here to help!"
191200
),
201+
NO_DEVICE_CHOSEN_TO_DEPLOY_TO: localize(
202+
"info.noDeviceChosenToDeployTo",
203+
"\n[INFO] No device was selected to deploy to.\n"
204+
),
192205
OPENED_SERIAL_PORT: (port: string) => {
193206
return localize(
194207
"info.openedSerialPort",
@@ -243,8 +256,9 @@ export const CONSTANTS = {
243256
DOWNLOAD_PYTHON: "https://www.python.org/downloads/",
244257
EXAMPLE_CODE:
245258
"https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/tree/master/examples",
246-
HELP:
259+
CPX_HELP:
247260
"https://learn.adafruit.com/adafruit-circuit-playground-express/circuitpython-quickstart",
261+
CLUE_HELP: "https://learn.adafruit.com/adafruit-clue/circuitpython",
248262
INSTALL:
249263
"https://github.com/microsoft/vscode-python-devicesimulator/blob/dev/docs/install.md",
250264
PRIVACY: "https://www.adafruit.com/privacy",
@@ -335,6 +349,8 @@ export enum TelemetryEventName {
335349
MICROBIT_COMMAND_NEW_FILE = "MICROBIT.COMMAND.NEW.FILE",
336350
MICROBIT_COMMAND_OPEN_SIMULATOR = "MICROBIT.COMMAND.OPEN.SIMULATOR",
337351

352+
CLUE_COMMAND_DEPLOY_DEVICE = "CLUE.COMMAND.DEPLOY.DEVICE",
353+
338354
// Simulator interaction
339355
CPX_SIMULATOR_BUTTON_A = "CPX.SIMULATOR.BUTTON.A",
340356
CPX_SIMULATOR_BUTTON_B = "CPX.SIMULATOR.BUTTON.B",
@@ -362,6 +378,8 @@ export enum TelemetryEventName {
362378
CPX_CLICK_DIALOG_HELP_DEPLOY_TO_DEVICE = "CPX.CLICK.DIALOG.HELP.DEPLOY.TO.DEVICE",
363379
CPX_CLICK_DIALOG_TUTORIALS = "CPX.CLICK.DIALOG.TUTORIALS",
364380

381+
CLUE_CLICK_DIALOG_HELP_DEPLOY_TO_DEVICE = "CLUE.CLICK.DIALOG.HELP.DEPLOY.TO.DEVICE",
382+
365383
ERROR_PYTHON_PROCESS = "ERROR.PYTHON.PROCESS",
366384
CPX_ERROR_COMMAND_NEW_FILE = "CPX.ERROR.COMMAND.NEW.FILE",
367385
CPX_ERROR_DEPLOY_WITHOUT_DEVICE = "CPX.ERROR.DEPLOY.WITHOUT.DEVICE",
@@ -373,6 +391,10 @@ export enum TelemetryEventName {
373391
MICROBIT_ERROR_PYTHON_DEVICE_PROCESS = "MICROBIT.ERROR.PYTHON.DEVICE.PROCESS",
374392
MICROBIT_SUCCESS_COMMAND_DEPLOY_DEVICE = "MICROBIT.SUCCESS.COMMAND.DEPLOY.DEVICE",
375393

394+
CLUE_ERROR_DEPLOY_WITHOUT_DEVICE = "CLUE.ERROR.DEPLOY.WITHOUT.DEVICE",
395+
CLUE_ERROR_PYTHON_DEVICE_PROCESS = "CLUE.ERROR.PYTHON.DEVICE.PROCESS",
396+
CLUE_SUCCESS_COMMAND_DEPLOY_DEVICE = "CLUE.SUCCESS.COMMAND.DEPLOY.DEVICE",
397+
376398
// Performance
377399
CPX_PERFORMANCE_DEPLOY_DEVICE = "CPX.PERFORMANCE.DEPLOY.DEVICE",
378400
CPX_PERFORMANCE_NEW_FILE = "CPX.PERFORMANCE.NEW.FILE",
@@ -382,6 +404,8 @@ export enum TelemetryEventName {
382404
MICROBIT_PERFORMANCE_NEW_FILE = "MICROBIT.PERFORMANCE.NEW.FILE",
383405
MICROBIT_PERFORMANCE_OPEN_SIMULATOR = "MICROBIT.PERFORMANCE.OPEN.SIMULATOR",
384406

407+
CLUE_PERFORMANCE_DEPLOY_DEVICE = "CLUE.PERFORMANCE.DEPLOY.DEVICE",
408+
385409
// Venv options
386410
SETUP_VENV_CREATION_ERR = "SETUP.VENV.CREATION.ERR",
387411
SETUP_NO_PIP = "SETUP.NO.PIP",

‎src/device.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ def __init__(self, name, file_path):
2222
self.connected = False
2323
self.error_message = None
2424

25-
def find_cpx_directory(self):
25+
def find_adafruit_device_directory(self):
2626
"""
27-
Check if the Circuit Playground Express is available/plugged in
27+
Check if the Adafruit Device is available/plugged in
2828
"""
2929
found_directory = None
3030

@@ -39,7 +39,7 @@ def find_cpx_directory(self):
3939
)
4040
for mount in mounted:
4141
drive_path = mount.split()[2] if mount else ""
42-
if drive_path.endswith(CONSTANTS.CPX_DRIVE_NAME):
42+
if drive_path.endswith(CONSTANTS.ADAFRUIT_DRIVE_NAME):
4343
found_directory = drive_path
4444
break
4545
elif sys.platform == CONSTANTS.WINDOWS_OS:
@@ -48,7 +48,7 @@ def find_cpx_directory(self):
4848
drive_path = "{}:{}".format(drive_letter, os.sep)
4949
if os.path.exists(drive_path):
5050
drive_name = win32api.GetVolumeInformation(drive_path)[0]
51-
if drive_name == CONSTANTS.CPX_DRIVE_NAME:
51+
if drive_name == CONSTANTS.ADAFRUIT_DRIVE_NAME:
5252
found_directory = drive_path
5353
break
5454
else:
@@ -57,16 +57,16 @@ def find_cpx_directory(self):
5757
if not found_directory:
5858
self.connected = False
5959
self.error_message = (
60-
CONSTANTS.NO_CPX_DETECTED_ERROR_TITLE,
61-
CONSTANTS.NO_CPX_DETECTED_ERROR_DETAIL.format(sys.platform),
60+
CONSTANTS.NO_ADAFRUIT_DEVICE_DETECTED_ERROR_TITLE,
61+
CONSTANTS.NO_ADAFRUIT_DEVICE_DETECTED_ERROR_DETAIL.format(sys.platform),
6262
)
6363
else:
6464
self.connected = True
6565
self.error_message = None
6666
return found_directory
6767

68-
def deployToCPX(self):
69-
device_directory = self.find_cpx_directory()
68+
def deployToAdafruitDevice(self):
69+
device_directory = self.find_adafruit_device_directory()
7070
if self.error_message:
7171
print(
7272
"{}:\t{}".format(self.error_message[0], self.error_message[1]),
@@ -109,8 +109,8 @@ def deployToMicrobit(self):
109109
def deploy(self):
110110
if self.name == CONSTANTS.MICROBIT:
111111
return self.deployToMicrobit()
112-
elif self.name == CONSTANTS.CPX:
113-
return self.deployToCPX()
112+
elif self.name == CONSTANTS.CPX or self.name == CONSTANTS.CLUE:
113+
return self.deployToAdafruitDevice()
114114
else:
115115
return {"type": "no-device"}
116116

0 commit comments

Comments
 (0)