copperflow 0.3.2 → 0.3.4

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 (243) hide show
  1. package/README.md +39 -0
  2. package/dist/app/assets/{NewPartDialog-Qb7NwhBb.js → NewPartDialog-C4sKWnGI.js} +38 -38
  3. package/dist/app/assets/index-BgzJedaB.css +1 -0
  4. package/dist/app/assets/index-C_U9me2P.js +19 -0
  5. package/dist/app/index.html +2 -2
  6. package/dist/cli-commands.d.ts +3 -0
  7. package/dist/cli-commands.js +74 -8
  8. package/dist/cli-commands.js.map +1 -1
  9. package/dist/cli-library.d.ts +5 -0
  10. package/dist/cli-library.js +58 -0
  11. package/dist/cli-library.js.map +1 -0
  12. package/dist/cli-modules.d.ts +6 -0
  13. package/dist/cli-modules.js +33 -0
  14. package/dist/cli-modules.js.map +1 -0
  15. package/dist/cli-studio.d.ts +1 -0
  16. package/dist/cli-studio.js +27 -0
  17. package/dist/cli-studio.js.map +1 -0
  18. package/dist/core/board-import.d.ts +39 -0
  19. package/dist/core/board-import.js +114 -0
  20. package/dist/core/board-import.js.map +1 -0
  21. package/dist/core/board-shape-edit.d.ts +13 -0
  22. package/dist/core/board-shape-edit.js +134 -0
  23. package/dist/core/board-shape-edit.js.map +1 -0
  24. package/dist/core/edit.js +9 -3
  25. package/dist/core/edit.js.map +1 -1
  26. package/dist/core/fabrication.d.ts +6 -0
  27. package/dist/core/fabrication.js +1 -1
  28. package/dist/core/fabrication.js.map +1 -1
  29. package/dist/core/git.d.ts +16 -0
  30. package/dist/core/git.js +51 -0
  31. package/dist/core/git.js.map +1 -0
  32. package/dist/core/home.d.ts +2 -0
  33. package/dist/core/home.js +10 -0
  34. package/dist/core/home.js.map +1 -0
  35. package/dist/core/index.d.ts +2 -0
  36. package/dist/core/index.js +2 -0
  37. package/dist/core/index.js.map +1 -1
  38. package/dist/core/instance-copper.d.ts +25 -0
  39. package/dist/core/instance-copper.js +142 -0
  40. package/dist/core/instance-copper.js.map +1 -0
  41. package/dist/core/instance-move.d.ts +23 -0
  42. package/dist/core/instance-move.js +59 -0
  43. package/dist/core/instance-move.js.map +1 -0
  44. package/dist/core/instance-requests.d.ts +3 -2
  45. package/dist/core/instance-requests.js +17 -3
  46. package/dist/core/instance-requests.js.map +1 -1
  47. package/dist/core/library-modules.d.ts +29 -0
  48. package/dist/core/library-modules.js +324 -0
  49. package/dist/core/library-modules.js.map +1 -0
  50. package/dist/core/library-sources.d.ts +33 -0
  51. package/dist/core/library-sources.js +179 -0
  52. package/dist/core/library-sources.js.map +1 -0
  53. package/dist/core/modules.d.ts +44 -0
  54. package/dist/core/modules.js +284 -0
  55. package/dist/core/modules.js.map +1 -0
  56. package/dist/core/new-circuit-sheets.d.ts +11 -2
  57. package/dist/core/new-circuit-sheets.js +35 -6
  58. package/dist/core/new-circuit-sheets.js.map +1 -1
  59. package/dist/core/placement-write.d.ts +2 -0
  60. package/dist/core/placement-write.js +12 -6
  61. package/dist/core/placement-write.js.map +1 -1
  62. package/dist/core/plain-sheet.d.ts +12 -0
  63. package/dist/core/plain-sheet.js +169 -0
  64. package/dist/core/plain-sheet.js.map +1 -0
  65. package/dist/core/render.d.ts +45 -0
  66. package/dist/core/render.js +57 -0
  67. package/dist/core/render.js.map +1 -0
  68. package/dist/core/sheet-card.d.ts +33 -0
  69. package/dist/core/sheet-card.js +118 -0
  70. package/dist/core/sheet-card.js.map +1 -0
  71. package/dist/core/types.d.ts +20 -0
  72. package/dist/core/workspace.d.ts +4 -0
  73. package/dist/core/workspace.js +13 -2
  74. package/dist/core/workspace.js.map +1 -1
  75. package/dist/engine/checks/drc-parts.js +7 -7
  76. package/dist/engine/checks/drc-parts.js.map +1 -1
  77. package/dist/engine/checks/erc.js +35 -3
  78. package/dist/engine/checks/erc.js.map +1 -1
  79. package/dist/engine/component.d.ts +2 -0
  80. package/dist/engine/component.js +18 -1
  81. package/dist/engine/component.js.map +1 -1
  82. package/dist/engine/dxf/board.d.ts +42 -0
  83. package/dist/engine/dxf/board.js +218 -0
  84. package/dist/engine/dxf/board.js.map +1 -0
  85. package/dist/engine/dxf/index.d.ts +2 -0
  86. package/dist/engine/dxf/index.js +3 -0
  87. package/dist/engine/dxf/index.js.map +1 -0
  88. package/dist/engine/dxf/reader.d.ts +43 -0
  89. package/dist/engine/dxf/reader.js +142 -0
  90. package/dist/engine/dxf/reader.js.map +1 -0
  91. package/dist/engine/elaborate.js +14 -4
  92. package/dist/engine/elaborate.js.map +1 -1
  93. package/dist/engine/fab/designator-places.d.ts +101 -0
  94. package/dist/engine/fab/designator-places.js +259 -0
  95. package/dist/engine/fab/designator-places.js.map +1 -0
  96. package/dist/engine/fab/designators.d.ts +26 -14
  97. package/dist/engine/fab/designators.js +320 -70
  98. package/dist/engine/fab/designators.js.map +1 -1
  99. package/dist/engine/fab/layers.js +6 -6
  100. package/dist/engine/fab/layers.js.map +1 -1
  101. package/dist/engine/fab/stroke-font.d.ts +2 -2
  102. package/dist/engine/fab/stroke-font.js +7 -6
  103. package/dist/engine/fab/stroke-font.js.map +1 -1
  104. package/dist/engine/footprints/file.d.ts +33 -0
  105. package/dist/engine/footprints/file.js +13 -5
  106. package/dist/engine/footprints/file.js.map +1 -1
  107. package/dist/engine/model.d.ts +15 -1
  108. package/dist/engine/model.js.map +1 -1
  109. package/dist/engine/pcb-place/block-board.d.ts +9 -0
  110. package/dist/engine/pcb-place/block-board.js +256 -0
  111. package/dist/engine/pcb-place/block-board.js.map +1 -0
  112. package/dist/engine/pcb-place/blocks.d.ts +31 -6
  113. package/dist/engine/pcb-place/blocks.js +37 -8
  114. package/dist/engine/pcb-place/blocks.js.map +1 -1
  115. package/dist/engine/pcb-place/constructive.d.ts +3 -2
  116. package/dist/engine/pcb-place/constructive.js +14 -2
  117. package/dist/engine/pcb-place/constructive.js.map +1 -1
  118. package/dist/engine/pcb-place/index.d.ts +8 -0
  119. package/dist/engine/pcb-place/index.js +7 -0
  120. package/dist/engine/pcb-place/index.js.map +1 -1
  121. package/dist/engine/pcb-place/scope.js +6 -1
  122. package/dist/engine/pcb-place/scope.js.map +1 -1
  123. package/dist/engine/pcb.d.ts +6 -0
  124. package/dist/engine/pcb.js +12 -1
  125. package/dist/engine/pcb.js.map +1 -1
  126. package/dist/engine/router/replicate.js +4 -0
  127. package/dist/engine/router/replicate.js.map +1 -1
  128. package/dist/engine/router/route-board.d.ts +2 -0
  129. package/dist/engine/router/route-board.js +27 -1
  130. package/dist/engine/router/route-board.js.map +1 -1
  131. package/dist/engine/sheet-ports.d.ts +17 -1
  132. package/dist/engine/sheet-ports.js +38 -1
  133. package/dist/engine/sheet-ports.js.map +1 -1
  134. package/dist/mcp/batch.d.ts +2 -2
  135. package/dist/mcp/batch.js +12 -12
  136. package/dist/mcp/batch.js.map +1 -1
  137. package/dist/mcp/board-import-tool.d.ts +25 -0
  138. package/dist/mcp/board-import-tool.js +25 -0
  139. package/dist/mcp/board-import-tool.js.map +1 -0
  140. package/dist/mcp/board-summary.d.ts +1 -1
  141. package/dist/mcp/board-summary.js +1 -1
  142. package/dist/mcp/board-summary.js.map +1 -1
  143. package/dist/mcp/compact.js +17 -5
  144. package/dist/mcp/compact.js.map +1 -1
  145. package/dist/mcp/copper-tools.d.ts +4 -4
  146. package/dist/mcp/copper-tools.js +19 -19
  147. package/dist/mcp/copper-tools.js.map +1 -1
  148. package/dist/mcp/create-part.d.ts +4 -4
  149. package/dist/mcp/create-part.js +12 -10
  150. package/dist/mcp/create-part.js.map +1 -1
  151. package/dist/mcp/datasheet-tools.d.ts +1 -1
  152. package/dist/mcp/datasheet-tools.js +4 -4
  153. package/dist/mcp/datasheet-tools.js.map +1 -1
  154. package/dist/mcp/fillet-tools.d.ts +2 -2
  155. package/dist/mcp/fillet-tools.js +6 -6
  156. package/dist/mcp/fillet-tools.js.map +1 -1
  157. package/dist/mcp/guide.d.ts +1 -1
  158. package/dist/mcp/guide.js +4 -3
  159. package/dist/mcp/guide.js.map +1 -1
  160. package/dist/mcp/import-part.d.ts +1 -1
  161. package/dist/mcp/import-part.js +4 -4
  162. package/dist/mcp/import-part.js.map +1 -1
  163. package/dist/mcp/make-sheet.d.ts +1 -1
  164. package/dist/mcp/make-sheet.js +6 -6
  165. package/dist/mcp/make-sheet.js.map +1 -1
  166. package/dist/mcp/module-tools.d.ts +4 -0
  167. package/dist/mcp/module-tools.js +21 -0
  168. package/dist/mcp/module-tools.js.map +1 -0
  169. package/dist/mcp/new-circuit.d.ts +13 -2
  170. package/dist/mcp/new-circuit.js +30 -28
  171. package/dist/mcp/new-circuit.js.map +1 -1
  172. package/dist/mcp/open-studio.d.ts +30 -0
  173. package/dist/mcp/open-studio.js +97 -0
  174. package/dist/mcp/open-studio.js.map +1 -0
  175. package/dist/mcp/place-tools.d.ts +2 -2
  176. package/dist/mcp/place-tools.js +14 -11
  177. package/dist/mcp/place-tools.js.map +1 -1
  178. package/dist/mcp/pour-tools.d.ts +4 -4
  179. package/dist/mcp/pour-tools.js +18 -18
  180. package/dist/mcp/pour-tools.js.map +1 -1
  181. package/dist/mcp/project-tools.d.ts +3 -3
  182. package/dist/mcp/project-tools.js +8 -8
  183. package/dist/mcp/project-tools.js.map +1 -1
  184. package/dist/mcp/render-tool.d.ts +30 -0
  185. package/dist/mcp/render-tool.js +33 -0
  186. package/dist/mcp/render-tool.js.map +1 -0
  187. package/dist/mcp/route-tools.d.ts +2 -2
  188. package/dist/mcp/route-tools.js +10 -10
  189. package/dist/mcp/route-tools.js.map +1 -1
  190. package/dist/mcp/server.d.ts +3 -0
  191. package/dist/mcp/server.js +49 -31
  192. package/dist/mcp/server.js.map +1 -1
  193. package/dist/mcp/sheet-card-tools.d.ts +28 -0
  194. package/dist/mcp/sheet-card-tools.js +45 -0
  195. package/dist/mcp/sheet-card-tools.js.map +1 -0
  196. package/dist/render/render.js +2060 -0
  197. package/dist/studio/idle.d.ts +7 -0
  198. package/dist/studio/idle.js +34 -0
  199. package/dist/studio/idle.js.map +1 -0
  200. package/dist/studio/place-runner.js +1 -1
  201. package/dist/studio/place-runner.js.map +1 -1
  202. package/dist/studio/run-studio.d.ts +21 -0
  203. package/dist/studio/run-studio.js +68 -0
  204. package/dist/studio/run-studio.js.map +1 -0
  205. package/dist/studio/server.d.ts +5 -0
  206. package/dist/studio/server.js +24 -2
  207. package/dist/studio/server.js.map +1 -1
  208. package/dist/studio/studio-control.d.ts +6 -0
  209. package/dist/studio/studio-control.js +14 -0
  210. package/dist/studio/studio-control.js.map +1 -0
  211. package/dist/studio/studio-note.d.ts +33 -0
  212. package/dist/studio/studio-note.js +130 -0
  213. package/dist/studio/studio-note.js.map +1 -0
  214. package/dist/version.d.ts +1 -1
  215. package/dist/version.js +1 -1
  216. package/library/modules/CanNode/CanNode.sheet.tsx +65 -0
  217. package/library/modules/CanNode/module.json +4 -0
  218. package/library/modules/CanNode/parts/MCP2515-I-SO/MCP2515_I_SO.tsx +10 -0
  219. package/library/modules/CanNode/parts/MCP2515-I-SO/part.yaml +64 -0
  220. package/library/modules/CanNode/parts/MCP2515-I-SO/verification.md +42 -0
  221. package/library/modules/CanNode/parts/TJA1051T-3/TJA1051T_3.tsx +10 -0
  222. package/library/modules/CanNode/parts/TJA1051T-3/part.yaml +34 -0
  223. package/library/modules/CanNode/parts/TJA1051T-3/verification.md +28 -0
  224. package/library/modules/DigitalInput24V/DigitalInput24V.sheet.tsx +24 -0
  225. package/library/modules/DigitalInput24V/module.json +4 -0
  226. package/library/modules/RelayDriver/RelayDriver.sheet.tsx +39 -0
  227. package/library/modules/RelayDriver/module.json +4 -0
  228. package/library/modules/RelayDriver/parts/AO3400A/AO3400A.tsx +11 -0
  229. package/library/modules/RelayDriver/parts/AO3400A/part.yaml +21 -0
  230. package/library/modules/RelayDriver/parts/AO3400A/verification.md +24 -0
  231. package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/SRD_12VDC_SL_C.tsx +11 -0
  232. package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/footprint.yaml +70 -0
  233. package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/part.yaml +31 -0
  234. package/library/modules/RelayDriver/parts/SRD-12VDC-SL-C/verification.md +37 -0
  235. package/package.json +6 -2
  236. package/skills/copperflow/SKILL.md +20 -20
  237. package/skills/copperflow/references/copper.md +83 -6
  238. package/skills/copperflow/references/modules.md +80 -0
  239. package/skills/copperflow/references/planning.md +55 -11
  240. package/skills/copperflow/references/writing-circuits.md +29 -3
  241. package/skills/copperflow-plan/SKILL.md +7 -4
  242. package/dist/app/assets/index-CSWIIMFE.css +0 -1
  243. package/dist/app/assets/index-C_TXwo-N.js +0 -19
package/README.md CHANGED
@@ -72,6 +72,14 @@ copperflow skill
72
72
  Any other MCP client can run `copperflow mcp` over stdio from the project folder
73
73
  (or pass `--root <dir>`).
74
74
 
75
+ Without installing, the same server starts through npx: give `npx -y copperflow mcp` wherever a
76
+ client asks for the command. The first start takes about a quarter of a minute while npm fetches
77
+ the package.
78
+
79
+ An agent that can run commands can set copperflow up for itself: the steps are at
80
+ <https://copperflow.kurpeeren.com/llms.txt> as plain text. Most programs load their MCP servers
81
+ when a session starts, so the tools appear in the next session, not in the one that added them.
82
+
75
83
  ### Open the visual editor
76
84
 
77
85
  ```bash
@@ -81,6 +89,10 @@ copperflow studio --root examples/usb-c-ldo
81
89
  Then open the address it prints. The address carries a key for this session, so other web
82
90
  pages and other programs on your computer cannot use the editor's API.
83
91
 
92
+ A connected agent opens it for you: ask it to open copperflow and it calls `open_studio`, which
93
+ starts the editor for the project if none runs and opens it in your browser. An editor started
94
+ that way stops by itself an hour after the last tab closes; `copperflow studio stop` stops it at once.
95
+
84
96
  The schematic and the PCB are drawn from the design copperflow's engine builds, with
85
97
  copperflow's own footprints and schematic symbols. The PCB shows the ratsnest, a straight line
86
98
  for each connection still to be made, until routing arrives: hand routing in stage 4 and the
@@ -201,6 +213,7 @@ The agent sees what you undid and does not repeat it.
201
213
  | `new_circuit` | Writes a whole new circuit from a netlist in one call: parts (a built-in `kind` or a library `part`, `value`, `footprint`, `props` such as `pinCount` or a `pinLabels` object to name pins, no positions) and `nets` (`{ GND: ["R1.pin2", "U1.GND"] }`, no wire corners). Pins are checked first (a wrong one is refused with the part's real pin names); an existing file needs `replace: true`; one history entry, and undo removes the file. It then places the board (`autoplace`, a second entry; the board is fitted when no `board` size is given) unless `place: false` |
202
214
  | `autoplace` | Places the parts nobody placed or locked (or only `parts`, or one `instance`) by their connections, as one change: answers "Placed 12 parts; wire length 184 mm (was 412); board 42 × 28 mm; 0 overlaps", then the parts it found no room for and its notes; `fit: true` fits the board too; `budgetSeconds` (20 s by default); `connectors: "ahead"` tries each connector beside the part it serves (route and compare before keeping it) |
203
215
  | `fit_board` | Shrinks or grows a rectangular board to the parts' courtyards plus `margin` (2 mm by default), as one change |
216
+ | `import_board` | Sets the board's outline, mounting holes and keepouts from a DXF drawing in the project folder, as one change |
204
217
  | `edit_circuit` | Several edits in one call, applied as one change (one history entry); stops at the first refused edit and writes nothing |
205
218
  | `connect_nets` | Connects many pins to named nets in one call, e.g. `{ "GND": ["R1.pin2", "C1.pin2"] }` |
206
219
  | `route_track` | Draws one track of a net by hand from a pad, track or via of that net, as one change; refused when a point lands on another net's copper; the answer lists the copper violations it introduced |
@@ -208,6 +221,8 @@ The agent sees what you undid and does not repeat it.
208
221
  | `fillet_tracks` / `straighten_tracks` | Rounds the square corners of tracks (by id, or every track) into short chords on an arc of the design rules' fillet radius, or puts rounded corners back, each as one change; a corner too close to other copper, a pad, a keepout or the board edge, or with legs too short, stays square and is counted |
209
222
  | `copper_summary` | Per net: tracks, vias, length and unrouted connections, then copper violations by rule (at most 60 lines) |
210
223
  | `board_summary` / `project_status` / `note_decision` / `set_project` | The board in about 60 lines (size, one line per part, longest connections with both pads' places, overlaps, edge, pours; `detail: "full"` for the rest); and the project memory `PROJECT.md` (Intent, Blocks, Decisions, Open) with each circuit's counts and last changes, a dated decision, or rewritten sections, each write one change |
224
+ | `open_studio` | Starts the Studio for the project if none runs, opens it in your browser and answers with the address |
225
+ | `render` | A PNG of the board or of one schematic page, drawn by the Studio's own code; `parts` zooms to some parts (needs the optional package `@napi-rs/canvas`) |
211
226
  | `list_parts` / `part_info` | Shows the parts library and a part's data and checklist |
212
227
  | `create_part` | Adds a part from a datasheet: pins, footprint string or footprint file, MPN, suppliers |
213
228
  | `import_part` | Fetches one part by its LCSC number from EasyEDA into `parts/<id>/`, unverified, for personal, non-commercial use only (see [licences](docs/licences.md)) |
@@ -243,10 +258,34 @@ copperflow place <file> <part> <name> [key=value ...]
243
258
  copperflow bom <file> [--csv] print the bill of materials
244
259
  copperflow package <file> [--out dir]
245
260
  write BOM, datasheets and part status to a folder
261
+ copperflow render <file> [--view pcb|schematic] [--page <name>] [--parts U1,C3] [--width n] [--out file.png]
262
+ draw the board or a schematic page to a PNG, as the Studio shows it
263
+ copperflow board <file> --dxf <path> [--layer <name>] [--units mm|inch] [--origin keep] [--replace]
264
+ set the board's outline, holes and keepouts from a DXF drawing
246
265
  copperflow history [--limit n] list recent changes
247
266
  copperflow undo [id] undo the newest change, or the given one
248
267
  ```
249
268
 
269
+ ## Libraries
270
+
271
+ A library is a folder of modules laid out as the shelf is: `modules/<Name>/` (or `<Name>/` at the top
272
+ when there is no `modules` folder), each holding `<Name>.sheet.tsx`, `parts/<id>/part.yaml` (and
273
+ `footprint.yaml`) and an optional `module.json`. copperflow comes with one, named `copperflow`; you
274
+ add your own:
275
+
276
+ ```text
277
+ copperflow library add <name> <git address or folder> [--ref <branch or tag>]
278
+ copperflow library update [name]
279
+ copperflow library remove <name>
280
+ ```
281
+
282
+ `copperflow library` lists them. The agent sees their modules as `<library>/<Name>` in
283
+ `list_modules`, `module_info` and `use_module`. A circuit file is code that runs when the board
284
+ builds, so a sheet from a library enters a project only when copperflow has proved it plain (part
285
+ imports, one function returning tags with literal values, nothing else), and its parts come as data,
286
+ their component files written by copperflow. A library module reads NOT verified until you run
287
+ `copperflow modules verify <library>/<Name> --by <name>`.
288
+
250
289
  ## Roadmap
251
290
 
252
291
  - **0.2** (done) Visual editor in the browser: drag, rotate, lock, delete and reconnect wires, marks.