Fix #153 #176, Added executeOnConnect setting

Signed-off-by: paulober <[email protected]>
paulober · Dec 27, 2023 · 61391b2 · 61391b2
1 parent d912ba4
commit 61391b2
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -81,6 +81,7 @@ This extension contributes the following settings:
 * `micropico.statusbarButtons`: Select which buttons to show in the statusbar (DO NOT CHANGE, unless you know what you are doing)
 * `micropico.gcBeforeUpload`: Run garbage collection before uploading files to the board. This will free up some memory usefull when uploading large files but adds about a second or two to the upload process.
 * `micropico.softResetAfterUpload`: Soft-resets your board after any upload action. Usefull if you are developing with `main.py` or `boot.py`.
+* `micropico.executeOnConnect`: Path to a MicroPython script on the Pico to execute on connect. Leave empty to disable. (must be relative to the root of the Pico's filesystem; doesn't need to begin with a slash; overrides `micropico.openOnStart` setting)
 
 ## Extension Context Keys
 

diff --git a/package.json b/package.json
@@ -437,6 +437,14 @@
           "title": "Soft-reset after upload",
           "description": "Soft-resets your board after any upload action which also reruns main.py and boot.py. Usefull when working with main.py and boot.py.",
           "order": 12
+        },
+        "micropico.executeOnConnect": {
+          "type": "string",
+          "default": "",
+          "scope": "resource",
+          "title": "Script to execute on connect",
+          "description": "Path to a MicroPython script on the Pico to execute on connect. Leave empty to disable.",
+          "order": 13
         }
       }
     },

diff --git a/src/activator.mts b/src/activator.mts
@@ -379,7 +379,7 @@ export default class Activator {
 
     disposable = vscode.commands.registerCommand(
       commandPrefix + "remote.run",
-      async () => {
+      async (fileOverride?: string | vscode.Uri) => {
         if (!this.pyb?.isPipeConnected()) {
           void vscode.window.showWarningMessage(
             "Please connect to the Pico first."
@@ -388,7 +388,10 @@ export default class Activator {
           return;
         }
 
-        const file = await getFocusedFile(true);
+        const file =
+          (fileOverride !== undefined && typeof fileOverride === "string"
+            ? fileOverride
+            : undefined) ?? (await getFocusedFile(true));
 
         if (file === undefined) {
           void vscode.window.showWarningMessage(
@@ -404,7 +407,7 @@ export default class Activator {
           "import uos as _pico_uos; " +
             "__pico_dir=_pico_uos.getcwd(); " +
             `_pico_uos.chdir('${dirname(file)}'); ` +
-            `execfile('${file}'); ` +
+            `execfile('${basename(file)}'); ` +
             "_pico_uos.chdir(__pico_dir); " +
             "del __pico_dir; " +
             "del _pico_uos",
@@ -1195,6 +1198,21 @@ export default class Activator {
           // the pyboard wrapper and mark the Pico as disconnected
           await this.pyb?.checkStatus();
           if (this.pyb?.isPipeConnected()) {
+            // ensure that the script is only executed once
+            if (this.ui?.getState() === false) {
+              const scriptToExecute = settings.getString(
+                SettingsKey.executeOnConnect
+              );
+              if (
+                scriptToExecute !== undefined &&
+                scriptToExecute.trim() !== ""
+              ) {
+                void vscode.commands.executeCommand(
+                  commandPrefix + "remote.run",
+                  scriptToExecute
+                );
+              }
+            }
             this.ui?.refreshState(true);
 
             return;

diff --git a/src/settings.mts b/src/settings.mts
@@ -16,6 +16,7 @@ export enum SettingsKey {
   statusbarButtons = "statusbarButtons",
   gcBeforeUpload = "gcBeforeUpload",
   softResetAfterUpload = "softResetAfterUpload",
+  executeOnConnect = "executeOnConnect",
 }
 
 export type Setting = string | boolean | string[] | null | undefined;

diff --git a/src/ui.mts b/src/ui.mts
@@ -27,6 +27,7 @@ export default class UI {
   private visible = false;
   private initialized = false;
   private userOperationOngoing = false;
+  private lastState = false;
 
   private items: { [key: string]: StatusBarItem } = {};
 
@@ -96,13 +97,18 @@ export default class UI {
   }
 
   private setState(connected: boolean): void {
+    this.lastState = connected;
     this.setButton(
       "status",
       connected ? "check" : "chrome-close",
       connected ? "Pico Connected" : "Pico Disconnected"
     );
   }
 
+  public getState(): boolean {
+    return this.lastState;
+  }
+
   public refreshState(force: boolean): void {
     this.setState(force);