feat(demo): add "--image" and "--gdb" args (#116)

Author: BrianPugh

README.md

@@ -35,9 +35,17 @@ npm install
 npm run start:micropython
 ```
 
-and enjoy the MicroPython REPL! Quit the REPL with Ctrl+X.
+and enjoy the MicroPython REPL! Quit the REPL with Ctrl+X. A different UF2 image can be loaded by supplying the `--image` option:
 
-You can replace rp2-pico-20210902-v1.17.uf2 with any recent MicroPython or CircuitPython release built for the RP2040.
+```
+npm run start:micropython -- --image=my_image.uf2
+```
+
+A GDB server on port 3333 can be enabled by specifying the `--gdb` flag:
+
+```
+npm run start:micropython -- --gdb
+```
 
 With MicroPython – and probably also CircuitPython – you can use the filesystem on the Pico. This becomes useful as more than one script file is used in your code. Just put a [LittleFS](https://github.com/littlefs-project/littlefs) formatted filesystem image called `littlefs.img` into the rp2040js root directory, and your `main.py` will be automatically started from there.
 

demo/micropython-run.ts

@@ -5,20 +5,31 @@ import { ConsoleLogger, LogLevel } from '../src/utils/logging';
 import { bootromB1 } from './bootrom';
 import { loadUF2, loadMicropythonFlashImage } from './load-flash';
 import fs from 'fs';
+import minimist from 'minimist';
+
+const args = minimist(process.argv.slice(2), {
+  string: 'image', // UF2 image to load; defaults to "rp2-pico-20210902-v1.17.uf2"
+  boolean: 'gdb', // start GDB server on 3333
+});
 
 const mcu = new RP2040();
 mcu.loadBootrom(bootromB1);
 mcu.logger = new ConsoleLogger(LogLevel.Error);
-loadUF2('rp2-pico-20210902-v1.17.uf2', mcu);
+
+const imageName = args.image ?? 'rp2-pico-20210902-v1.17.uf2';
+console.log(`Loading uf2 image ${imageName}`);
+loadUF2(imageName, mcu);
 
 if (fs.existsSync('littlefs.img')) {
   loadMicropythonFlashImage('littlefs.img', mcu);
   // Instead of reading from file, it would also be possible to generate the LittleFS image on-the-fly here, e.g. using
   // https://github.com/wokwi/littlefs-wasm or https://github.com/littlefs-project/littlefs-js
 }
 
-const gdbServer = new GDBTCPServer(mcu, 3333);
-console.log(`RP2040 GDB Server ready! Listening on port ${gdbServer.port}`);
+if (args.gdb) {
+  const gdbServer = new GDBTCPServer(mcu, 3333);
+  console.log(`RP2040 GDB Server ready! Listening on port ${gdbServer.port}`);
+}
 
 const cdc = new USBCDC(mcu.usbCtrl);
 cdc.onDeviceConnected = () => {

package-lock.json

@@ -39,13 +39,15 @@
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",
+    "@types/minimist": "^1.2.2",
     "@types/node": "^14.14.22",
     "@typescript-eslint/eslint-plugin": "^4.22.1",
     "@typescript-eslint/parser": "^4.22.1",
     "eslint": "^7.26.0",
     "husky": "^6.0.0",
     "jest": "^27.5.1",
     "lint-staged": "^11.0.0",
+    "minimist": "^1.2.7",
     "prettier": "^2.2.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.1.3",