Pass traceClearance as a configuration for the distance b/w trace and pad being used by freerouting (#108)

* Add minimum distance b/w trace and pad

* update pad

* update

* add traceClearance as a parameter

* test name update

Author: imrishabh18

lib/dsn-pcb/circuit-json-to-dsn-json/convert-circuit-json-to-dsn-json.ts

@@ -7,6 +7,9 @@ import { processPlatedHoles } from "./process-plated-holes"
 
 export function convertCircuitJsonToDsnJson(
   circuitElements: AnyCircuitElement[],
+  options: {
+    traceClearance?: number
+  } = {},
 ): DsnPcb {
   // Find the PCB board element
   const pcbBoard = circuitElements.find(
@@ -57,13 +60,10 @@ export function convertCircuitJsonToDsnJson(
       },
       via: "Via[0-1]_600:300_um",
       rule: {
+        // Default clearance having fallback value
         clearances: [
           {
-            value: 200,
-          },
-          {
-            value: 200,
-            type: "default_smd",
+            value: options.traceClearance ?? 300, // fallback gap between any <-> any
           },
           {
             value: 50,
@@ -108,10 +108,10 @@ export function convertCircuitJsonToDsnJson(
             use_via: "Via[0-1]_600:300_um",
           },
           rule: {
+            // Actual value being used in the dsn for the specific network class
             clearances: [
               {
-                value: 200,
-                type: "",
+                value: options.traceClearance ?? 300,
               },
             ],
             width: 150, // trace width used in freerouting

lib/dsn-pcb/circuit-json-to-dsn-json/convert-circuit-json-to-dsn-string.ts

@@ -4,7 +4,10 @@ import { stringifyDsnJson } from "./stringify-dsn-json"
 
 export const convertCircuitJsonToDsnString = (
   circuitJson: AnyCircuitElement[],
+  options: {
+    traceClearance?: number
+  } = {},
 ) => {
-  const dsnJson = convertCircuitJsonToDsnJson(circuitJson)
+  const dsnJson = convertCircuitJsonToDsnJson(circuitJson, options)
   return stringifyDsnJson(dsnJson)
 }

lib/dsn-pcb/types.ts

@@ -60,7 +60,7 @@ export interface DsnPcb {
       }
       rule: {
         clearances: Array<{
-          type: any
+          type?: any
           value: number
         }>
         width: number

tests/repros/repro12-configuration-passed-to-converter.test.ts

@@ -0,0 +1,17 @@
+import { expect, test } from "bun:test"
+import { convertCircuitJsonToDsnJson } from "lib"
+
+import circuitJson from "../assets/repro/XIAO_S3.json"
+import type { AnyCircuitElement } from "circuit-json"
+
+test("configuration passed to converter", async () => {
+  const dsnJson = convertCircuitJsonToDsnJson(
+    circuitJson as AnyCircuitElement[],
+    {
+      traceClearance: 6969,
+    },
+  )
+
+  const traceClearance = dsnJson.network.classes[0].rule.clearances[0].value
+  expect(traceClearance).toBe(6969)
+})