feat(init): ask about serial interface: uart/usb/usb-serialjtag

Author: urish

src/project/boards.ts

@@ -1,11 +1,20 @@
 export type BoardFamily = 'esp32' | 'rp2' | 'stm32';
 
+export type SerialInterface = 'uart' | 'usb' | 'usb-serialjtag';
+
+export const serialInterfaces: Record<SerialInterface, string> = {
+  uart: 'UART',
+  usb: 'USB',
+  'usb-serialjtag': 'USB Serial/JTAG',
+};
+
 export interface IBoard {
   title: string;
   type: string;
   family: BoardFamily;
   idfTarget?: string;
   serialPins?: { RX: string; TX: string };
+  serialInterfaces?: SerialInterface[];
 }
 
 export interface IFamilyInfo {
@@ -21,37 +30,43 @@ export const boards: IBoard[] = [
     type: 'board-esp32-c3-devkitm-1',
     family: 'esp32',
     idfTarget: 'esp32c3',
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
   {
     title: 'ESP32-C6 DevKit',
     type: 'board-esp32-c6-devkitc-1',
     family: 'esp32',
     idfTarget: 'esp32c6',
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
   {
     title: 'ESP32-H2 DevKit',
     type: 'board-esp32-h2-devkitm-1',
     family: 'esp32',
     idfTarget: 'esp32h2',
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
   {
     title: 'ESP32-P4-Function-EV-Board',
     type: 'board-esp32-p4-function-ev',
     family: 'esp32',
     idfTarget: 'esp32p4',
     serialPins: { RX: '38', TX: '37' },
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
   {
     title: 'ESP32-S2 DevKit',
     type: 'board-esp32-s2-devkitm-1',
     family: 'esp32',
     idfTarget: 'esp32s2',
+    serialInterfaces: ['uart', 'usb'],
   },
   {
     title: 'ESP32-S3 DevKit',
     type: 'board-esp32-s3-devkitc-1',
     family: 'esp32',
     idfTarget: 'esp32s3',
+    serialInterfaces: ['uart', 'usb', 'usb-serialjtag'],
   },
 
   // ESP32-based boards
@@ -60,33 +75,44 @@ export const boards: IBoard[] = [
     type: 'board-esp32-c3-rust-1',
     family: 'esp32',
     serialPins: { RX: '20', TX: '21' },
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
   {
     title: 'ESP32-S3-BOX',
     type: 'board-esp32-s3-box',
     family: 'esp32',
     serialPins: { RX: 'G44', TX: 'G43' },
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
   {
     title: 'ESP32-S3-BOX-3',
     type: 'board-esp32-s3-box-3',
     family: 'esp32',
     serialPins: { RX: 'G44', TX: 'G43' },
+    serialInterfaces: ['uart', 'usb-serialjtag'],
+  },
+  {
+    title: 'M5Stack CoreS3',
+    type: 'board-m5stack-core-s3',
+    family: 'esp32',
+    serialPins: { RX: 'G44', TX: 'G43' },
+    serialInterfaces: ['uart', 'usb-serialjtag'],
   },
-  { title: 'M5Stack CoreS3', type: 'board-m5stack-core-s3', family: 'esp32' },
 
   // RP2040-based boards
   {
     title: 'Raspberry Pi Pico',
     type: 'wokwi-pi-pico',
     family: 'rp2',
     serialPins: { RX: 'GP1', TX: 'GP0' },
+    serialInterfaces: ['uart', 'usb'],
   },
   {
     title: 'Raspberry Pi Pico W',
     type: 'board-pi-pico-w',
     family: 'rp2',
     serialPins: { RX: 'GP1', TX: 'GP0' },
+    serialInterfaces: ['uart', 'usb'],
   },
 
   // STM32 boards

src/project/createDiagram.ts

@@ -1,18 +1,26 @@
-import { families, type IBoard } from './boards.js';
+import { families, type IBoard, type SerialInterface } from './boards.js';
 
-export function createDiagram(board: IBoard) {
+export function createDiagram(board: IBoard, serialInterface?: SerialInterface) {
   const familyInfo = families[board.family];
   const serialPins = board.serialPins ?? { RX: 'RX', TX: 'TX' };
+  const attrs: Record<string, string> = {};
   const mcuPartId = familyInfo.mcuPartId;
 
+  const connections: Array<[string, string, string]> = [];
+  if (!serialInterface || serialInterface === 'uart') {
+    connections.push(
+      [`${mcuPartId}:${serialPins.TX}`, '$serialMonitor:RX', ''],
+      [`${mcuPartId}:${serialPins.RX}`, '$serialMonitor:TX', ''],
+    );
+  } else if (serialInterface === 'usb-serialjtag') {
+    attrs.serialInterface = 'USB_SERIAL_JTAG';
+  }
+
   return {
     version: 1,
     author: 'Uri Shaked',
     editor: 'wokwi',
-    parts: [{ type: board.type, id: mcuPartId }],
-    connections: [
-      [`${mcuPartId}:${serialPins.TX}`, '$serialMonitor:RX', ''],
-      [`${mcuPartId}:${serialPins.RX}`, '$serialMonitor:TX', ''],
-    ],
+    parts: [{ type: board.type, id: mcuPartId, attrs }],
+    connections,
   };
 }

src/project/initProjectWizard.ts

@@ -3,7 +3,7 @@ import chalkTemplate from 'chalk-template';
 import { existsSync, mkdirSync, writeFileSync } from 'fs';
 import path from 'path';
 import { createWokwiToml } from '../WokwiConfig.js';
-import { boards, families } from './boards.js';
+import { boards, families, type SerialInterface, serialInterfaces } from './boards.js';
 import { createDiagram } from './createDiagram.js';
 import { findFirmwarePath } from './findFirmwarePath.js';
 import { detectProjectType } from './projectType.js';
@@ -98,6 +98,22 @@ export async function initProjectWizard(rootDir: string, opts: { diagramFile?: s
     elfPath = elfPathResponse;
   }
 
+  let serialInterface: SerialInterface | undefined;
+  if (board.serialInterfaces?.length) {
+    const serialInterfaceResponse = await select({
+      message: 'Select the serial interface to use:',
+      options: board.serialInterfaces.map((item) => ({
+        value: item,
+        label: serialInterfaces[item],
+      })),
+    });
+    if (isCancel(serialInterface)) {
+      cancel('Operation cancelled.');
+      process.exit(0);
+    }
+    serialInterface = serialInterfaceResponse as SerialInterface;
+  }
+
   let vsCodeDebug: boolean = false;
   if (projectType === 'esp-idf') {
     const vsCodeDebugAnswer = await confirm({
@@ -131,7 +147,7 @@ export async function initProjectWizard(rootDir: string, opts: { diagramFile?: s
   );
 
   log.info(`Writing diagram.json...`);
-  writeFileSync(diagramFilePath, JSON.stringify(createDiagram(board), null, 2));
+  writeFileSync(diagramFilePath, JSON.stringify(createDiagram(board, serialInterface), null, 2));
 
   if (vsCodeDebug) {
     log.info(`Writing .vscode/launch.json...`);