Merge pull request #268 from pycom/next-staging

Next staging

Author: Jakob Rosenberg

GET_STARTED.md

@@ -2,10 +2,10 @@
 
 1. First [download and install Visual Studio Code](https://code.visualstudio.com/).
 2. Install the [Pymakr VSCode Extension](https://marketplace.visualstudio.com/items?itemName=pycom.Pymakr)
-    
-    _(We're installing the preview, but once the project reaches "stable" we'll, be using the regular extension.)_
 
-    <img src="./media/readme/install-pymakr.gif" />
+   _(We're installing the preview, but once the project reaches "stable" we'll, be using the regular extension.)_
+
+   <img src="./media/readme/install-pymakr.gif" />
 
 3. That's it! You've installed the Pymakr Extension for VSCode
 
@@ -35,27 +35,30 @@ Once the project is ready to run, it needs to be uploaded to a device.
 
 To speed up development, you can put a project in `development mode`.
 
-In development mode, Pymakr automatically propagates file changes in and restarts the main script.
+In development mode, Pymakr automatically propagates local file changes to connected devices and then restarts the main script.
 
 Dev mode can be configured in `pymakr.json`
+
 ```json
 {
-    "onUpdate": "restartScript" | "softRestartDevice" | "hardRestartDevice"
+  "onUpdate": "restartScript" | "softRestartDevice" | "hardRestartDevice"
 }
 ```
 
 **onUpdate:** Action to be called once file changes have been propagated.
+
 - **restartScript** Clears the `main.py` module as well as any changed modules. Then imports `boot.py` and `main.py`.
 - **softRestartDevice** Performs <kbd>ctrl + d</kbd>
 - **hardRestartDevice** Performs `machine.reset()`
 
 #### NOTE
-*`machine.sleep` and `machine.deepsleep` do not work in development since they stop the USB connection.*
+
+_`machine.sleep` and `machine.deepsleep` do not work in development since they stop the USB connection._
 
 ---
 
 ## Hint: Organizing your setup
 
 Having to switch between different tabs can be cumbersome. To solve this, you can drag your devices and projects to the file explorer view.
 
-![](./media/readme/move-view.gif)
+![](./media/readme/move-view.gif)

package-lock.json

@@ -358,6 +358,16 @@
       }
     ],
     "commands": [
+      {
+        "command": "pymakr.showDebugMenu",
+        "title": "Shows debugging menu",
+        "category": "PyMakr"
+      },
+      {
+        "command": "pymakr.openOnDevice",
+        "title": "Open file on device",
+        "category": "PyMakr"
+      },
       {
         "command": "pymakr.logState",
         "title": "[DEBUG] Logs current state to the terminal",
@@ -776,6 +786,11 @@
         {
           "command": "pymakr.uploadPrompt",
           "group": "pymakr"
+        },
+        {
+          "command": "pymakr.openOnDevice",
+          "group": "pymakr",
+          "when": "resourceScheme == file"
         }
       ],
       "pymakr.explorerContextMenu": [
@@ -792,6 +807,11 @@
         {
           "command": "pymakr.uploadPrompt",
           "group": "pymakr"
+        },
+        {
+          "command": "pymakr.openOnDevice",
+          "group": "pymakr",
+          "when": "resourceScheme == file"
         }
       ],
       "view/item/context": [
@@ -928,7 +948,7 @@
     "cheap-watch": "^1.0.4",
     "consolite": "^0.3.8",
     "hookar": "^0.0.7-0",
-    "micropython-ctl-cont": "^1.14.3",
+    "micropython-ctl-cont": "^1.15.3",
     "picomatch": "^2.3.1",
     "prompts": "^2.4.2",
     "serialport": "^10.4.0"

package.json

@@ -71,6 +71,25 @@
           "type": "boolean",
           "default": false
         },
+        "uploadOnDevStart": {
+          "description": "Uploads project to device when dev mode is started.",
+          "type": "string",
+          "default": "outOfSync",
+          "anyOf": [
+            {
+              "const": "always",
+              "description": "Will upload the project to all connected devices."
+            },
+            {
+              "const": "never",
+              "description": "Will not upload project to any devices."
+            },
+            {
+              "const": "outOfSync",
+              "description": "Will upload the project to any connected device that is detected to be out of sync."
+            }
+          ]
+        },
         "onUpdate": {
           "description": "Action to run after file changes have been propagates",
           "type": "string",

pymakr.schema.json

@@ -118,6 +118,15 @@ class Device {
     subscribe(() => this.onChanged());
 
     this.busy.subscribe((val) => this.log.debugShort(val ? "busy..." : "idle."));
+    this.busy.subscribe(
+      (isBusy) =>
+        !isBusy &&
+        this.adapter.__proxyMeta.isBusy &&
+        this.log.error(
+          "Device is not busy, but the adapter queue is active. Current task:",
+          [...this.adapter.__proxyMeta.history].pop()
+        )
+    );
 
     this.readUntil = createReadUntil();
     this.readUntil(/\n>>> [^\n]*$/, (matches) => this.busy.set(!matches), { callOnFalse: true });
@@ -187,7 +196,7 @@ class Device {
         }
       });
       // resetting the device should also reset the waiting calls
-      this.adapter.__proxyMeta.reset();
+      [...this.adapter.__proxyMeta.history].pop().promise.finally(() => this.adapter.__proxyMeta.reset());
       this.log.info("send \\x06 (safeboot)");
       this.adapter.sendData("\x06"); // safeboot
     });
@@ -231,7 +240,7 @@ class Device {
    */
   async runScript(script, options) {
     options = Object.assign({}, runScriptDefaults, options);
-    this.log.debug(`runScript:\n\n${script}\n\n`);
+    this.log.debug(`queued runScript:\n\n${script}\n\n`);
     this.busy.set(true);
     const start = Date.now();
     const result = await this.adapter.runScript(script + "\n\r\n\r\n", options);
@@ -244,6 +253,17 @@ class Device {
     return result;
   }
 
+  /**
+   * Run a Python user script on this device
+   * Running user scripts sets device.action to null. This ensures that they're shown correctly in the GUI.
+   * @param {string} script
+   * @param {import("micropython-ctl-cont").RunScriptOptions=} options
+   */
+  async runUserScript(script, options) {
+    script = "# user script\n" + script;
+    this.runScript(script, options);
+  }
+
   /**
    * Creates a MicroPythonDevice
    */
@@ -252,10 +272,11 @@ class Device {
 
     // We need to wrap the rawAdapter in a blocking proxy to make sure commands
     // run in sequence rather in in parallel. See JSDoc comment for more info.
-    const adapter = createBlockingProxy(rawAdapter, { exceptions: ["sendData", "connectSerial"] });
+    const adapter = createBlockingProxy(rawAdapter, { exceptions: ["sendData", "connectSerial", "getState"] });
     adapter.__proxyMeta.beforeEachCall(({ item }) => {
       this.action.set(item.field.toString());
       this.busy.set(true);
+      if (item.field.toString() === "runScript" && item.args[0].startsWith("# user script\n")) this.action.set(null);
     });
 
     // emit line break to trigger a `>>>`. This triggers the `busyStatusUpdater`
@@ -382,8 +403,8 @@ class Device {
           if (!this.config.rootPath) this.config = { ...this.config, rootPath: await this.getRootPath() };
           await this.updatePymakrConf();
           this.state.stale = false;
-          this.busy.set(false);
-          resolve();
+          // busy could be truish as vscode could be trying to access a file
+          this.busy.when(false).then(resolve);
         }
       });
 
@@ -423,20 +444,26 @@ class Device {
   }
 
   /**
-   * @param {number} retries
+   *
+   * @param {number} safeBootAfterNumRetries attempt to safe boot on each retry after n failed ctrl + c attempts
+   * @param {number} retries how many times to attempt to send ctrl + c and ctrl + f
+   * @param {number} retryInterval how long to wait between each retry
+   * @returns
    */
-  stopScript(retries = 10, retryInterval = 500) {
-    this.log.debug("stop script");
+  stopScript(safeBootAfterNumRetries = 2, retries = 10, retryInterval = 500) {
+    this.log.debug("stop script", { safeBootAfterNumRetries, retries, retryInterval });
     return new Promise((resolve, reject) => {
       if (this.busy.get()) {
         let counter = 0;
         const intervalHandle = setInterval(() => {
           if (counter >= retries) {
             clearInterval(intervalHandle);
+            this.log.debug("ctrl + c failed. Attempting soft reboot (ctrl + f)");
             reject(`timed out after ${retries} retries in ${(retries * retryInterval) / 1000}s`);
           } else {
             counter++;
-            this.adapter.sendData("\x03");
+            const cmd = counter > safeBootAfterNumRetries ? "\x06\x03" : "\x03";
+            this.adapter.sendData(cmd);
             this.log.log(`retry stop script (${counter})`);
           }
         }, retryInterval);
@@ -447,9 +474,9 @@ class Device {
             clearInterval(intervalHandle);
           }
         });
-        this.adapter.sendData("\x03");
+        const cmd = safeBootAfterNumRetries == 0 ? "\x06\x03" : "\x03";
+        this.adapter.sendData(cmd);
       } else {
-        this.adapter.sendData("\x03");
         resolve();
       }
     });
@@ -475,10 +502,14 @@ class Device {
    * @param {{
    *   onScanComplete: (files: string[]) => void,
    *   onUpload: (file: string) => void,
+   *   transform: (id: string, body: string) => string
    * }} options
    */
   async upload(source, destination, options) {
-    destination = posix.join(this.config.rootPath, `/${destination}`.replace(/\/+/g, "/"));
+    this.log.debug("upload", source, "to", destination);
+    destination = posix.join(this.config.rootPath, destination.replace(/[\/\\]+/g, "/"));
+    await this.adapter.mkdirs(dirname(destination));
+
     const root = source;
     const ignores = [...this.pymakr.config.get().get("ignore")];
     const pymakrConfig = getNearestPymakrConfig(source);
@@ -491,7 +522,11 @@ class Device {
 
     const _uploadFile = async (file, destination) => {
       this.log.traceShort("uploadFile", file, "to", destination);
-      const data = Buffer.from(readFileSync(file));
+
+      const data = options.transform
+        ? Buffer.from(options.transform(file, readFileSync(file, "utf-8")))
+        : Buffer.from(readFileSync(file));
+
       return this.adapter.putFile(destination, data, { checkIfSimilarBeforeUpload: true });
     };
 

src/Device.js

@@ -37,6 +37,7 @@ class Project {
       this.err = `Could not parse config: ${this.configFile.fsPath}`;
       this.pymakr.log.error("could not parse config:", this.configFile.fsPath);
       this.pymakr.notifier.notifications.couldNotParsePymakrConfig(this);
+      return {};
     }
   }