feat: --interactive flag

Redirects stdin into the simulated serial port

Related: espressif/pytest-embedded#233

Author: urish

src/APIClient.ts

@@ -1,4 +1,5 @@
 import { WebSocket } from 'ws';
+import { Writable } from 'stream';
 import type {
   APICommand,
   APIError,
@@ -156,6 +157,19 @@ export class APIClient {
     });
   }
 
+  serialMonitorWritable() {
+    return new Writable({
+      write: (chunk, encoding, callback) => {
+        if (typeof chunk === 'string') {
+          chunk = Buffer.from(chunk, encoding);
+        }
+        this.serialMonitorWrite(chunk).then(() => {
+          callback(null);
+        }, callback);
+      },
+    });
+  }
+
   async framebufferRead(partId: string) {
     return await this.sendCommand<{ png: string }>('framebuffer:read', {
       id: partId,

src/help.ts

@@ -12,6 +12,7 @@ export function cliHelp() {
       {green --expect-text} <string>      Expect the given text in the output
       {green --fail-text} <string>        Fail if the given text is found in the output
       {green --elf} <path>                ELF file to simulate (default: read from wokwi.toml)
+      {green --interactive}               Redirect stdin to the simulated serial port
       {green --scenario} <path>           Run the given scenario (yaml) file, path is relative to project root
       {green --serial-log-file} <path>    Save the serial monitor output to the given file
       {green --screenshot-part} <string>  Take a screenshot of the given part id (from diagram.json)

src/main.ts

@@ -29,6 +29,7 @@ async function main() {
       '--elf': String,
       '--expect-text': String,
       '--fail-text': String,
+      '--interactive': Boolean,
       '--serial-log-file': String,
       '--scenario': String,
       '--screenshot-part': String,
@@ -46,6 +47,7 @@ async function main() {
   const elf = args['--elf'];
   const expectText = args['--expect-text'];
   const failText = args['--fail-text'];
+  const interactive = args['--interactive'];
   const serialLogFile = args['--serial-log-file'];
   const scenarioFile = args['--scenario'];
   const timeout = args['--timeout'] ?? 30000;
@@ -255,6 +257,10 @@ async function main() {
       pause: timeToNextEvent >= 0,
     });
 
+    if (interactive) {
+      process.stdin.pipe(client.serialMonitorWritable());
+    }
+
     if (timeToNextEvent > 0) {
       await client.simResume(timeToNextEvent);
     }