circuit-json-to-lbrn 0.0.24 → 0.0.26

package/.github/workflows/bun-test.yml

@@ -28,4 +28,4 @@ jobs:
         run: bun install
 
       - name: Run tests
-        run: bun test
+        run: bun test --timeout 30000

package/README.md

@@ -38,6 +38,7 @@ const defaultLbrn = convertCircuitJsonToLbrn(circuitJson)
 - `margin?: number` - Set the margin around the PCB
 - `traceMargin?: number` - Clearance margin around traces in mm (requires `includeCopper: true`)
 - `laserSpotSize?: number` - Laser spot size in mm for crosshatch spacing (default: `0.005`)
+- `laserProfile?: { copper?: { speed?: number; numPasses?: number; frequency?: number; pulseWidth?: number }; board?: { speed?: number; numPasses?: number; frequency?: number; pulseWidth?: number } }` - Custom laser cut settings for copper and board operations. Defaults from GitHub issue: copper (speed: 300 mm/s, numPasses: 100, frequency: 20 kHz, pulseWidth: 1 ns), board (speed: 20 mm/s, numPasses: 100, frequency: 20 kHz, pulseWidth: 1 ns). Allows per-user customization for different lasers/lenses.
 - `includeLayers?: Array<"top" | "bottom">` - Specify which layers to include (default: `["top", "bottom"]`)
 
 ## Soldermask Support

package/dist/index.d.ts

@@ -14,6 +14,20 @@ declare const convertCircuitJsonToLbrn: (circuitJson: CircuitJson, options?: {
     includeLayers?: Array<"top" | "bottom">;
     traceMargin?: number;
     laserSpotSize?: number;
+    laserProfile?: {
+        copper?: {
+            speed?: number;
+            numPasses?: number;
+            frequency?: number;
+            pulseWidth?: number;
+        };
+        board?: {
+            speed?: number;
+            numPasses?: number;
+            frequency?: number;
+            pulseWidth?: number;
+        };
+    };
 }) => LightBurnProject;
 
 export { convertCircuitJsonToLbrn };

package/dist/index.js

@@ -2548,6 +2548,21 @@ var convertCircuitJsonToLbrn = (circuitJson, options = {}) => {
   const includeCopper = options.includeCopper ?? true;
   const includeSoldermask = options.includeSoldermask ?? false;
   const soldermaskMargin = options.soldermaskMargin ?? 0;
+  const laserProfile = options.laserProfile;
+  const defaultCopperSettings = {
+    speed: 300,
+    numPasses: 100,
+    frequency: 2e4,
+    pulseWidth: 1e-9
+  };
+  const defaultBoardSettings = {
+    speed: 20,
+    numPasses: 100,
+    frequency: 2e4,
+    pulseWidth: 1e-9
+  };
+  const copperSettings = { ...defaultCopperSettings, ...laserProfile?.copper };
+  const boardSettings = { ...defaultBoardSettings, ...laserProfile?.board };
   const shouldGenerateTraceClearanceZones = traceMargin > 0 && includeCopper;
   if (traceMargin > 0 && !includeCopper) {
     throw new Error("traceMargin requires includeCopper to be true");
@@ -2555,22 +2570,28 @@ var convertCircuitJsonToLbrn = (circuitJson, options = {}) => {
   const topCopperCutSetting = new CutSetting({
     index: 0,
     name: "Cut Top Copper",
-    numPasses: 12,
-    speed: 100
+    numPasses: copperSettings.numPasses,
+    speed: copperSettings.speed,
+    frequency: copperSettings.frequency,
+    pulseWidth: copperSettings.pulseWidth
   });
   project.children.push(topCopperCutSetting);
   const bottomCopperCutSetting = new CutSetting({
     index: 1,
     name: "Cut Bottom Copper",
-    numPasses: 12,
-    speed: 100
+    numPasses: copperSettings.numPasses,
+    speed: copperSettings.speed,
+    frequency: copperSettings.frequency,
+    pulseWidth: copperSettings.pulseWidth
   });
   project.children.push(bottomCopperCutSetting);
   const throughBoardCutSetting = new CutSetting({
     index: 2,
     name: "Cut Through Board",
-    numPasses: 3,
-    speed: 50
+    numPasses: boardSettings.numPasses,
+    speed: boardSettings.speed,
+    frequency: boardSettings.frequency,
+    pulseWidth: boardSettings.pulseWidth
   });
   project.children.push(throughBoardCutSetting);
   const soldermaskCutSetting = new CutSetting({

package/lib/index.ts

@@ -29,6 +29,20 @@ export const convertCircuitJsonToLbrn = (
     includeLayers?: Array<"top" | "bottom">
     traceMargin?: number
     laserSpotSize?: number
+    laserProfile?: {
+      copper?: {
+        speed?: number
+        numPasses?: number
+        frequency?: number
+        pulseWidth?: number
+      }
+      board?: {
+        speed?: number
+        numPasses?: number
+        frequency?: number
+        pulseWidth?: number
+      }
+    }
   } = {},
 ): LightBurnProject => {
   const db = cju(circuitJson)
@@ -44,6 +58,25 @@ export const convertCircuitJsonToLbrn = (
   const includeCopper = options.includeCopper ?? true
   const includeSoldermask = options.includeSoldermask ?? false
   const soldermaskMargin = options.soldermaskMargin ?? 0
+  const laserProfile = options.laserProfile
+
+  // Default laser settings from GitHub issue
+  const defaultCopperSettings = {
+    speed: 300,
+    numPasses: 100,
+    frequency: 20000,
+    pulseWidth: 1e-9,
+  }
+  const defaultBoardSettings = {
+    speed: 20,
+    numPasses: 100,
+    frequency: 20000,
+    pulseWidth: 1e-9,
+  }
+
+  // Merge user settings with defaults
+  const copperSettings = { ...defaultCopperSettings, ...laserProfile?.copper }
+  const boardSettings = { ...defaultBoardSettings, ...laserProfile?.board }
 
   // Determine if we should generate trace clearance zones
   const shouldGenerateTraceClearanceZones = traceMargin > 0 && includeCopper
@@ -57,24 +90,30 @@ export const convertCircuitJsonToLbrn = (
   const topCopperCutSetting = new CutSetting({
     index: 0,
     name: "Cut Top Copper",
-    numPasses: 12,
-    speed: 100,
+    numPasses: copperSettings.numPasses,
+    speed: copperSettings.speed,
+    frequency: copperSettings.frequency,
+    pulseWidth: copperSettings.pulseWidth,
   })
   project.children.push(topCopperCutSetting)
 
   const bottomCopperCutSetting = new CutSetting({
     index: 1,
     name: "Cut Bottom Copper",
-    numPasses: 12,
-    speed: 100,
+    numPasses: copperSettings.numPasses,
+    speed: copperSettings.speed,
+    frequency: copperSettings.frequency,
+    pulseWidth: copperSettings.pulseWidth,
   })
   project.children.push(bottomCopperCutSetting)
 
   const throughBoardCutSetting = new CutSetting({
     index: 2,
     name: "Cut Through Board",
-    numPasses: 3,
-    speed: 50,
+    numPasses: boardSettings.numPasses,
+    speed: boardSettings.speed,
+    frequency: boardSettings.frequency,
+    pulseWidth: boardSettings.pulseWidth,
   })
   project.children.push(throughBoardCutSetting)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "circuit-json-to-lbrn",
   "main": "dist/index.js",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "type": "module",
   "scripts": {
     "start": "bun run site/index.html",
@@ -28,6 +28,6 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "lbrnts": "^0.0.8"
+    "lbrnts": "^0.0.9"
   }
 }

package/site/index.html

@@ -66,63 +66,178 @@
              <label class="block text-sm font-medium text-gray-300 mb-2">
                Origin X (mm)
              </label>
-             <input
-               type="number"
-               id="originX"
-               value="0"
-               step="0.1"
-               class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
-             />
+              <input
+                type="number"
+                id="originX"
+                value="0"
+                step="0.1"
+                class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
+              />
            </div>
            <div>
              <label class="block text-sm font-medium text-gray-300 mb-2">
                Origin Y (mm)
              </label>
-             <input
-               type="number"
-               id="originY"
-               value="0"
-               step="0.1"
-               class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
-             />
+              <input
+                type="number"
+                id="originY"
+                value="0"
+                step="0.1"
+                class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
+              />
            </div>
            <div>
              <label class="block text-sm font-medium text-gray-300 mb-2">
                Trace Margin (mm)
              </label>
-             <input
-               type="number"
-               id="traceMargin"
-               value="0"
-               step="0.001"
-               class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
-             />
+              <input
+                type="number"
+                id="traceMargin"
+                value="0"
+                step="0.001"
+                class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
+              />
            </div>
            <div>
              <label class="block text-sm font-medium text-gray-300 mb-2">
                Soldermask Margin (mm)
              </label>
-             <input
-               type="number"
-               id="soldermaskMargin"
-               value="0"
-               step="0.001"
-               class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
-             />
+              <input
+                type="number"
+                id="soldermaskMargin"
+                value="0"
+                step="0.001"
+                class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
+              />
            </div>
-           <div>
-             <label class="block text-sm font-medium text-gray-300 mb-2">
-               Laser Spot Size (mm)
-             </label>
-             <input
-               type="number"
-               id="laserSpotSize"
-               value="0.005"
-               step="0.001"
-               class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
-             />
-           </div>
-           <div class="md:col-span-2 grid grid-cols-1 md:grid-cols-3 gap-4">
+            <div>
+              <label class="block text-sm font-medium text-gray-300 mb-2">
+                Laser Spot Size (mm)
+              </label>
+               <input
+                 type="number"
+                 id="laserSpotSize"
+                 value="0.005"
+                 step="0.001"
+                 class="w-full px-4 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500"
+               />
+            </div>
+            <div class="md:col-span-2">
+              <details class="group">
+                <summary class="w-full text-md font-medium text-gray-300 mb-3 flex items-center justify-between bg-blue-500 hover:bg-blue-700 border border-gray-600 rounded-lg px-4 py-3 transition-colors cursor-pointer">
+                  <span>Laser Cut Settings</span>
+                  <span class="text-sm text-gray-100 group-open:rotate-90 transition-transform duration-200">▶</span>
+                </summary>
+                 <div class="space-y-4 border border-gray-600 rounded-lg p-4 bg-gray-750">
+                   <div class="flex items-center justify-between p-3 bg-gray-750 rounded-lg">
+                     <div class="col-span-2">
+                       <label class="block text-sm font-medium text-gray-300 mb-2">Preset</label>
+                       <select id="presetSelect" class="w-full px-3 py-2 bg-gray-700 border border-gray-600 rounded-lg text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm">
+                         <option value="default">Default</option>
+                         <option value="omni-x-6w">Omni X 6W 150x150 - Continuous cutting with conductivity checks</option>
+                         <!-- Add more options here -->
+                       </select>
+                     </div>
+                   </div>
+                 <table class="w-full text-sm text-gray-300">
+                   <thead>
+                     <tr class="border-b border-gray-600">
+                       <th class="text-left py-2">Layer</th>
+                       <th class="text-left py-2">Speed (mm/s)</th>
+                       <th class="text-left py-2">Passes</th>
+                       <th class="text-left py-2">Frequency (kHz)</th>
+                       <th class="text-left py-2">Pulse Width (ns)</th>
+                     </tr>
+                   </thead>
+                   <tbody>
+                     <tr class="border-b border-gray-700">
+                       <td class="py-2 font-medium">Copper Cut Settings</td>
+                       <td class="py-2">
+                          <input
+                            type="number"
+                            id="copperSpeed"
+                            value="300"
+                            step="1"
+                            title="Cutting speed for copper layers"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                        </td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="copperNumPasses"
+                            value="1"
+                            step="1"
+                            title="Number of passes for copper ablation"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                        </td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="copperFrequency"
+                            value="20"
+                            step="1"
+                            title="Laser pulse frequency"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                        </td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="copperPulseWidth"
+                            value="1"
+                            step="0.1"
+                            title="Laser pulse width"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                       </td>
+                     </tr>
+                     <tr>
+                       <td class="py-2 font-medium">Board Laser Settings</td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="boardSpeed"
+                            value="20"
+                            step="1"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                        </td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="boardNumPasses"
+                            value="1"
+                            step="1"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                        </td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="boardFrequency"
+                            value="20"
+                            step="1"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                        </td>
+                        <td class="py-2">
+                          <input
+                            type="number"
+                            id="boardPulseWidth"
+                            value="1"
+                            step="0.1"
+                            class="w-full px-3 py-2 bg-gray-700 border border-gray-600 text-white focus:outline-none focus:ring-2 focus:ring-blue-500 text-sm"
+                          />
+                       </td>
+                     </tr>
+                   </tbody>
+                 </table>
+                 </div>
+              </details>
+            </div>
+            <div class="md:col-span-2 grid grid-cols-1 md:grid-cols-3 gap-4">
              <label class="flex items-center cursor-pointer">
                <input
                  type="checkbox"

package/site/main.tsx

@@ -57,10 +57,81 @@ const includeTopLayerInput = document.getElementById(
 const includeBottomLayerInput = document.getElementById(
   "includeBottomLayer",
 ) as HTMLInputElement
+const copperSpeedInput = document.getElementById(
+  "copperSpeed",
+) as HTMLInputElement
+const copperNumPassesInput = document.getElementById(
+  "copperNumPasses",
+) as HTMLInputElement
+const copperFrequencyInput = document.getElementById(
+  "copperFrequency",
+) as HTMLInputElement
+const copperPulseWidthInput = document.getElementById(
+  "copperPulseWidth",
+) as HTMLInputElement
+const boardSpeedInput = document.getElementById(
+  "boardSpeed",
+) as HTMLInputElement
+const boardNumPassesInput = document.getElementById(
+  "boardNumPasses",
+) as HTMLInputElement
+const boardFrequencyInput = document.getElementById(
+  "boardFrequency",
+) as HTMLInputElement
+const boardPulseWidthInput = document.getElementById(
+  "boardPulseWidth",
+) as HTMLInputElement
+const presetSelect = document.getElementById(
+  "presetSelect",
+) as HTMLSelectElement
 const reconvertBtn = document.getElementById(
   "reconvertBtn",
 ) as HTMLButtonElement
 
+// Convert frequency from kHz to Hz
+function kHzToHz(khz: number): number {
+  return khz * 1000
+}
+
+// Convert pulse width from ns to seconds
+function nsToSeconds(ns: number): number {
+  return ns * 1e-9
+}
+
+// Load Omni X 6W 150x150 preset
+function loadOmniX6W150x150Preset() {
+  copperSpeedInput.value = "300"
+  copperNumPassesInput.value = "1"
+  copperFrequencyInput.value = "20"
+  copperPulseWidthInput.value = "1"
+
+  boardSpeedInput.value = "20"
+  boardNumPassesInput.value = "1"
+  boardFrequencyInput.value = "20"
+  boardPulseWidthInput.value = "1"
+}
+
+// Reset to defaults
+function resetToDefaults() {
+  copperSpeedInput.value = "300"
+  copperNumPassesInput.value = "1"
+  copperFrequencyInput.value = "20"
+  copperPulseWidthInput.value = "1"
+
+  boardSpeedInput.value = "20"
+  boardNumPassesInput.value = "1"
+  boardFrequencyInput.value = "20"
+  boardPulseWidthInput.value = "1"
+}
+
+// Initialize display values on load
+function initializeDisplayValues() {
+  copperFrequencyInput.value = "20"
+  copperPulseWidthInput.value = "1"
+  boardFrequencyInput.value = "20"
+  boardPulseWidthInput.value = "1"
+}
+
 // Show error message
 function showError(message: string) {
   errorMessage.textContent = message
@@ -98,6 +169,20 @@ function getConversionOptions() {
     ],
     traceMargin: parseFloat(traceMarginInput.value) || 0,
     laserSpotSize: parseFloat(laserSpotSizeInput.value) || 0.005,
+    laserProfile: {
+      copper: {
+        speed: parseFloat(copperSpeedInput.value) || 300,
+        numPasses: parseInt(copperNumPassesInput.value) || 100,
+        frequency: kHzToHz(parseFloat(copperFrequencyInput.value) || 20),
+        pulseWidth: nsToSeconds(parseFloat(copperPulseWidthInput.value) || 1),
+      },
+      board: {
+        speed: parseFloat(boardSpeedInput.value) || 20,
+        numPasses: parseInt(boardNumPassesInput.value) || 100,
+        frequency: kHzToHz(parseFloat(boardFrequencyInput.value) || 20),
+        pulseWidth: nsToSeconds(parseFloat(boardPulseWidthInput.value) || 1),
+      },
+    },
   }
 }
 
@@ -115,6 +200,7 @@ async function processFile(file: File) {
 
     // Show options container
     optionsContainer.classList.remove("hidden")
+    initializeDisplayValues()
 
     // Convert to LBRN with options
     await convertAndDisplay()
@@ -233,6 +319,17 @@ reconvertBtn.addEventListener("click", () => {
   convertAndDisplay()
 })
 
+// Handle preset select
+presetSelect.addEventListener("change", (e: Event) => {
+  const target = e.target as HTMLSelectElement
+  const value = target.value
+  if (value === "default") {
+    resetToDefaults()
+  } else if (value === "omni-x-6w") {
+    loadOmniX6W150x150Preset()
+  }
+})
+
 // Handle download button
 downloadBtn.addEventListener("click", () => {
   if (!currentLbrnProject) {

package/tests/basics/laser-profile.test.ts

@@ -0,0 +1,91 @@
+import { test, expect } from "bun:test"
+import { convertCircuitJsonToLbrn } from "../../lib"
+import { CutSetting } from "lbrnts"
+import type { CircuitJson } from "circuit-json"
+
+const circuitJson: CircuitJson = [
+  {
+    type: "pcb_board",
+    pcb_board_id: "board1",
+    center: { x: 5, y: 5 },
+    thickness: 1.6,
+    num_layers: 2,
+    material: "fr4",
+    outline: [
+      { x: 0, y: 0 },
+      { x: 10, y: 0 },
+      { x: 10, y: 10 },
+      { x: 0, y: 10 },
+    ],
+  },
+]
+
+test("applies custom laserProfile settings", () => {
+  const project = convertCircuitJsonToLbrn(circuitJson, {
+    laserProfile: {
+      copper: {
+        speed: 350,
+        numPasses: 150,
+        frequency: 25000,
+        pulseWidth: 2e-9,
+      },
+      board: {
+        speed: 25,
+        numPasses: 120,
+        frequency: 21000,
+        pulseWidth: 1.5e-9,
+      },
+    },
+  })
+
+  expect(project).toBeDefined()
+  const cutSettings = project.children.filter(
+    (child) => child.constructor.name === "_CutSetting",
+  ) as CutSetting[]
+  expect(cutSettings.length).toBe(4) // top copper, bottom copper, through board, soldermask
+
+  // Verify top copper settings
+  const topCopper = cutSettings[0]!
+  expect(topCopper.speed).toBe(350)
+  expect(topCopper.numPasses).toBe(150)
+  expect(topCopper.frequency).toBe(25000)
+  expect(topCopper.pulseWidth).toBe(2e-9)
+
+  // Verify bottom copper settings (same as top)
+  const bottomCopper = cutSettings[1]!
+  expect(bottomCopper.speed).toBe(350)
+  expect(bottomCopper.numPasses).toBe(150)
+  expect(bottomCopper.frequency).toBe(25000)
+  expect(bottomCopper.pulseWidth).toBe(2e-9)
+
+  // Verify through board settings
+  const throughBoard = cutSettings[2]!
+  expect(throughBoard.speed).toBe(25)
+  expect(throughBoard.numPasses).toBe(120)
+  expect(throughBoard.frequency).toBe(21000)
+  expect(throughBoard.pulseWidth).toBe(1.5e-9)
+})
+
+test("uses default laserProfile settings when not provided", () => {
+  const project = convertCircuitJsonToLbrn(circuitJson)
+
+  expect(project).toBeDefined()
+  const cutSettings = project.children.filter(
+    (child) => child.constructor.name === "_CutSetting",
+  ) as CutSetting[]
+  expect(cutSettings.length).toBe(4)
+
+  // Verify top copper defaults
+  const topCopper = cutSettings[0]!
+  expect(topCopper.speed).toBe(300)
+  expect(topCopper.numPasses).toBe(100)
+  expect(topCopper.frequency).toBe(20000)
+  expect(topCopper.pulseWidth).toBe(1e-9)
+
+  // Verify through board defaults
+  const throughBoard = cutSettings[2]!
+  expect(throughBoard.speed).toBe(20)
+  expect(throughBoard.numPasses).toBe(100)
+  expect(throughBoard.frequency).toBe(20000)
+  expect(throughBoard.pulseWidth).toBe(1e-9)
+})