@windypro-rourou/dsh-eda 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (407) hide show
  1. package/README.md +71 -119
  2. package/cordis.patch.yml +9 -7
  3. package/lib/board.js +80 -0
  4. package/lib/client.js +2 -2
  5. package/lib/index.js +339 -11
  6. package/lib/installer.js +4 -4
  7. package/lib/skill.js +138 -0
  8. package/package.json +12 -2
  9. package/skill/INDEX.md +193 -0
  10. package/skill/README.official.md +125 -0
  11. package/skill/README.zh-Hans.official.md +125 -0
  12. package/skill/SKILL.md +746 -0
  13. package/skill/format/index.md +152 -0
  14. package/skill/format/pcb/3d.md +166 -0
  15. package/skill/format/pcb/attr.md +63 -0
  16. package/skill/format/pcb/common.md +306 -0
  17. package/skill/format/pcb/component.md +132 -0
  18. package/skill/format/pcb/dimension.md +58 -0
  19. package/skill/format/pcb/index.md +17 -0
  20. package/skill/format/pcb/obj.md +43 -0
  21. package/skill/format/pcb/pad_via.md +151 -0
  22. package/skill/format/pcb/panel.md +64 -0
  23. package/skill/format/pcb/partition.md +43 -0
  24. package/skill/format/pcb/primitive.md +196 -0
  25. package/skill/format/pcb/rule.md +71 -0
  26. package/skill/format/pcb/shape.md +441 -0
  27. package/skill/format/pcb/text.md +62 -0
  28. package/skill/format/project/blob.md +30 -0
  29. package/skill/format/project/common.md +42 -0
  30. package/skill/format/project/group.md +62 -0
  31. package/skill/format/project/index.md +12 -0
  32. package/skill/format/project/instance.md +32 -0
  33. package/skill/format/project/meta.md +189 -0
  34. package/skill/format/project/variant.md +30 -0
  35. package/skill/format/schematic/attr.md +41 -0
  36. package/skill/format/schematic/common.md +47 -0
  37. package/skill/format/schematic/component.md +91 -0
  38. package/skill/format/schematic/index.md +14 -0
  39. package/skill/format/schematic/obj.md +41 -0
  40. package/skill/format/schematic/pin.md +59 -0
  41. package/skill/format/schematic/shape.md +231 -0
  42. package/skill/format/schematic/structure.md +53 -0
  43. package/skill/format/schematic/table.md +109 -0
  44. package/skill/format/schematic/text.md +47 -0
  45. package/skill/format/schematic/wire.md +132 -0
  46. package/skill/guide/ancillary-projects/pro-api-sdk.md +1 -0
  47. package/skill/guide/ancillary-projects/pro-api-types.md +5 -0
  48. package/skill/guide/ancillary-projects.md +10 -0
  49. package/skill/guide/error-handling.md +38 -0
  50. package/skill/guide/extension-json.md +135 -0
  51. package/skill/guide/extensions-marketplace.md +61 -0
  52. package/skill/guide/how-to-start.md +301 -0
  53. package/skill/guide/i18n.md +57 -0
  54. package/skill/guide/index.md +7 -0
  55. package/skill/guide/inline-frame.md +20 -0
  56. package/skill/guide/invoke-apis.md +81 -0
  57. package/skill/guide/stability.md +37 -0
  58. package/skill/references/_index.md +398 -0
  59. package/skill/references/_quick-reference.md +3028 -0
  60. package/skill/references/classes/DMT_Board.md +533 -0
  61. package/skill/references/classes/DMT_EditorControl.md +1736 -0
  62. package/skill/references/classes/DMT_Event.md +356 -0
  63. package/skill/references/classes/DMT_Folder.md +775 -0
  64. package/skill/references/classes/DMT_Panel.md +531 -0
  65. package/skill/references/classes/DMT_Pcb.md +575 -0
  66. package/skill/references/classes/DMT_Project.md +573 -0
  67. package/skill/references/classes/DMT_Schematic.md +1477 -0
  68. package/skill/references/classes/DMT_SelectControl.md +96 -0
  69. package/skill/references/classes/DMT_Team.md +172 -0
  70. package/skill/references/classes/DMT_Workspace.md +198 -0
  71. package/skill/references/classes/EDA.md +961 -0
  72. package/skill/references/classes/IPCB_ComplexPolygon.md +299 -0
  73. package/skill/references/classes/IPCB_Polygon.md +175 -0
  74. package/skill/references/classes/IPCB_PrimitiveArc.md +1901 -0
  75. package/skill/references/classes/IPCB_PrimitiveAttribute.md +2993 -0
  76. package/skill/references/classes/IPCB_PrimitiveComponent.md +2627 -0
  77. package/skill/references/classes/IPCB_PrimitiveComponentPad.md +410 -0
  78. package/skill/references/classes/IPCB_PrimitiveDimension.md +1419 -0
  79. package/skill/references/classes/IPCB_PrimitiveFill.md +1325 -0
  80. package/skill/references/classes/IPCB_PrimitiveImage.md +1461 -0
  81. package/skill/references/classes/IPCB_PrimitiveLine.md +1639 -0
  82. package/skill/references/classes/IPCB_PrimitiveObject.md +1700 -0
  83. package/skill/references/classes/IPCB_PrimitivePad.md +3155 -0
  84. package/skill/references/classes/IPCB_PrimitivePolyline.md +1193 -0
  85. package/skill/references/classes/IPCB_PrimitivePour.md +1858 -0
  86. package/skill/references/classes/IPCB_PrimitivePoured.md +556 -0
  87. package/skill/references/classes/IPCB_PrimitiveRegion.md +1332 -0
  88. package/skill/references/classes/IPCB_PrimitiveString.md +2315 -0
  89. package/skill/references/classes/IPCB_PrimitiveVia.md +1588 -0
  90. package/skill/references/classes/ISCH_PrimitiveArc.md +1676 -0
  91. package/skill/references/classes/ISCH_PrimitiveAttribute.md +2541 -0
  92. package/skill/references/classes/ISCH_PrimitiveBus.md +973 -0
  93. package/skill/references/classes/ISCH_PrimitiveCbbSymbolComponent.md +260 -0
  94. package/skill/references/classes/ISCH_PrimitiveCircle.md +1392 -0
  95. package/skill/references/classes/ISCH_PrimitiveComponent.md +2913 -0
  96. package/skill/references/classes/ISCH_PrimitiveComponentPin.md +155 -0
  97. package/skill/references/classes/ISCH_PrimitiveObject.md +960 -0
  98. package/skill/references/classes/ISCH_PrimitivePin.md +2402 -0
  99. package/skill/references/classes/ISCH_PrimitivePolygon.md +1028 -0
  100. package/skill/references/classes/ISCH_PrimitiveRectangle.md +1777 -0
  101. package/skill/references/classes/ISCH_PrimitiveText.md +1771 -0
  102. package/skill/references/classes/ISCH_PrimitiveWire.md +973 -0
  103. package/skill/references/classes/LIB_3DModel.md +780 -0
  104. package/skill/references/classes/LIB_Cbb.md +957 -0
  105. package/skill/references/classes/LIB_Classification.md +965 -0
  106. package/skill/references/classes/LIB_Device.md +1221 -0
  107. package/skill/references/classes/LIB_Footprint.md +1153 -0
  108. package/skill/references/classes/LIB_LibrariesList.md +329 -0
  109. package/skill/references/classes/LIB_PanelLibrary.md +855 -0
  110. package/skill/references/classes/LIB_SelectControl.md +89 -0
  111. package/skill/references/classes/LIB_SimulationModel.md +821 -0
  112. package/skill/references/classes/LIB_Symbol.md +1195 -0
  113. package/skill/references/classes/PCB_Document.md +1754 -0
  114. package/skill/references/classes/PCB_Drc.md +3375 -0
  115. package/skill/references/classes/PCB_Event.md +1081 -0
  116. package/skill/references/classes/PCB_Layer.md +1911 -0
  117. package/skill/references/classes/PCB_ManufactureData.md +2968 -0
  118. package/skill/references/classes/PCB_MathPolygon.md +785 -0
  119. package/skill/references/classes/PCB_Net.md +1128 -0
  120. package/skill/references/classes/PCB_Primitive.md +217 -0
  121. package/skill/references/classes/PCB_PrimitiveArc.md +894 -0
  122. package/skill/references/classes/PCB_PrimitiveAttribute.md +717 -0
  123. package/skill/references/classes/PCB_PrimitiveComponent.md +1050 -0
  124. package/skill/references/classes/PCB_PrimitiveDimension.md +833 -0
  125. package/skill/references/classes/PCB_PrimitiveFill.md +861 -0
  126. package/skill/references/classes/PCB_PrimitiveImage.md +875 -0
  127. package/skill/references/classes/PCB_PrimitiveLine.md +858 -0
  128. package/skill/references/classes/PCB_PrimitiveObject.md +800 -0
  129. package/skill/references/classes/PCB_PrimitivePad.md +944 -0
  130. package/skill/references/classes/PCB_PrimitivePolyline.md +819 -0
  131. package/skill/references/classes/PCB_PrimitivePour.md +845 -0
  132. package/skill/references/classes/PCB_PrimitivePoured.md +363 -0
  133. package/skill/references/classes/PCB_PrimitiveRegion.md +799 -0
  134. package/skill/references/classes/PCB_PrimitiveString.md +910 -0
  135. package/skill/references/classes/PCB_PrimitiveVia.md +765 -0
  136. package/skill/references/classes/PCB_RayTracerEngine.md +263 -0
  137. package/skill/references/classes/PCB_SelectControl.md +495 -0
  138. package/skill/references/classes/PNL_Document.md +83 -0
  139. package/skill/references/classes/SCH_Document.md +809 -0
  140. package/skill/references/classes/SCH_Drc.md +242 -0
  141. package/skill/references/classes/SCH_Event.md +583 -0
  142. package/skill/references/classes/SCH_ManufactureData.md +1205 -0
  143. package/skill/references/classes/SCH_Net.md +200 -0
  144. package/skill/references/classes/SCH_Netlist.md +191 -0
  145. package/skill/references/classes/SCH_Primitive.md +337 -0
  146. package/skill/references/classes/SCH_PrimitiveArc.md +692 -0
  147. package/skill/references/classes/SCH_PrimitiveAttribute.md +590 -0
  148. package/skill/references/classes/SCH_PrimitiveBus.md +624 -0
  149. package/skill/references/classes/SCH_PrimitiveCircle.md +683 -0
  150. package/skill/references/classes/SCH_PrimitiveComponent.md +2240 -0
  151. package/skill/references/classes/SCH_PrimitiveObject.md +666 -0
  152. package/skill/references/classes/SCH_PrimitivePin.md +754 -0
  153. package/skill/references/classes/SCH_PrimitivePolygon.md +627 -0
  154. package/skill/references/classes/SCH_PrimitiveRectangle.md +731 -0
  155. package/skill/references/classes/SCH_PrimitiveText.md +746 -0
  156. package/skill/references/classes/SCH_PrimitiveWire.md +703 -0
  157. package/skill/references/classes/SCH_SelectControl.md +520 -0
  158. package/skill/references/classes/SCH_SimulationEngine.md +133 -0
  159. package/skill/references/classes/SCH_Utils.md +121 -0
  160. package/skill/references/classes/SYS_ClientUrl.md +173 -0
  161. package/skill/references/classes/SYS_Dialog.md +825 -0
  162. package/skill/references/classes/SYS_Environment.md +502 -0
  163. package/skill/references/classes/SYS_FileManager.md +1686 -0
  164. package/skill/references/classes/SYS_FileSystem.md +1171 -0
  165. package/skill/references/classes/SYS_FontManager.md +224 -0
  166. package/skill/references/classes/SYS_FormatConversion.md +349 -0
  167. package/skill/references/classes/SYS_HeaderMenu.md +479 -0
  168. package/skill/references/classes/SYS_I18n.md +861 -0
  169. package/skill/references/classes/SYS_IFrame.md +535 -0
  170. package/skill/references/classes/SYS_LoadingAndProgressBar.md +246 -0
  171. package/skill/references/classes/SYS_Log.md +424 -0
  172. package/skill/references/classes/SYS_Math.md +1565 -0
  173. package/skill/references/classes/SYS_Message.md +363 -0
  174. package/skill/references/classes/SYS_MessageBox.md +285 -0
  175. package/skill/references/classes/SYS_MessageBus.md +1618 -0
  176. package/skill/references/classes/SYS_PanelControl.md +696 -0
  177. package/skill/references/classes/SYS_RightClickMenu.md +175 -0
  178. package/skill/references/classes/SYS_Setting.md +85 -0
  179. package/skill/references/classes/SYS_ShortcutKey.md +623 -0
  180. package/skill/references/classes/SYS_Storage.md +484 -0
  181. package/skill/references/classes/SYS_Timer.md +447 -0
  182. package/skill/references/classes/SYS_ToastMessage.md +194 -0
  183. package/skill/references/classes/SYS_Tool.md +241 -0
  184. package/skill/references/classes/SYS_Unit.md +594 -0
  185. package/skill/references/classes/SYS_WebSocket.md +401 -0
  186. package/skill/references/classes/SYS_Window.md +850 -0
  187. package/skill/references/enums/EDMT_EditorDocumentType.md +279 -0
  188. package/skill/references/enums/EDMT_EditorSplitScreenDirection.md +48 -0
  189. package/skill/references/enums/EDMT_EditorTabEventType.md +63 -0
  190. package/skill/references/enums/EDMT_IndicatorMarkerType.md +81 -0
  191. package/skill/references/enums/EDMT_ItemType.md +158 -0
  192. package/skill/references/enums/EDMT_ProjectCollaborationMode.md +48 -0
  193. package/skill/references/enums/ELIB_DeviceJlcLibraryCategory.md +48 -0
  194. package/skill/references/enums/ELIB_LibraryType.md +114 -0
  195. package/skill/references/enums/ELIB_PreviewType.md +70 -0
  196. package/skill/references/enums/ELIB_SimulationModelType.md +48 -0
  197. package/skill/references/enums/ELIB_SymbolType.md +125 -0
  198. package/skill/references/enums/EPCB_AutoRoutingCornerStyle.md +48 -0
  199. package/skill/references/enums/EPCB_AutoRoutingExistingPrimitiveMode.md +48 -0
  200. package/skill/references/enums/EPCB_AutoRoutingOptimization.md +48 -0
  201. package/skill/references/enums/EPCB_DocumentCanvasUpdateCalculationActiveStatus.md +48 -0
  202. package/skill/references/enums/EPCB_DocumentRatlineCalculatingActiveStatus.md +52 -0
  203. package/skill/references/enums/EPCB_InactiveLayerDisplayMode.md +59 -0
  204. package/skill/references/enums/EPCB_LayerColorConfiguration.md +81 -0
  205. package/skill/references/enums/EPCB_LayerId.md +882 -0
  206. package/skill/references/enums/EPCB_LayerStatus.md +59 -0
  207. package/skill/references/enums/EPCB_LayerType.md +114 -0
  208. package/skill/references/enums/EPCB_MouseEventType.md +59 -0
  209. package/skill/references/enums/EPCB_NetEventType.md +59 -0
  210. package/skill/references/enums/EPCB_PcbPlateType.md +48 -0
  211. package/skill/references/enums/EPCB_PdfOutputMethod.md +59 -0
  212. package/skill/references/enums/EPCB_PrimitiveArcInteractiveMode.md +48 -0
  213. package/skill/references/enums/EPCB_PrimitiveDimensionType.md +59 -0
  214. package/skill/references/enums/EPCB_PrimitiveEventType.md +59 -0
  215. package/skill/references/enums/EPCB_PrimitiveFillMode.md +63 -0
  216. package/skill/references/enums/EPCB_PrimitivePadHeatWeldingConnectionMethod.md +59 -0
  217. package/skill/references/enums/EPCB_PrimitivePadHoleType.md +59 -0
  218. package/skill/references/enums/EPCB_PrimitivePadShapeType.md +81 -0
  219. package/skill/references/enums/EPCB_PrimitivePadType.md +59 -0
  220. package/skill/references/enums/EPCB_PrimitivePourFillMethod.md +59 -0
  221. package/skill/references/enums/EPCB_PrimitiveRegionRuleType.md +96 -0
  222. package/skill/references/enums/EPCB_PrimitiveStringAlignMode.md +125 -0
  223. package/skill/references/enums/EPCB_PrimitiveType.md +202 -0
  224. package/skill/references/enums/EPCB_PrimitiveViaType.md +59 -0
  225. package/skill/references/enums/ESCH_DynamicSimulationEnginePullEventType.md +103 -0
  226. package/skill/references/enums/ESCH_DynamicSimulationEnginePushEventType.md +81 -0
  227. package/skill/references/enums/ESCH_ExportDocumentFileType.md +59 -0
  228. package/skill/references/enums/ESCH_MouseEventType.md +48 -0
  229. package/skill/references/enums/ESCH_PrimitiveComponentType.md +125 -0
  230. package/skill/references/enums/ESCH_PrimitiveEventType.md +70 -0
  231. package/skill/references/enums/ESCH_PrimitiveFillStyle.md +114 -0
  232. package/skill/references/enums/ESCH_PrimitiveLineType.md +70 -0
  233. package/skill/references/enums/ESCH_PrimitivePinShape.md +70 -0
  234. package/skill/references/enums/ESCH_PrimitivePinType.md +147 -0
  235. package/skill/references/enums/ESCH_PrimitiveTextAlignMode.md +125 -0
  236. package/skill/references/enums/ESCH_PrimitiveType.md +180 -0
  237. package/skill/references/enums/ESCH_SimulationNetlistType.md +37 -0
  238. package/skill/references/enums/ESCH_SpiceSimulationEnginePullEventType.md +48 -0
  239. package/skill/references/enums/ESCH_SpiceSimulationEnginePushEventType.md +70 -0
  240. package/skill/references/enums/ESYS_BottomPanelTab.md +81 -0
  241. package/skill/references/enums/ESYS_HeaderMenuEnvironment.md +158 -0
  242. package/skill/references/enums/ESYS_ImportProjectBoardOutlineSource.md +52 -0
  243. package/skill/references/enums/ESYS_ImportProjectImportOption.md +59 -0
  244. package/skill/references/enums/ESYS_ImportProjectSchematicObjectStyle.md +48 -0
  245. package/skill/references/enums/ESYS_ImportProjectViaSolderMaskExpansion.md +52 -0
  246. package/skill/references/enums/ESYS_LeftPanelTab.md +81 -0
  247. package/skill/references/enums/ESYS_LogType.md +103 -0
  248. package/skill/references/enums/ESYS_NetlistType.md +114 -0
  249. package/skill/references/enums/ESYS_RightPanelTab.md +202 -0
  250. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorRange.md +191 -0
  251. package/skill/references/enums/ESYS_ShortcutKeyEffectiveEditorScene.md +92 -0
  252. package/skill/references/enums/ESYS_StartPageQuickStartItem.md +206 -0
  253. package/skill/references/enums/ESYS_Theme.md +48 -0
  254. package/skill/references/enums/ESYS_ToastMessageType.md +81 -0
  255. package/skill/references/enums/ESYS_Unit.md +103 -0
  256. package/skill/references/enums/ESYS_WindowEventType.md +48 -0
  257. package/skill/references/enums/ESYS_WindowOpenTarget.md +48 -0
  258. package/skill/references/enums/NetportDeviceName.md +147 -0
  259. package/skill/references/enums/SchToolBarDeviceName.md +279 -0
  260. package/skill/references/interfaces/BoardProps.md +169 -0
  261. package/skill/references/interfaces/ButtonProps.md +169 -0
  262. package/skill/references/interfaces/CheckBoxProps.md +196 -0
  263. package/skill/references/interfaces/ComponentPropsMap.md +448 -0
  264. package/skill/references/interfaces/DialogProps.md +385 -0
  265. package/skill/references/interfaces/FlexItemProps.md +116 -0
  266. package/skill/references/interfaces/FlexProps.md +224 -0
  267. package/skill/references/interfaces/GridItemProps.md +143 -0
  268. package/skill/references/interfaces/GridProps.md +143 -0
  269. package/skill/references/interfaces/IDMT_BoardItem.md +171 -0
  270. package/skill/references/interfaces/IDMT_BriefProjectItem.md +171 -0
  271. package/skill/references/interfaces/IDMT_EditorDocumentItem.md +169 -0
  272. package/skill/references/interfaces/IDMT_EditorSplitScreenItem.md +173 -0
  273. package/skill/references/interfaces/IDMT_EditorTabItem.md +169 -0
  274. package/skill/references/interfaces/IDMT_FolderItem.md +225 -0
  275. package/skill/references/interfaces/IDMT_IndicatorMarkerShape.md +393 -0
  276. package/skill/references/interfaces/IDMT_PanelItem.md +144 -0
  277. package/skill/references/interfaces/IDMT_PcbItem.md +171 -0
  278. package/skill/references/interfaces/IDMT_ProjectItem.md +143 -0
  279. package/skill/references/interfaces/IDMT_SchematicItem.md +225 -0
  280. package/skill/references/interfaces/IDMT_SchematicPageItem.md +198 -0
  281. package/skill/references/interfaces/IDMT_TeamItem.md +144 -0
  282. package/skill/references/interfaces/IDMT_WorkspaceItem.md +117 -0
  283. package/skill/references/interfaces/IDesignPortal.md +103 -0
  284. package/skill/references/interfaces/ILIB_3DModelItem.md +198 -0
  285. package/skill/references/interfaces/ILIB_3DModelSearchItem.md +277 -0
  286. package/skill/references/interfaces/ILIB_CbbItem.md +225 -0
  287. package/skill/references/interfaces/ILIB_CbbSearchItem.md +277 -0
  288. package/skill/references/interfaces/ILIB_ClassificationIndex.md +150 -0
  289. package/skill/references/interfaces/ILIB_DeviceAssociationItem.md +210 -0
  290. package/skill/references/interfaces/ILIB_DeviceExtendPropertyItem.md +304 -0
  291. package/skill/references/interfaces/ILIB_DeviceItem.md +279 -0
  292. package/skill/references/interfaces/ILIB_DevicePropertiesForSearch.md +250 -0
  293. package/skill/references/interfaces/ILIB_DeviceSearchItem.md +521 -0
  294. package/skill/references/interfaces/ILIB_ExtendLibrary3DModelFunctions.md +64 -0
  295. package/skill/references/interfaces/ILIB_ExtendLibraryCbbFunctions.md +99 -0
  296. package/skill/references/interfaces/ILIB_ExtendLibraryClassificationIndex.md +150 -0
  297. package/skill/references/interfaces/ILIB_ExtendLibraryDeviceFunctions.md +157 -0
  298. package/skill/references/interfaces/ILIB_ExtendLibraryFootprintFunctions.md +63 -0
  299. package/skill/references/interfaces/ILIB_ExtendLibraryFunctions.md +123 -0
  300. package/skill/references/interfaces/ILIB_ExtendLibraryItem.md +97 -0
  301. package/skill/references/interfaces/ILIB_ExtendLibraryItemIndex.md +98 -0
  302. package/skill/references/interfaces/ILIB_ExtendLibrarySearchProperty.md +115 -0
  303. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResult.md +169 -0
  304. package/skill/references/interfaces/ILIB_ExtendLibrarySearchResultDataLine.md +234 -0
  305. package/skill/references/interfaces/ILIB_ExtendLibrarySymbolFunctions.md +105 -0
  306. package/skill/references/interfaces/ILIB_ExtendLibraryUserIndex.md +96 -0
  307. package/skill/references/interfaces/ILIB_FootprintItem.md +198 -0
  308. package/skill/references/interfaces/ILIB_FootprintPropertiesForSearch.md +61 -0
  309. package/skill/references/interfaces/ILIB_FootprintSearchItem.md +277 -0
  310. package/skill/references/interfaces/ILIB_LibraryInfo.md +92 -0
  311. package/skill/references/interfaces/ILIB_LibraryItem.md +115 -0
  312. package/skill/references/interfaces/ILIB_PanelLibraryItem.md +198 -0
  313. package/skill/references/interfaces/ILIB_PanelLibrarySearchItem.md +277 -0
  314. package/skill/references/interfaces/ILIB_SimulationModelItem.md +306 -0
  315. package/skill/references/interfaces/ILIB_SimulationModelSearchItem.md +304 -0
  316. package/skill/references/interfaces/ILIB_SymbolItem.md +279 -0
  317. package/skill/references/interfaces/ILIB_SymbolPropertiesForSearch.md +61 -0
  318. package/skill/references/interfaces/ILIB_SymbolSearchItem.md +304 -0
  319. package/skill/references/interfaces/IPCB_AutoLayoutResult.md +169 -0
  320. package/skill/references/interfaces/IPCB_AutoRoutingProps.md +220 -0
  321. package/skill/references/interfaces/IPCB_AutoRoutingResult.md +169 -0
  322. package/skill/references/interfaces/IPCB_BomPropertiesTableColumns.md +169 -0
  323. package/skill/references/interfaces/IPCB_DifferentialPairItem.md +115 -0
  324. package/skill/references/interfaces/IPCB_DiscretizeOptions.md +65 -0
  325. package/skill/references/interfaces/IPCB_DiscretizedPoint.md +88 -0
  326. package/skill/references/interfaces/IPCB_EqualLengthNetGroupItem.md +115 -0
  327. package/skill/references/interfaces/IPCB_LayerItem.md +277 -0
  328. package/skill/references/interfaces/IPCB_NetClassItem.md +115 -0
  329. package/skill/references/interfaces/IPCB_NetInfo.md +115 -0
  330. package/skill/references/interfaces/IPCB_PadPairGroupItem.md +88 -0
  331. package/skill/references/interfaces/IPCB_PadPairMinWireLengthItem.md +88 -0
  332. package/skill/references/interfaces/IPCB_PhysicalStackingConfiguration.md +115 -0
  333. package/skill/references/interfaces/IPCB_Primitive.md +218 -0
  334. package/skill/references/interfaces/IPCB_PrimitiveAPI.md +175 -0
  335. package/skill/references/interfaces/IPCB_PrimitivePadHeatWelding.md +151 -0
  336. package/skill/references/interfaces/IPCB_PrimitivePouredPourFill.md +142 -0
  337. package/skill/references/interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md +154 -0
  338. package/skill/references/interfaces/IPCB_SubstratePhysicalProperties.md +88 -0
  339. package/skill/references/interfaces/IRawNet.md +103 -0
  340. package/skill/references/interfaces/IRawPureSchematic.md +80 -0
  341. package/skill/references/interfaces/IRawSchematic.md +103 -0
  342. package/skill/references/interfaces/IRawWire.md +149 -0
  343. package/skill/references/interfaces/ISCH_DrcError.md +142 -0
  344. package/skill/references/interfaces/ISCH_DrcErrorPrimitive.md +142 -0
  345. package/skill/references/interfaces/ISCH_ExportPngResolution.md +94 -0
  346. package/skill/references/interfaces/ISCH_NetInfo.md +88 -0
  347. package/skill/references/interfaces/ISCH_Primitive.md +219 -0
  348. package/skill/references/interfaces/ISCH_PrimitiveAPI.md +175 -0
  349. package/skill/references/interfaces/ISCH_ProjectNetInfo.md +142 -0
  350. package/skill/references/interfaces/ISCH_WireInfo.md +169 -0
  351. package/skill/references/interfaces/ISYS_FileSystemFileList.md +169 -0
  352. package/skill/references/interfaces/ISYS_HeaderMenuSub1MenuItem.md +174 -0
  353. package/skill/references/interfaces/ISYS_HeaderMenuSub2MenuItem.md +147 -0
  354. package/skill/references/interfaces/ISYS_HeaderMenuTopMenuItem.md +115 -0
  355. package/skill/references/interfaces/ISYS_HeaderMenus.md +408 -0
  356. package/skill/references/interfaces/ISYS_LogLine.md +115 -0
  357. package/skill/references/interfaces/ISYS_MathBBox.md +142 -0
  358. package/skill/references/interfaces/ISYS_MathPoint.md +88 -0
  359. package/skill/references/interfaces/ISYS_MathPolygonWithHoles.md +92 -0
  360. package/skill/references/interfaces/ISYS_MessageBusTask.md +115 -0
  361. package/skill/references/interfaces/ISYS_MultilingualLanguagesData.md +13 -0
  362. package/skill/references/interfaces/ISYS_PcbComparisonResponse.md +115 -0
  363. package/skill/references/interfaces/ISYS_RightClickMenuItem.md +174 -0
  364. package/skill/references/interfaces/ISYS_ShortcutKeyData.md +169 -0
  365. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithCallFn.md +62 -0
  366. package/skill/references/interfaces/ISYS_ShortcutKeyDataWithUserDefinedShortcutKey.md +62 -0
  367. package/skill/references/interfaces/ISYS_WindowEventListenerRemovableObject.md +109 -0
  368. package/skill/references/interfaces/IconProps.md +88 -0
  369. package/skill/references/interfaces/ImageProps.md +115 -0
  370. package/skill/references/interfaces/InputProps.md +520 -0
  371. package/skill/references/interfaces/ListChildren.md +223 -0
  372. package/skill/references/interfaces/ListProps.md +223 -0
  373. package/skill/references/interfaces/ModalProps.md +358 -0
  374. package/skill/references/interfaces/RadioGroupProps.md +196 -0
  375. package/skill/references/interfaces/RadioItem.md +115 -0
  376. package/skill/references/interfaces/ScrollerProps.md +169 -0
  377. package/skill/references/interfaces/SelectListItem.md +142 -0
  378. package/skill/references/interfaces/SelectProps.md +169 -0
  379. package/skill/references/interfaces/SlotProps.md +88 -0
  380. package/skill/references/interfaces/StyleProps.md +385 -0
  381. package/skill/references/interfaces/TextAreaProps.md +196 -0
  382. package/skill/references/interfaces/TextProps.md +169 -0
  383. package/skill/references/types/ISYS_LanguageKeyValuePairs.md +13 -0
  384. package/skill/references/types/TPCB_LayerTypesOfInnerLayer.md +12 -0
  385. package/skill/references/types/TPCB_LayersInTheSelectable.md +43 -0
  386. package/skill/references/types/TPCB_LayersOfComponent.md +12 -0
  387. package/skill/references/types/TPCB_LayersOfCopper.md +16 -0
  388. package/skill/references/types/TPCB_LayersOfCustom.md +42 -0
  389. package/skill/references/types/TPCB_LayersOfDimension.md +17 -0
  390. package/skill/references/types/TPCB_LayersOfFill.md +29 -0
  391. package/skill/references/types/TPCB_LayersOfImage.md +23 -0
  392. package/skill/references/types/TPCB_LayersOfInner.md +42 -0
  393. package/skill/references/types/TPCB_LayersOfLine.md +26 -0
  394. package/skill/references/types/TPCB_LayersOfObject.md +13 -0
  395. package/skill/references/types/TPCB_LayersOfPad.md +12 -0
  396. package/skill/references/types/TPCB_LayersOfRegion.md +12 -0
  397. package/skill/references/types/TPCB_NumberOfCopperLayers.md +10 -0
  398. package/skill/references/types/TPCB_PolygonSourceArray.md +83 -0
  399. package/skill/references/types/TPCB_PrimitiveDimensionCoordinateSet.md +67 -0
  400. package/skill/references/types/TPCB_PrimitivePadHole.md +31 -0
  401. package/skill/references/types/TPCB_PrimitivePadShape.md +62 -0
  402. package/skill/references/types/TPCB_PrimitiveSpecialPadShape.md +20 -0
  403. package/skill/references/types/TSYS_MathPolygonGroup.md +16 -0
  404. package/skill/references/types/TSYS_MathPolygonInput.md +21 -0
  405. package/skill/references/types/TSYS_PcbComparisonErrorCode.md +10 -0
  406. package/skill/references/types/TSYS_ShortcutKeys.md +97 -0
  407. package/skill/user-guide/using-extension.md +47 -0
@@ -0,0 +1,152 @@
1
+ # EasyEDA File Format
2
+
3
+ ## V2.2 File Format
4
+
5
+ V2.2 file format: [lceda-pro-file-format-v2.2_2022.12.15.zip](https://image.lceda.cn/files/lceda-pro-file-format-v2.2_2022.12.15.zip)
6
+
7
+ Hint: This is not the latest file format specification, but it contains most of the format details.
8
+
9
+ ## V3 File Format
10
+
11
+ V3 uses a brand-new source format, completely different from previous formats.
12
+
13
+ Hint: EasyEDA 3.0 fully redesigned the project format, using the concept of logs for incremental storage of project changes; and switched from the array offset design style in 2.0 to a key-value style, making future format evolution easier, compatibility code development simpler, and readability improved.
14
+
15
+ V3 file format (example files included in the zip):
16
+ - [lceda-pro-file-format-v3_2025.10.21.zip](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.zip)
17
+ - [lceda-pro-file-format-v3_2025.10.21.md](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.md)
18
+ - [lceda-pro-file-format-v3_2025.10.21.pdf](https://image.lceda.cn/files/lceda-pro-file-format-v3_2025.10.21.pdf)
19
+
20
+ ### Format Details Documents
21
+
22
+ - [Project Format](/en/format/project/index/)
23
+ - [Schematic Format](/en/format/schematic/index/)
24
+ - [PCB Format](/en/format/pcb/index/)
25
+
26
+ ### Basic Document Format
27
+
28
+ #### Document Conventions
29
+
30
+ - All project data is stored in a log document. The first line of each change record must be the file header `DOCTYPE` to distinguish different document types. `DOCTYPE` exists as a `block-level element` in the project log.
31
+ - Each line consists of two valid JSON objects concatenated together. The first object is used by the eventual consistency framework for parsing, and the latter is the `atomic structural object`.
32
+ - Key names use camelCase, with the first letter of each word capitalized (except the first word), and no underscores or other separators between words.
33
+ - All primitives must carry a `unique ID` within the file.
34
+ - `Rotation angle` is positive in the counter-clockwise direction, and angles are always in degrees.
35
+ - Unless otherwise specified, all coordinates, lengths, and sizes use `0.01 inch` as the unit.
36
+ - All colors are expressed as `"#RRGGBB"`. To indicate no color (fully transparent), use `""`.
37
+ - All properties described as `whether XXXX` are encoded with `1` for yes and `0` for no.
38
+ - Parts not explicitly described in these conventions (such as escaping) follow [RFC 7195 The JavaScript Object Notation (JSON) Data Interchange Format](https://tools.ietf.org/html/rfc7159).
39
+
40
+ #### Type Categories
41
+
42
+ - **Common Data**: Includes basic information, creation information, modification information, etc.
43
+ - **Basic Information**: Includes metadata for project config, board, schematic, PCB, panel, symbol, footprint, device, etc.
44
+ - **BLOB True-Color Image**: True-color image data format.
45
+ - **Instance Attribute Override**: Instance attribute override format.
46
+ - **Variant**: Variant data format.
47
+ - **Component Grouping**: Component grouping data format.
48
+
49
+ #### Document Header
50
+
51
+ - All data must begin with a document header to distinguish different document types.
52
+ - When parsing line by line, encountering a document header means the following data belongs to that document until the next document header is encountered.
53
+
54
+ ```json
55
+ { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "clientID" }|
56
+ ```
57
+
58
+ 1. type: "DOCHEAD", document header identifier.
59
+ 2. docType: document type.
60
+ 3. uuid: document unique ID, unique within the project.
61
+ 4. client: terminal identifier for eventual consistency.
62
+
63
+ ###### docType Document Types
64
+
65
+ - Project config `PROJECT_CONFIG`
66
+ - Board `BOARD`
67
+ - Schematic `SCH`
68
+ - Schematic page `SCH_PAGE`
69
+ - PCB `PCB`
70
+ - Panel `PANEL`
71
+ - Symbol `SYMBOL`
72
+ - Footprint `FOOTPRINT`
73
+ - Device `DEVICE`
74
+ - True-color image `BLOB`
75
+ - Instance attributes `INSTANCE`
76
+
77
+ #### Data Format
78
+
79
+ ```json
80
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{["key": string]: any}|
81
+ ```
82
+
83
+ The identifier `||` splits a record into inner and outer layers:
84
+
85
+ 1. Outer layer data: used by the eventual consistency framework to ensure data consistency.
86
+ 1. type: data type.
87
+ 2. id: unique ID, must be unique within the specific type in the document.
88
+ 3. ticket: logical clock, only used by the eventual consistency framework to ensure data uniqueness.
89
+ 2. Inner layer data: primitive atomic data, a `key-value` object. Specific contents are detailed in the corresponding document for each type.
90
+
91
+ The reason for splitting into inner and outer layers is that in the eventual consistency framework, the specific primitive data does not need to be concerned; only the outer layer data is needed to ensure data uniqueness, reducing unnecessary JSON parsing and saving memory.
92
+
93
+ ```json
94
+ { "type": "META", "ticket": 1}||{"name": "name"}|
95
+ ```
96
+
97
+ Some data can only retain one record within a document. The `type` field alone can indicate uniqueness, so the `id` field is omitted. The `id` field is only used to distinguish multiple records of the same type.
98
+
99
+ #### Eventual Consistency
100
+
101
+ - In Storage 3.0, adding, deleting, or modifying data adds a record to the log, so multiple records in the log may represent the same data.
102
+ - The eventual consistency framework decides which record to keep based on the `type`, `id`, and `ticket` fields.
103
+
104
+ ps: For more details, please refer to the eventual consistency design document. Here we only explain the use of relevant fields.
105
+
106
+ ###### Two records with the same type and id
107
+
108
+ ```json
109
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 1}|
110
+ ```
111
+
112
+ ```json
113
+ { "type": "TYPE", "id": "UUID", "ticket": 2}||{"data": 2}|
114
+ ```
115
+
116
+ The eventual consistency framework compares the `ticket` field and keeps the record with the larger ticket. In the example above, the record with `data` 2 is kept.
117
+
118
+ ###### Same type, same id, and same ticket
119
+
120
+ ```json
121
+ { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "1" }|
122
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 1}|
123
+ ```
124
+
125
+ ```json
126
+ { "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "2" }|
127
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||{"data": 2}|
128
+ ```
129
+
130
+ Then the `client` field in the document header is compared, and the record with the smaller client identifier is kept. In the example above, the record with `data` 1 is kept.
131
+
132
+ #### Deletion
133
+
134
+ ##### Atomic Data Deletion
135
+
136
+ ```json
137
+ { "type": "TYPE", "id": "UUID", "ticket": 1}||""
138
+ ```
139
+
140
+ Deleting data actually means setting the inner layer data to an empty string.
141
+
142
+ ##### Document Deletion
143
+
144
+ ```json
145
+ { "type": "DELETE_DOC", "ticket": 1}||{"isDelete": true}|
146
+ ```
147
+
148
+ 1. type `DELETE_DOC` document deletion identifier.
149
+ 2. isDelete whether deleted.
150
+
151
+ - Document deletion actually adds a deletion marker and does not directly delete document data from the log, to facilitate undoing document deletion and maintaining data consistency.
152
+ - All deleted data is retained in the log. If users want to remove deleted data records from the project, they should clone the project. Log snapshots will not clear related deletion records.
@@ -0,0 +1,166 @@
1
+ # 3D Shell System
2
+
3
+ ## SHELL Shell
4
+
5
+ ```json
6
+ { "type": "SHELL", "id":"UUID", "ticket": 1 }||
7
+ {
8
+ "partitionId":null,
9
+ "groupId":0,
10
+ "locked":1,
11
+ "zIndex":0.223,
12
+ "shellType":"T&B",
13
+ "shellHeight":50,
14
+ "pcbHeight":100,
15
+ "strokeWidth":10,
16
+ "path":"complex polygon",
17
+ "attrs":{},
18
+ }|
19
+ ```
20
+
21
+ 1. type shell `SHELL`.
22
+ 2. id primitive ID, unique within the document.
23
+ 3. ticket logical clock.
24
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
25
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
26
+ 6. locked whether locked.
27
+ 7. zIndex Z-axis height.
28
+ 8. shellType shell type.
29
+ - `T&B` top & bottom shell.
30
+ - `DRAWER` drawer.
31
+ - `CLAM` clamshell.
32
+ 9. shellHeight shell height.
33
+ 10. pcbHeight PCB height.
34
+ 11. strokeWidth \*line width (deprecated).
35
+ 12. path see complex polygon.
36
+ 13. attrs custom attributes: each 3D shell type has a set of custom shell attributes.
37
+ - T&B
38
+ - Thickness: shell thickness.
39
+ - BottomHeight: bottom shell height.
40
+ - TopInnerHeight: top shell inner wall height.
41
+ - TopInnerThickness: top shell inner wall thickness.
42
+ - DRAWER
43
+ - Thickness: shell thickness.
44
+ - Direction: drawer direction.
45
+ - `1` positive X axis.
46
+ - `2` negative X axis.
47
+ - `4` positive Y axis.
48
+ - `8` negative Y axis.
49
+
50
+ ## CREASE Side Reference Line (Crease)
51
+
52
+ `CREASE` primitives need to be used with `CONNECT` to associate `SHELL_ENTITY` and `BOSS` to express shell slots.
53
+
54
+ ```json
55
+ { "type": "CREASE", "id":"UUID", "ticket": 1 }||
56
+ {
57
+ "partitionId":null,
58
+ "groupId":0,
59
+ "locked":1,
60
+ "zIndex":8.275,
61
+ "layerId":49,
62
+ "startX":20,
63
+ "startY":30,
64
+ "endX":40,
65
+ "endY":50,
66
+ "angle":90,
67
+ }|
68
+ ```
69
+
70
+ 1. type crease `CREASE`.
71
+ 2. id primitive ID, unique within the document.
72
+ 3. ticket logical clock.
73
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
74
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
75
+ 6. locked whether locked.
76
+ 7. zIndex Z-axis height.
77
+ 8. layerId layer.
78
+ 9. startX start X.
79
+ 10. startY start Y.
80
+ 11. endX end X.
81
+ 12. endY end Y.
82
+ 13. angle fold angle.
83
+
84
+ ## SHELL_ENTITY Shell Entity Area
85
+
86
+ A `SHELL_ENTITY` not associated with `CREASE` via `CONNECT` performs vertical fill/cut (slotting) for the top and bottom shells.
87
+
88
+ ```json
89
+ { "type": "SHELL_ENTITY", "id":"UUID", "ticket": 1 }||
90
+ {
91
+ "partitionId":null,
92
+ "groupId":0,
93
+ "locked":1,
94
+ "zIndex":0.15,
95
+ "layerId":50,
96
+ "booleanOperation":0,
97
+ "belong":0,
98
+ "depth":10,
99
+ "strokeWidth":10,
100
+ "path":"complex polygon",
101
+ }|
102
+ ```
103
+
104
+ 1. type shell entity area `SHELL_ENTITY`.
105
+ 2. id primitive ID, unique within the document.
106
+ 3. ticket logical clock.
107
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
108
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
109
+ 6. locked whether locked.
110
+ 7. zIndex Z-axis height.
111
+ 8. layerId layer.
112
+ 9. booleanOperation boolean operation: 0 cut, 1 fill.
113
+ 10. belong affiliation: 0 auto, 1 top shell, 2 bottom shell, 4 shell border, 8 boss, 16 entity. Can be combined by addition.
114
+ - top + bottom shells: 3 = 1 + 2
115
+ - shell border + boss: 12 = 4 + 8
116
+ - boss + entity: 24 = 8 + 16
117
+ - shell border + boss + entity: 28 = 4 + 8 + 16
118
+ 11. depth depth.
119
+ 12. strokeWidth line width.
120
+ 13. path see complex polygon.
121
+
122
+ ## BOSS Boss
123
+
124
+ A `BOSS` associated with `CREASE` via `CONNECT` adds a side boss.
125
+
126
+ ```json
127
+ { "type": "BOSS", "id":"UUID", "ticket": 1 }||
128
+ {
129
+ "partitionId":null,
130
+ "groupId":0,
131
+ "locked":1,
132
+ "zIndex":0.8976,
133
+ "layerId":50,
134
+ "centerX":100,
135
+ "centerY":200,
136
+ "specification":"M2",
137
+ "depth":100,
138
+ "thickness":10,
139
+ "holeDiameter":20,
140
+ "counterBore":[100, 20],
141
+ "stiffener":[20, 40, 20, 10],
142
+ }|
143
+ ```
144
+
145
+ 1. type boss `BOSS`.
146
+ 2. id primitive ID, unique within the document.
147
+ 3. ticket logical clock.
148
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
149
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
150
+ 6. locked whether locked.
151
+ 7. zIndex Z-axis height.
152
+ 8. layerId layer.
153
+ 9. centerX center X.
154
+ 10. centerY center Y.
155
+ 11. specification screw specification: `"M2"`, `"M3"`, etc., or `null` for custom.
156
+ 12. depth boss height.
157
+ 13. thickness boss wall thickness.
158
+ 14. holeDiameter through-hole diameter.
159
+ 15. counterBore counterbore parameters, `null` means no counterbore.
160
+ - screw head height.
161
+ - screw head diameter.
162
+ 16. stiffener rib parameters, `null` means no rib.
163
+ - rib top width.
164
+ - rib bottom width.
165
+ - rib distance from top of boss.
166
+ - rib thickness.
@@ -0,0 +1,63 @@
1
+ # ATTR Attribute
2
+
3
+ Attributes are used to describe properties that the PCB or FOOTPRINT may need to display on the drawing.
4
+
5
+ ```json
6
+ { "type": "ATTR", "id":"UUID", "ticket": 1 }||
7
+ {
8
+ "partitionId":null,
9
+ "groupId":0,
10
+ "locked":1,
11
+ "zIndex":0.072,
12
+ "parentId":"",
13
+ "layerId":1,
14
+ "positionX":200,
15
+ "positionY":150,
16
+ "key":"DESIGNATOR",
17
+ "value":"U1",
18
+ "keyVisible":0,
19
+ "valueVisible":1,
20
+ "fontFamily":"SimSun",
21
+ "fontSize":50,
22
+ "strokeWidth":10,
23
+ "bold":0,
24
+ "italic":0,
25
+ "origin":5,
26
+ "angle":15,
27
+ "reverse":1,
28
+ "reverseExpansion":0,
29
+ "mirror":1,
30
+ "width":100,
31
+ "height":200,
32
+ "path":["complex polygon"],
33
+ }|
34
+ ```
35
+
36
+ 1. type attribute `ATTR`.
37
+ 2. id primitive ID, unique within the document.
38
+ 3. ticket logical clock.
39
+ 4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
40
+ 5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
41
+ 6. locked whether locked.
42
+ 7. zIndex Z-axis height.
43
+ 8. parentId affiliation ID, left blank means current block-level primitive.
44
+ 9. layerId layer.
45
+ 10. positionX position X: fixed to `null` for attributes that have never been displayed.
46
+ 11. positionY position Y: fixed to `null` for attributes that have never been displayed.
47
+ 12. key Key.
48
+ 13. value Value.
49
+ 14. keyVisible whether to display Key.
50
+ 15. valueVisible whether to display Value.
51
+ 16. fontFamily font name.
52
+ 17. fontSize font size.
53
+ 18. strokeWidth stroke width.
54
+ 19. bold whether bold.
55
+ 20. italic whether italic.
56
+ 21. origin alignment mode: `0` top-left, `1` top-center, `2` top-right, `3` middle-left, `4` middle-center, `5` middle-right, `6` bottom-left, `7` bottom-center, `8` bottom-right.
57
+ 22. angle rotation angle.
58
+ 23. reverse whether reverse expansion.
59
+ 24. reverseExpansion reverse expansion size: size of the reverse expansion area, supports negative numbers.
60
+ 25. mirror whether mirrored. Generally, when text appears on the bottom layer, this should also be adjusted to `1`.
61
+ 26. width height, `null` if none.
62
+ 27. height width, `null` if none.
63
+ 28. path complex polygon array, `null` if none.
@@ -0,0 +1,306 @@
1
+ # Common Format
2
+
3
+ This chapter details the format specification of the EasyEDA PCB file. PCB files mainly consist of the following parts:
4
+
5
+ - **Common Format**: Document header, canvas, layer, physical layer, preferences, etc.
6
+ - **Partition Format**: Partition definitions.
7
+ - **Basic Primitives**: Nets, primitive configurations, groups, silkscreen configurations, associations, attributes, etc.
8
+ - **Pads and Vias**: Pads and vias.
9
+ - **Shape Primitives**: Lines, arcs, polygon systems, polylines, fills, regions, copper pours, images, teardrops, etc.
10
+ - **Binary Objects**: Embedded objects.
11
+ - **3D Shell**: Shells, creases, entities, bosses.
12
+ - **Text System**: Text.
13
+ - **Attributes**: Attributes.
14
+ - **Dimension Tools**: Dimension annotations.
15
+ - **Footprint System**: Component instances.
16
+ - **Panelization**: Panelization parameters.
17
+ - **Design Rules**: Rule templates, rules.
18
+
19
+
20
+
21
+ ## Document Header
22
+
23
+ ```json
24
+ { "type": "DOCHEAD" }||{ "docType": "PCB", "uuid": "UUID", "client": "clientID" }|
25
+ ```
26
+
27
+ ```json
28
+ { "type": "DOCHEAD" }||{ "docType": "FOOTPRINT", "uuid": "UUID", "client": "clientID" }|
29
+ ```
30
+
31
+ - type: "DOCHEAD", document header identifier.
32
+ - docType: document type, "PCB" PCB, "FOOTPRINT" footprint.
33
+ - uuid: document unique ID, unique within the project.
34
+ - client: terminal identifier for eventual consistency.
35
+
36
+ ## CANVAS Canvas Configuration
37
+
38
+ ```json
39
+ { "type": "CANVAS", "ticket": 1 }||
40
+ {
41
+ "originX":0,
42
+ "originY":0,
43
+ "unit":"mm",
44
+ "gridXSize":10,
45
+ "gridYSize":10,
46
+ "snapXSize":1,
47
+ "snapYSize":1,
48
+ "altSnapXSize":0.1,
49
+ "altSnapYSize":0.1,
50
+ "gridType":1,
51
+ "multiGridType":0,
52
+ "multiGridRatio":5,
53
+ }|
54
+ ```
55
+
56
+ 1. type canvas configuration `CANVAS`.
57
+ 2. ticket logical clock.
58
+ 3. originX canvas origin X.
59
+ 4. originY canvas origin Y.
60
+ 5. unit **display** unit (does not affect the unit of data in the format).
61
+ 6. gridXSize grid size X.
62
+ 7. gridYSize grid size Y.
63
+ 8. snapXSize snap size X.
64
+ 9. snapYSize snap size Y.
65
+ 10. altSnapXSize Alt snap size X.
66
+ 11. altSnapYSize Alt snap size Y.
67
+ 12. gridType grid type: `0` none, `1` grid, `2` dot.
68
+ 13. multiGridType bold grid type: `0` none, `1` grid, `2` dot.
69
+ 14. multiGridRatio bold grid ratio: number.
70
+
71
+ ## LAYER Layer Configuration
72
+
73
+ - The order in which `SIGNAL`, `PLANE`, and `SUBSTRATE` appear implies their physical stacking order.
74
+ - The number of `SIGNAL`, `PLANE`, and `SUBSTRATE` layers is unlimited.
75
+ - The format does not assume a stable relationship between layer number and layer; specific implementation is decided by the tool.
76
+
77
+ ```json
78
+ { "type": "LAYER","id": 0, "ticket": 1 }||
79
+ {
80
+ "layerType":"TOP",
81
+ "layerName":"Top Layer",
82
+ "status":1,
83
+ "activeColor":"#FF0000",
84
+ "activateTransparency":0.5,
85
+ "inactiveColor":"#880000",
86
+ "inactiveTransparency":0.3,
87
+ }|
88
+ ```
89
+
90
+ 1. type layer `LAYER`.
91
+ 2. id layer number, unique.
92
+ 3. ticket logical clock.
93
+ 4. layerType layer type.
94
+ 5. layerName layer alias, must be unique.
95
+ 6. status status: `1` used, `2` displayed, `4` locked. Can be combined by addition, e.g.
96
+ - used and displayed: 3 = 1 + 2
97
+ - used and locked but not displayed: 5 = 1 + 4
98
+ - used, displayed, and locked: 7 = 1 + 2 + 4
99
+ 7. activeColor active color.
100
+ 8. activateTransparency active transparency.
101
+ 9. inactiveColor inactive color.
102
+ 10. inactiveTransparency inactive transparency.
103
+
104
+ ```json
105
+ ["LAYER",2,"BOTTOM","Bottom Layer",1,"#0000ff",1,"#00007f",1]
106
+ ["LAYER",3,"TOP_SILK","Top Silkscreen Layer",1,"#ffcc00",1,"#7f6600",1]
107
+ ["LAYER",4,"BOT_SILK","Bottom Silkscreen Layer",1,"#66cc33",1,"#336619",1]
108
+ ["LAYER",5,"TOP_SOLDER_MASK","Top Solder Mask Layer",1,"#800080",1,"#400040",1]
109
+ ["LAYER",6,"BOT_SOLDER_MASK","Bottom Solder Mask Layer",1,"#aa00ff",1,"#55007f",1]
110
+ ["LAYER",7,"TOP_PASTE_MASK","Top Paste Mask Layer",1,"#808080",1,"#404040",1]
111
+ ["LAYER",8,"BOT_PASTE_MASK","Bottom Paste Mask Layer",1,"#800000",1,"#400000",1]
112
+ ["LAYER",9,"TOP_ASSEMBLY","Top Assembly Layer",1,"#33cc99",1,"#19664c",1]
113
+ ["LAYER",10,"BOT_ASSEMBLY","Bottom Assembly Layer",1,"#5555ff",1,"#2a2a7f",1]
114
+ ["LAYER",11,"OUTLINE","Board Outline Layer",1,"#ff00ff",1,"#7f007f",1]
115
+ ["LAYER",12,"MULTI","Multi-Layer",1,"#c0c0c0",1,"#606060",1]
116
+ ["LAYER",13,"DOCUMENT","Document Layer",1,"#ffffff",1,"#7f7f7f",1]
117
+ ["LAYER",14,"MECHANICAL","Mechanical Layer",1,"#f022f0",1,"#781178",1]
118
+ ["LAYER",50,"SUBSTRATE","Dialectric1",3,"#999966",1,"#4c4c33",1]
119
+ ["LAYER",15,"SIGNAL","Inner1",3,"#999966",1,"#4c4c33",1]
120
+ ["LAYER",52,"SUBSTRATE","Dialectric3",3,"#999966",1,"#4c4c33",1]
121
+ ["LAYER",51,"SUBSTRATE","Dialectric2",3,"#999966",1,"#4c4c33",1]
122
+ ["LAYER",17,"SIGNAL","Inner2",3,"#008000",1,"#004000",1]
123
+ ["LAYER",58,"SUBSTRATE","Dialectric9",3,"#999966",1,"#4c4c33",1]
124
+ ["LAYER",16,"SIGNAL","Inner3",3,"#999966",1,"#4c4c33",1]
125
+ ["LAYER",53,"SUBSTRATE","Dialectric4",3,"#999966",1,"#4c4c33",1]
126
+ ["LAYER",47,"HOLE","Hole Layer",1,"#222222",1,"#111111",1]
127
+ ["LAYER",48,"SHELL","3D Shell Layer",1,"#222222",1,"#111111",1]
128
+ ["LAYER",49,"TOP_SHELL","Top 3D Shell Layer",1,"#222222",1,"#111111",1]
129
+ ["LAYER",50,"BOT_SHELL","Bottom 3D Shell Layer",1,"#222222",1,"#111111",1]
130
+ ```
131
+
132
+ ## LAYER_PHYS Layer Physical Properties Configuration
133
+
134
+ ```json
135
+ { "type": "LAYER_PHYS","id": 0, "ticket": 1 }||
136
+ {
137
+ "material":"COPPER",
138
+ "thickness":1,
139
+ "permittivity":0,
140
+ "lossTangent":0,
141
+ "isKeepIsland":0,
142
+ }|
143
+ ```
144
+
145
+ 1. type layer physical properties `LAYER_PHYS`.
146
+ 2. id layer number.
147
+ 3. ticket logical clock.
148
+ 4. material layer material.
149
+ 5. thickness thickness.
150
+ 6. permittivity permittivity.
151
+ 7. lossTangent loss tangent.
152
+ 8. isKeepIsland whether to keep islands on internal plane layers.
153
+
154
+ ```json
155
+ { "type": "LAYER_PHYS","id": 2, "ticket": 1 }||
156
+ {
157
+ "material":"COPPER",
158
+ "thickness":1,
159
+ "permittivity":0,
160
+ "lossTangent":0,
161
+ "isKeepIsland":0,
162
+ }|
163
+ ```
164
+
165
+ ```json
166
+ { "type": "LAYER_PHYS","id": 15, "ticket": 1 }||
167
+ {
168
+ "material":"COPPER",
169
+ "thickness":1,
170
+ "permittivity":0,
171
+ "lossTangent":0,
172
+ "isKeepIsland":1,
173
+ }|
174
+ ```
175
+
176
+ ```json
177
+ { "type": "LAYER_PHYS","id": 50, "ticket": 1 }||
178
+ {
179
+ "material":"COPPER",
180
+ "thickness":10,
181
+ "permittivity":4.5,
182
+ "lossTangent":0.02,
183
+ "isKeepIsland":0,
184
+ }|
185
+ ```
186
+
187
+ ## ACTIVE_LAYER Active Layer Configuration
188
+
189
+ ```json
190
+ { "type": "ACTIVE_LAYER", "ticket": 1 }||
191
+ {
192
+ "layerId":0,
193
+ }|
194
+ ```
195
+
196
+ 1. type current active layer `ACTIVE_LAYER`.
197
+ 2. ticket logical clock.
198
+ 3. layerId layer index.
199
+
200
+ ## SILK_OPTS Silkscreen Configuration
201
+
202
+ Silkscreen configuration is currently mainly used for colored silkscreen processes.
203
+
204
+ ```json
205
+ { "type": "SILK_OPTS","id": 3, "ticket": 1 }||
206
+ {
207
+ "defaultColor":"#ffffff",
208
+ "baseColor":"#000000",
209
+ }|
210
+ ```
211
+
212
+ 1. type silkscreen configuration: SILK_OPTS.
213
+ 2. id layer number: only top silkscreen and bottom silkscreen.
214
+ 3. ticket logical clock.
215
+ 4. defaultColor default color.
216
+ 5. baseColor base color.
217
+
218
+ ```json
219
+ { "type": "SILK_OPTS","id": 4, "ticket": 1 }||
220
+ {
221
+ "defaultColor":"#020202",
222
+ "baseColor":"#aaaaaa",
223
+ }|
224
+ ```
225
+
226
+ ## PREFERENCE Preferences
227
+
228
+ ```json
229
+ { "type": "PREFERENCE", "ticket": 1 }||
230
+ {
231
+ "startTrackWidthFollowLast":0,
232
+ "lastTrackWidth":10,
233
+ "startViaSizeFollowLast":0,
234
+ "lastViaInnerDiameter":39.37,
235
+ "lastViaDiameter":78.74,
236
+ "snap":1,
237
+ "routingMode":2,
238
+ "routingCorner":"L45",
239
+ "removeLoop":1,
240
+ "rotatingObject":0,
241
+ "trackFollow":0,
242
+ "stretchTrackMinCorner":1,
243
+ "preferenceConfig":null,
244
+ "realTimeUpdateUnusedLayers":0,
245
+ "unusedPadRange":3,
246
+ "pushVia":"OPTIMIZA_OPEN",
247
+ "pathOptimization4BePushed":0,
248
+ "currentPathOptimization4BePushed":"OPTIMIZA_WEAK",
249
+ "removeCircuitsContainingVias":1,
250
+ "removeAntenna":1,
251
+ }|
252
+ ```
253
+
254
+ 1. type preferences `PREFERENCE`.
255
+ 2. ticket logical clock.
256
+ 3. startTrackWidthFollowLast whether starting track width follows last setting.
257
+ 4. lastTrackWidth last track width.
258
+ 5. startViaSizeFollowLast whether starting via size follows last setting.
259
+ 6. lastViaInnerDiameter last via inner diameter.
260
+ 7. lastViaDiameter last via outer diameter.
261
+ 8. snap whether auto-snap.
262
+ 9. routingMode routing mode: `0` none, `1` push, `2` hug, `3` block.
263
+ 10. routingCorner routing corner mode.
264
+ - `"L45"` line 45 degrees.
265
+ - `"L90"` line 90 degrees.
266
+ - `"R45"` arc 45 degrees.
267
+ - `"R90"` arc 90 degrees.
268
+ - `"L"` free-angle line.
269
+ - `"R"` free-angle arc.
270
+ 11. removeLoop whether routing automatically removes loops.
271
+ 12. rotatingObject whether single-object rotation.
272
+ 13. trackFollow whether tracks follow footprint movement.
273
+ 14. stretchTrackMinCorner stretch track minimum corner ratio (to track width).
274
+ 15. preferenceConfig layer stack preference source.
275
+ 16. realTimeUpdateUnusedLayers whether to automatically remove unused pads.
276
+ 17. unusedPadRange range for removing unused pads.
277
+ 1. all.
278
+ 2. pads only.
279
+ 3. vias only.
280
+ 18. pushVia push via.
281
+ 19. pathOptimization4BePushed path optimization (single segment / whole segment).
282
+ 20. currentPathOptimization4BePushed current track path optimization.
283
+ 21. removeCircuitsContainingVias whether to remove loops containing vias.
284
+ 22. removeAntenna whether to remove antennas.
285
+
286
+ ## ITEM_ORDER Primitive Order Suggestion
287
+
288
+ Provides a primitive order suggestion for the PCB. The PCB can arrange primitive order according to this information. This information can only appear once.
289
+
290
+ ```json
291
+ { "type": "ITEM_ORDER", "ticket": 1 }||{ "ids":["e2", "e1"] }|
292
+ ```
293
+
294
+ 1. type primitive order suggestion: ITEM_ORDER.
295
+ 2. ticket logical clock.
296
+ 3. ids primitive IDs, two encoding forms:
297
+ 1. Normal ID: form `/^[a-z]+\d+$/i`, e.g. `e1`, `e123`.
298
+ 2. Footprint instance ID: form `/^[a-z]+\d+[a-z]+\d+$/i`, used for silkscreen in footprints, e.g. `e1e5`, `e12e22`.
299
+
300
+ To explain why it is called a "suggestion": if `e1` is a top-layer primitive and `e2` is a bottom-layer primitive, then
301
+
302
+ ```json
303
+ { "type": "ITEM_ORDER", "ticket": 1 }||{ "ids":["e2", "e1"] }|
304
+ ```
305
+
306
+ the default is still `e1` on top, unless some special operation causes the bottom layer to be brought to the front.