Home > DMT_Board > getBoardInfo

DMT_Board.getBoardInfo() method

Get detailed properties of Board

Signature

function getBoardInfo(boardName: string): Promise<IDMT_BoardItem | undefined>;

Parameters

Parameter	Type	Description
boardName	string	Board name

Returns

Promise<IDMT_BoardItem | undefined>

Board detailed properties of; if it is undefined, the retrieval failed

Example

// 1. 先盘点所有板子，取第一块的名称作为查询目标
const boards = await eda.dmt_Board.getAllBoardsInfo();
const targetName = boards[0].name;

// 2. 按名称查询该板子的详细属性
const board = await eda.dmt_Board.getBoardInfo(targetName);

// 3. 输出板子属性
console.log('name:', board.name);
console.log('parentProjectUuid:', board.parentProjectUuid);
console.log('schematic:', board.schematic?.uuid);
console.log('pcb:', board.pcb?.uuid);