feat: option to simulate machine.[deep]sleep in devmode (wip / experimental)

Author: jakobrosenberg

src/Watcher/DeviceManager.js

@@ -1,4 +1,5 @@
-const { removeOverlappingInstructions } = require("./utils");
+const { scripts } = require("./scripts");
+const { removeOverlappingInstructions, fakeDeepSleep } = require("./utils");
 
 /**
  * @typedef {'change'|'create'|'delete'} FileAction
@@ -19,6 +20,7 @@ class DeviceManager {
     this.project = this.watcher.project;
     this.pymakr = this.project.pymakr;
     this.log = watcher.log.createChild(device.name);
+    this.bootPyIsOutdated = true;
 
     /** @type {FileInstruction[]} */
     this.fileInstructions = [];
@@ -35,6 +37,31 @@ class DeviceManager {
     return uploadWhen === "always" || (uploadWhen === "outOfSync" && this.outOfSync);
   }
 
+  async ensureBootPy() {
+    const prependStr = [
+      "# EDIT BY PYMAKR DEV",
+      "# The below script is used by Pymakr in dev mode",
+      "# To remove it, disable dev mode and reupload the project.",
+      "",
+      scripts.importFakeMachine(),
+      "",
+      "# END OF EDIT BY PYMAKR DEV",
+      "",
+    ].join("\n");
+
+    // todo pseudo code
+    const files = await this.device.adapter.listFiles();
+    if (!files.map((file) => file.filename).includes("boot.py"))
+      await this.device.adapter.putFile("boot.py", Buffer.from(prependStr));
+    else {
+      const content = (await this.device.adapter.getFile("boot.py")).toString();
+
+      if (!content.match(prependStr)) {
+        this.device.adapter.putFile("boot.py", Buffer.from(prependStr + content));
+      }
+    }
+  }
+
   async uploadProjectIfNeeded() {
     if (!this.device.adapter.__proxyMeta.target.isConnected()) return;
 
@@ -44,6 +71,11 @@ class DeviceManager {
       await this.device.pymakr.commands.uploadProject({ device: this.device, project: this.project });
   }
 
+  async uploadPymakrDev() {
+    console.log("uploading pymakr dev");
+    return this.pymakr.commands.upload({ fsPath: __dirname + "/_pymakr_dev" }, this.device, "_pymakr_dev");
+  }
+
   /**
    * Send a change/create/delete file instruction to the device
    * @param {FileInstruction} fileInstruction
@@ -67,14 +99,26 @@ class DeviceManager {
     if (this.fileInstructions.length) await this.handleNewInstructions();
   }
 
+  async installDevTools() {
+    await this.device.runScript('print("[dev] uploading Pymakr devtools")');
+    await this.uploadPymakrDev();
+    await this.device.runScript('print("[dev] patching boot.dev")');
+    await this.ensureBootPy();
+    this.bootPyIsOutdated = false;
+  }
+
+  shouldInstallDevTools() {
+    return this.project.config.dev?.simulateDeepSleep && this.bootPyIsOutdated;
+  }
+
   /**
    * Stops the current running script, performs file changes and restarts the device or main script
    */
   async updateAndRestart() {
     const modulesToDelete = ["main.py"];
 
     this.log.debug("stop script");
-    await this.device.pymakr.commands.stopScript({ device: this.device });
+    await this.device.pymakr.commands.stopScript({ device: this.device }, 0);
 
     this.log.debug("run instructions");
     // Loop to make sure we get all instructions before we reset.
@@ -84,12 +128,14 @@ class DeviceManager {
       this.fileInstructions.length = 0;
       for (const instruction of instructions) modulesToDelete.push(await this.runInstruction(instruction));
     }
-    console.log("copying", __dirname + "/fakemachine.py");
-    await this.pymakr.commands.upload({ fsPath: __dirname + "/fakemachine.py" }, this.device, "fakemachine.py");
 
-    /** @type {'restartScript'|'softRestartDevice'|'hardRestartDevice'} */
-    const onUpdate = this.project.config?.dev?.onUpdate || "restartScript";
-    await this[onUpdate](modulesToDelete);
+    const installDevTools = this.shouldInstallDevTools();
+
+    /** @type {'restartScript'|'softRestartDevice'|'hardRestartDevice'|'installDevToolsAndRestart'} */
+    const restartScript = installDevTools ? "hardRestartDevice" : this.project.config.dev?.onUpdate || "restartScript";
+
+    if (installDevTools) await this.installDevTools();
+    await this[restartScript](modulesToDelete);
 
     await new Promise((resolve) => setTimeout(resolve, 500));
   }
@@ -116,15 +162,14 @@ class DeviceManager {
    */
   async runInstruction({ file, action }) {
     this.log.debug("run instruction", { file, action });
-    const target = require("path").relative(this.watcher.project.folder, file).replace(/\\/g, "/");
-
-    // // todo remove promise
-    // await new Promise((resolve) => setTimeout(resolve, 100));
-    if (action === "delete") {
-      await this.device.remove(target);
-    } else {
-      await this.pymakr.commands.upload({ fsPath: file }, this.device, target);
+    const target = require("path").relative(this.project.folder, file).replace(/\\/g, "/");
+    if (target === "boot.py") {
+      this.bootPyIsOutdated = true;
     }
+
+    if (action === "delete") await this.device.remove(target);
+    else await this.pymakr.commands.upload({ fsPath: file }, this.device, target, fakeDeepSleep);
+
     return target;
   }
 }

src/Watcher/_pymakr_dev/fake_machine.py

@@ -0,0 +1,22 @@
+import time
+import machine
+
+
+def sleep(msTime):
+    print('fake_machine.sleep start')
+    time.sleep(msTime/1000)
+    print('fake_machine.sleep end')
+    # send an exit rawRepl command
+    print('\x04\x04>')
+    time.sleep(0.1)
+    machine.reset()
+
+
+def deepSleep(msTime):
+    print('fake_machine.deepSleep start')
+    time.sleep(msTime/1000)
+    print('fake_machine.deepSleep end')
+    # send an exit rawRepl command
+    print('\x04\x04>')
+    time.sleep(0.1)
+    machine.reset()

src/Watcher/scripts.js

@@ -1,17 +1,15 @@
 const rmDoubleSlash = (str) => str.replace(/\/+/, "/");
 
 const scripts = {
-  addPymakrToPath: (rootPath) =>
+  importFakeMachine: () =>
     [
+      'print("[dev] Importing fake_machine")',
       "import sys",
-      "try:",
-      `  sys.path.index('${rmDoubleSlash(rootPath + "/_pymakr_dev")}')`,
-      "except Exception as e:",
-      "  if(e.args[0] == 'object not in sequence'):",
-      `    sys.path.append('${rmDoubleSlash(rootPath + "/_pymakr_dev")}')`,
-      "  else:",
-      "    raise",
+      'sys.path.append("/flash/_pymakr_dev")',
+      "import fake_machine",
     ].join("\r\n"),
+  checkForSysPath: (rootPath) =>
+    ["import sys", `  sys.path.index('${rmDoubleSlash(rootPath + "/_pymakr_dev")}')`].join("\r\n"),
   restart: (modulesToDelete) =>
     [
       "print('')",

src/Watcher/utils.js

@@ -4,7 +4,7 @@
  */
 const removeOverlappingInstructions = (fileInstructions) => {
   let pool = [...fileInstructions];
-  const newInstructions = []
+  const newInstructions = [];
 
   while (pool.length) {
     const lastInstruction = pool.pop();
@@ -13,7 +13,15 @@ const removeOverlappingInstructions = (fileInstructions) => {
     pool = pool.filter(({ file }) => !file.startsWith(lastInstruction.file));
     if (!shouldRemoveSelf) newInstructions.unshift(lastInstruction);
   }
-  return newInstructions
+  return newInstructions;
 };
 
-module.exports = { removeOverlappingInstructions };
+const fakeDeepSleep = (id, str) =>
+  str
+    .replace(/machine\.sleep/gm, "fake_machine.sleep")
+    .replace(/machine\.deepSleep/gm, "fake_machine.sleep")
+    .replace(/import machine/gm, "import fake_machine")
+    .replace(/from machine import sleep/gm, "from fake_machine import sleep")
+    .replace(/from machine import deepSleep/gm, "from fake_machine import deepSleep");
+
+module.exports = { removeOverlappingInstructions, fakeDeepSleep };