fix(init): display correct extension for firmware filename

e.g. .hex for stm32, .uf2 for pi pico

Author: urish

src/esp/idfProjectConfig.ts

@@ -36,7 +36,7 @@ export function createDiagramForIDFProject(
       `Target ${target} is not currently supported by Wokwi. You can create a feature request at https://github.com/wokwi/wokwi-features/issues.`,
     );
   }
-  return createDiagram(board.board);
+  return createDiagram(board);
 }
 
 export interface IDFProjectConfigParams {
@@ -74,7 +74,7 @@ export function idfProjectConfig(params: IDFProjectConfigParams) {
     const diagramContent = readFileSync(diagramFilePath, 'utf8');
     const diagram = JSON.parse(diagramContent);
     const board = findBoard(diagram);
-    const boardInfo = boards.find((b) => b.board === board?.type);
+    const boardInfo = boards.find((b) => b.type === board?.type);
     if (boardInfo && boardInfo.idfTarget !== idfProjectDescription.target) {
       console.error(
         chalkTemplate`{red Error:} The IDF project is targeting {yellow ${idfProjectDescription.target}}, but the diagram is for {yellow ${boardInfo.idfTarget}}.`,

src/project/boards.ts

@@ -1,83 +1,105 @@
+export type BoardFamily = 'esp32' | 'rp2' | 'stm32';
+
 export interface IBoard {
   title: string;
-  board: string;
-  family: string;
+  type: string;
+  family: BoardFamily;
   idfTarget?: string;
   serialPins?: { RX: string; TX: string };
 }
 
+export interface IFamilyInfo {
+  defaultFirmwareExt: string;
+  mcuPartId: string;
+}
+
 export const boards: IBoard[] = [
   // ESP32 DevKits
-  { title: 'ESP32 DevKit', board: 'board-esp32-devkit-c-v4', family: 'esp32', idfTarget: 'esp32' },
+  { title: 'ESP32 DevKit', type: 'board-esp32-devkit-c-v4', family: 'esp32', idfTarget: 'esp32' },
   {
     title: 'ESP32-C3 DevKit',
-    board: 'board-esp32-c3-devkitm-1',
+    type: 'board-esp32-c3-devkitm-1',
     family: 'esp32',
     idfTarget: 'esp32c3',
   },
   {
     title: 'ESP32-C6 DevKit',
-    board: 'board-esp32-c6-devkitc-1',
+    type: 'board-esp32-c6-devkitc-1',
     family: 'esp32',
     idfTarget: 'esp32c6',
   },
   {
     title: 'ESP32-H2 DevKit',
-    board: 'board-esp32-h2-devkitm-1',
+    type: 'board-esp32-h2-devkitm-1',
     family: 'esp32',
     idfTarget: 'esp32h2',
   },
   {
     title: 'ESP32-P4-Function-EV-Board',
-    board: 'board-esp32-p4-function-ev',
+    type: 'board-esp32-p4-function-ev',
     family: 'esp32',
     idfTarget: 'esp32p4',
     serialPins: { RX: '38', TX: '37' },
   },
   {
     title: 'ESP32-S2 DevKit',
-    board: 'board-esp32-s2-devkitm-1',
+    type: 'board-esp32-s2-devkitm-1',
     family: 'esp32',
     idfTarget: 'esp32s2',
   },
   {
     title: 'ESP32-S3 DevKit',
-    board: 'board-esp32-s3-devkitc-1',
+    type: 'board-esp32-s3-devkitc-1',
     family: 'esp32',
     idfTarget: 'esp32s3',
   },
 
   // ESP32-based boards
-  { title: 'ESP32-C3 Rust DevKit', board: 'board-esp32-c3-rust-1', family: 'esp32' },
+  { title: 'ESP32-C3 Rust DevKit', type: 'board-esp32-c3-rust-1', family: 'esp32' },
   {
     title: 'ESP32-S3-BOX',
-    board: 'board-esp32-s3-box',
+    type: 'board-esp32-s3-box',
     family: 'esp32',
     serialPins: { RX: 'G44', TX: 'G43' },
   },
   {
     title: 'ESP32-S3-BOX-3',
-    board: 'board-esp32-s3-box-3',
+    type: 'board-esp32-s3-box-3',
     family: 'esp32',
     serialPins: { RX: 'G44', TX: 'G43' },
   },
-  { title: 'M5Stack CoreS3', board: 'board-m5stack-core-s3', family: 'esp32' },
+  { title: 'M5Stack CoreS3', type: 'board-m5stack-core-s3', family: 'esp32' },
 
   // RP2040-based boards
   {
     title: 'Raspberry Pi Pico',
-    board: 'wokwi-pi-pico',
+    type: 'wokwi-pi-pico',
     family: 'rp2',
     serialPins: { RX: 'GP1', TX: 'GP0' },
   },
   {
     title: 'Raspberry Pi Pico W',
-    board: 'board-pi-pico-w',
+    type: 'board-pi-pico-w',
     family: 'rp2',
     serialPins: { RX: 'GP1', TX: 'GP0' },
   },
 
   // STM32 boards
-  { title: 'STM32 Nucleo-64 C031C6', board: 'board-st-nucleo-c031c6', family: 'stm32' },
-  { title: 'STM32 Nucleo-64 L031K6', board: 'board-st-nucleo-l031k6', family: 'stm32' },
+  { title: 'STM32 Nucleo-64 C031C6', type: 'board-st-nucleo-c031c6', family: 'stm32' },
+  { title: 'STM32 Nucleo-64 L031K6', type: 'board-st-nucleo-l031k6', family: 'stm32' },
 ];
+
+export const families: Record<BoardFamily, IFamilyInfo> = {
+  esp32: {
+    defaultFirmwareExt: 'bin',
+    mcuPartId: 'esp',
+  },
+  rp2: {
+    defaultFirmwareExt: 'uf2',
+    mcuPartId: 'rp',
+  },
+  stm32: {
+    defaultFirmwareExt: 'hex',
+    mcuPartId: 'stm',
+  },
+};

src/project/createDiagram.ts

@@ -1,15 +1,15 @@
-import { boards } from './boards.js';
+import { families, type IBoard } from './boards.js';
 
-export function createDiagram(board: string) {
-  const boardInfo = boards.find((b) => b.board === board);
-  const serialPins = boardInfo?.serialPins ?? { RX: 'RX', TX: 'TX' };
-  const mcuPartId = boardInfo?.family === 'esp32' ? 'esp' : 'mcu';
+export function createDiagram(board: IBoard) {
+  const familyInfo = families[board.family];
+  const serialPins = board.serialPins ?? { RX: 'RX', TX: 'TX' };
+  const mcuPartId = familyInfo.mcuPartId;
 
   return {
     version: 1,
     author: 'Uri Shaked',
     editor: 'wokwi',
-    parts: [{ type: board, id: mcuPartId }],
+    parts: [{ type: board.type, id: mcuPartId }],
     connections: [
       [`${mcuPartId}:${serialPins.TX}`, '$serialMonitor:RX', ''],
       [`${mcuPartId}:${serialPins.RX}`, '$serialMonitor:TX', ''],

src/project/findBoard.ts

@@ -2,5 +2,5 @@ import { type Diagram } from './diagram.js';
 import { boards } from './boards.js';
 
 export function findBoard(diagram: Diagram) {
-  return diagram.parts?.find((part) => boards.some((b) => b.board === part.type));
+  return diagram.parts?.find((part) => boards.some((b) => b.type === part.type));
 }

src/project/initProjectWizard.ts

@@ -1,12 +1,12 @@
 import { cancel, confirm, intro, isCancel, log, note, outro, select, text } from '@clack/prompts';
 import chalkTemplate from 'chalk-template';
-import { existsSync, writeFileSync, mkdirSync } from 'fs';
+import { existsSync, mkdirSync, writeFileSync } from 'fs';
 import path from 'path';
-import { boards } from './boards.js';
+import { createWokwiToml } from '../WokwiConfig.js';
+import { boards, families } from './boards.js';
 import { createDiagram } from './createDiagram.js';
 import { findFirmwarePath } from './findFirmwarePath.js';
 import { detectProjectType } from './projectType.js';
-import { createWokwiToml } from '../WokwiConfig.js';
 
 export async function initProjectWizard(rootDir: string, opts: { diagramFile?: string }) {
   const configPath = path.join(rootDir, 'wokwi.toml');
@@ -52,17 +52,19 @@ export async function initProjectWizard(rootDir: string, opts: { diagramFile?: s
 
   const boardType = await select({
     message: 'Select the board to simulate:',
-    options: filteredBoards.map((board) => ({ value: board.board, label: board.title })),
+    options: filteredBoards.map((board) => ({ value: board.type, label: board.title })),
     maxItems: (process.stdout.rows ?? 16) - 4,
   });
-  if (isCancel(boardType)) {
+  const board = filteredBoards.find((b) => b.type === (boardType as string));
+  if (isCancel(boardType) || !board) {
     cancel('Operation cancelled.');
     process.exit(0);
   }
 
   const defaultFirmwarePath = await findFirmwarePath(rootDir, projectType);
+  const defaultFirmwareExt = families[board.family].defaultFirmwareExt;
   const firmwarePath = await text({
-    message: 'Enter the path to the firmware file (e.g. firmware.bin):',
+    message: `Enter the path to the firmware file (e.g. firmware.${defaultFirmwareExt}):`,
     initialValue: defaultFirmwarePath.firmware,
     validate: (value) => {
       if (!value) {
@@ -129,7 +131,7 @@ export async function initProjectWizard(rootDir: string, opts: { diagramFile?: s
   );
 
   log.info(`Writing diagram.json...`);
-  writeFileSync(diagramFilePath, JSON.stringify(createDiagram(boardType as string), null, 2));
+  writeFileSync(diagramFilePath, JSON.stringify(createDiagram(board), null, 2));
 
   if (vsCodeDebug) {
     log.info(`Writing .vscode/launch.json...`);