circuit-json-to-lbrn 0.0.8 → 0.0.10

package/README.md

@@ -7,7 +7,44 @@ Convert Circuit JSON to LBRN XML for PCB fabrication via laser ablation.
 ```tsx
 import { convertCircuitJsonToLbrn } from "circuit-json-to-lbrn"
 
-const lbrnXml = convertCircuitJsonToLbrn(circuitJson, {
-  includeSilkscreen: true,
+// Generate copper layer only
+const copperLbrn = convertCircuitJsonToLbrn(circuitJson, {
+  includeCopper: true,
+  includeSoldermask: false,
 })
+
+// Generate soldermask layer only (for cutting polyimide sheet)
+const soldermaskLbrn = convertCircuitJsonToLbrn(circuitJson, {
+  includeCopper: false,
+  includeSoldermask: true,
+})
+
+// Generate both layers together in one file
+const bothLbrn = convertCircuitJsonToLbrn(circuitJson, {
+  includeCopper: true,
+  includeSoldermask: true,
+})
+
+// Default behavior (copper only, backward compatible)
+const defaultLbrn = convertCircuitJsonToLbrn(circuitJson)
 ```
+
+## Options
+
+- `includeCopper?: boolean` - Include copper traces and pads (default: `true`)
+- `includeSoldermask?: boolean` - Include soldermask openings for cutting polyimide sheet (default: `false`)
+- `includeSilkscreen?: boolean` - Include silkscreen layer (not implemented yet)
+- `origin?: { x: number; y: number }` - Set the origin point for the conversion
+- `margin?: number` - Set the margin around the PCB
+
+## Soldermask Support
+
+The `includeSoldermask` flag enables generation of soldermask openings for cutting polyimide sheet. When enabled:
+- SMT pads and plated holes will have soldermask openings
+- Traces are NOT included in the soldermask layer (to avoid accidental bridging during soldering)
+- Holes are always cut through the board regardless of the mode
+
+You can generate:
+- **Copper only**: `{ includeCopper: true, includeSoldermask: false }` - Traditional copper cutting
+- **Soldermask only**: `{ includeCopper: false, includeSoldermask: true }` - Just polyimide cutting patterns
+- **Both**: `{ includeCopper: true, includeSoldermask: true }` - Complete fabrication file with both layers

package/dist/index.d.ts

@@ -8,6 +8,8 @@ declare const convertCircuitJsonToLbrn: (circuitJson: CircuitJson, options?: {
         y: number;
     };
     margin?: number;
+    includeCopper?: boolean;
+    includeSoldermask?: boolean;
 }) => LightBurnProject;
 
 export { convertCircuitJsonToLbrn };