@tscircuit/footprinter 0.0.8 → 0.0.10

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@tscircuit/footprinter",
   "type": "module",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "",
   "main": "dist/index.cjs",
   "scripts": {
-    "test": "ava",
+    "test": "FULL_RUN=1 ava",
     "build": "tsup ./src/index.ts --dts --sourcemap"
   },
   "keywords": [],

package/src/fn/soic.ts

@@ -0,0 +1,106 @@
+import type { AnySoupElement, PcbSilkscreenPath } from "@tscircuit/soup"
+import { platedhole } from "../helpers/platedhole"
+import { z } from "zod"
+import { length } from "@tscircuit/soup"
+import type { NowDefined } from "../helpers/zod/now-defined"
+import { u_curve } from "../helpers/u-curve"
+
+const soic_def = z
+  .object({
+    soic: z.literal(true),
+    num_pins: z.number(),
+    w: length,
+    p: length.default(length.parse("1.27mm")),
+    id: length.optional(),
+    od: length.optional(),
+  })
+  .transform((v) => {
+    // Default inner diameter and outer diameter
+    if (!v.id && !v.od) {
+      v.id = length.parse("0.6mm")
+      v.od = length.parse("1.0mm")
+    } else if (!v.id) {
+      v.id = v.od! * (0.6 / 1.0)
+    } else if (!v.od) {
+      v.od = v.id! * (1.0 / 0.6)
+    }
+    return v as NowDefined<typeof v, "w" | "p" | "id" | "od">
+  })
+
+export const getCcwSoicCoords = (
+  pinCount: number,
+  pn: number,
+  w: number,
+  p: number
+) => {
+  /** pin height */
+  const ph = pinCount / 2
+  const isLeft = pn <= ph
+
+  /** Number of gaps between pins on each side, e.g. 4 pins = 3 spaces */
+  const leftPinGaps = ph - 1
+
+  /** gap size (pitch) */
+  const gs = p
+
+  const h = gs * leftPinGaps
+
+  if (isLeft) {
+    // The y position starts at h/2, then goes down by gap size
+    // for each pin
+    return { x: -w / 2, y: h / 2 - (pn - 1) * gs }
+  } else {
+    // The y position starts at -h/2, then goes up by gap size
+    return { x: w / 2, y: -h / 2 + (pn - ph - 1) * gs }
+  }
+}
+
+/**
+ * Returns the plated holes for a SOIC package.
+ */
+export const soic = (raw_params: {
+  soic: true
+  num_pins: number
+  w: number
+  p?: number
+  id?: string | number
+  od?: string | number
+}): AnySoupElement[] => {
+  const params = soic_def.parse(raw_params)
+  const platedHoles: AnySoupElement[] = []
+  for (let i = 0; i < params.num_pins; i++) {
+    const { x, y } = getCcwSoicCoords(
+      params.num_pins,
+      i + 1,
+      params.w,
+      params.p ?? 1.27
+    )
+    platedHoles.push(
+      platedhole(i + 1, x, y, params.id ?? "0.6mm", params.od ?? "1mm")
+    )
+  }
+
+  /** silkscreen width */
+  const sw = params.w - params.od - 0.4
+  const sh = (params.num_pins / 2 - 1) * params.p + params.od + 0.4
+  const silkscreenBorder: PcbSilkscreenPath = {
+    layer: "top",
+    pcb_component_id: "",
+    pcb_silkscreen_path_id: "silkscreen_path_1",
+    route: [
+      { x: -sw / 2, y: -sh / 2 },
+      { x: -sw / 2, y: sh / 2 },
+      // Little U shape at the top
+      ...u_curve.map(({ x, y }) => ({
+        x: (x * sw) / 6,
+        y: (y * sw) / 6 + sh / 2,
+      })),
+      { x: sw / 2, y: sh / 2 },
+      { x: sw / 2, y: -sh / 2 },
+      { x: -sw / 2, y: -sh / 2 },
+    ],
+    type: "pcb_silkscreen_path",
+  }
+
+  return [...platedHoles, silkscreenBorder]
+}

package/src/footprinter.ts

@@ -4,6 +4,7 @@ import { cap } from "./fn/cap"
 import { led } from "./fn/led"
 import { res } from "./fn/res"
 import { bga } from "./fn/bga"
+import { soic } from "./fn/soic"
 import type { AnySoupElement } from "@tscircuit/soup"
 import { isNotNull } from "./helpers/is-not-null"
 
@@ -42,6 +43,7 @@ export type Footprinter = {
   ) => FootprinterParamsBuilder<
     "grid" | "p" | "w" | "h" | "ball" | "pad" | "missing"
   >
+  soic: (num_pins: number) => FootprinterParamsBuilder<"w" | "p" | "id" | "od">
   params: () => any
   soup: () => AnySoupElement[]
 }
@@ -78,6 +80,7 @@ export const footprinter = (): Footprinter & { string: typeof string } => {
           if ("led" in target) return () => led(target)
           if ("res" in target) return () => res(target)
           if ("bga" in target) return () => bga(target)
+          if ("soic" in target) return () => soic(target)
 
           return () => {
             // TODO improve error
@@ -91,9 +94,15 @@ export const footprinter = (): Footprinter & { string: typeof string } => {
           return () => target
         }
         return (v: any) => {
-          if (["bga", "lr", "quad", "dip"].includes(prop as string)) {
+          if (Object.keys(target).length === 0) {
             target[prop] = true
-            target.num_pins = parseFloat(v)
+            if (prop === "res" || prop === "cap") {
+              if (v) {
+                target.imperial = v // res0402, cap0603 etc.
+              }
+            } else {
+              target.num_pins = parseFloat(v)
+            }
           } else {
             target[prop] = v ?? true
           }

package/src/helpers/u-curve.ts

@@ -0,0 +1,6 @@
+export const u_curve = Array.from({ length: 9 }, (_, i) =>
+  Math.cos((i / 8) * Math.PI - Math.PI)
+).map((x) => ({
+  x,
+  y: -Math.sqrt(1 - x ** 2),
+}))

package/tests/fixtures/get-test-fixture.ts

@@ -8,10 +8,12 @@ export const getTestFixture = async (t: ExecutionContext) => {
     fp,
     logSoup: (soup: AnySoupElement[]) => {
       if (process.env.CI) return
+      if (process.env.FULL_RUN) return
       return logSoup(`footprinter: ${t.title}`, soup)
     },
     logSoupWithPrefix: (prefix: string, soup: AnySoupElement[]) => {
       if (process.env.CI) return
+      if (process.env.FULL_RUN) return
       return logSoup(`footprinter: ${t.title} ${prefix}`, soup)
     },
   }

package/tests/res.test.ts

@@ -0,0 +1,11 @@
+import test from "ava"
+import { getTestFixture } from "tests/fixtures/get-test-fixture"
+import { su } from "@tscircuit/soup-util"
+
+test("res_imperial0402", async (t) => {
+  const { fp } = await getTestFixture(t)
+  const soup = fp.string("res_imperial0402").soup()
+
+  t.is(su(soup).pcb_smtpad.list().length, 2)
+  t.is(su(soup).pcb_plated_hole.list().length, 0)
+})

package/tests/soic.test.ts

@@ -0,0 +1,11 @@
+import test from "ava"
+import { getTestFixture } from "tests/fixtures/get-test-fixture"
+import { su } from "@tscircuit/soup-util"
+
+test("soic8_w5.3mm_p1.27mm", async (t) => {
+  const { fp, logSoup } = await getTestFixture(t)
+  const soup = fp.string("soic8_w5.3mm_p1.27mm").soup()
+
+  t.is(su(soup).pcb_plated_hole.list().length, 8)
+  await logSoup(soup)
+})