Home > DMT_Board > modifyBoardName

DMT_Board.modifyBoardName() method

Modify Board name

Signature

function modifyBoardName(originalBoardName: string, boardName: string): Promise<boolean>;

Parameters

Parameter	Type	Description
originalBoardName	string	Original board name
boardName	string	New board name

Returns

Promise<boolean>

Whether Modify Successful

Example

// 1. 取第一块板子，记录原名称
const boards = await eda.dmt_Board.getAllBoardsInfo();
const originalName = boards[0].name;
const newName = `${originalName}_tmp`;

// 2. 改名并输出结果
const modified = await eda.dmt_Board.modifyBoardName(originalName, newName);
console.log('original:', originalName);
console.log('new:', newName);
console.log('modified:', modified);

// 3. 等待改名生效后改回原名称（改名是异步提交，紧跟的第二次改名会返回 false）
await new Promise(r => setTimeout(r, 1000));
const restored = await eda.dmt_Board.modifyBoardName(newName, originalName);
console.log('restored:', restored);