@tscircuit/footprinter 0.0.7 → 0.0.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/footprinter",
   "type": "module",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "",
   "main": "dist/index.cjs",
   "scripts": {

package/src/fn/bga.ts

@@ -1,7 +1,61 @@
 import type { AnySoupElement, PCBSMTPad } from "@tscircuit/soup"
 import { rectpad } from "../helpers/rectpad"
-import { type BgaDefInput, bga_def } from "../helpers/zod/bga-def"
 import { ALPHABET } from "../helpers/zod/ALPHABET"
+import { z } from "zod"
+import { length, distance } from "@tscircuit/soup"
+import { dim2d } from "src/helpers/zod/dim-2d"
+import { function_call } from "src/helpers/zod/function-call"
+import type { NowDefined } from "src/helpers/zod/now-defined"
+
+export const bga_def = z
+  .object({
+    num_pins: z.number(),
+    grid: dim2d.optional(),
+    p: distance.default("0.8mm"),
+    w: length.optional(),
+    h: length.optional(),
+    ball: length.optional().describe("ball diameter"),
+    pad: length.optional().describe("pad width/height"),
+
+    tlorigin: z.boolean().optional(),
+    blorigin: z.boolean().optional(),
+    trorigin: z.boolean().optional(),
+    brorigin: z.boolean().optional(),
+
+    missing: function_call.default([]),
+  })
+  .transform((a) => {
+    let origin: "tl" | "bl" | "tr" | "br" = "tl"
+    if (a.blorigin) origin = "bl"
+    if (a.trorigin) origin = "tr"
+    if (a.brorigin) origin = "br"
+
+    if (!a.grid) {
+      // find the largest square for the number of pins
+      const largest_square = Math.ceil(Math.sqrt(a.num_pins))
+      a.grid = { x: largest_square, y: largest_square }
+    }
+
+    if (a.missing) {
+      a.missing = a.missing.map((s) => {
+        if (typeof s === "number") return s
+        if (s === "center") return "center"
+        if (s === "topleft") return "topleft"
+        const m = s.match(/([A-Z]+)(\d+)/)
+        if (!m) return s
+        let Y = ALPHABET.indexOf(m[1]!)
+        let X = parseInt(m[2]!) - 1
+        return Y * a.grid!.x + X + 1
+      })
+    }
+
+    const new_def = { ...a, origin }
+
+    return new_def as NowDefined<typeof new_def, "w" | "h" | "grid">
+  })
+
+export type BgaDefInput = z.input<typeof bga_def>
+export type BgaDef = z.infer<typeof bga_def>
 
 export const bga = (params: BgaDefInput): AnySoupElement[] => {
   const bga_params = bga_def.parse(params)

package/src/fn/soic.ts

@@ -0,0 +1,82 @@
+import type { AnySoupElement } 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"
+
+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")
+    )
+  }
+  return platedHoles
+}

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/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,10 @@
+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 } = await getTestFixture(t)
+  const soup = fp.string("soic8_w5.3mm_p1.27mm").soup()
+
+  t.is(su(soup).pcb_plated_hole.list().length, 8)
+})

package/tsconfig.json

@@ -5,6 +5,7 @@
     "skipLibCheck": true,
     "target": "es2022",
     "allowJs": true,
+    "baseUrl": ".",
     "resolveJsonModule": true,
     "moduleDetection": "force",
     "isolatedModules": true,

package/src/helpers/zod/bga-def.ts

@@ -1,56 +0,0 @@
-import { z } from "zod"
-import { length, distance } from "@tscircuit/soup"
-import { dim2d } from "./dim-2d"
-import { function_call } from "./function-call"
-import type { NowDefined } from "./now-defined"
-import { ALPHABET } from "./ALPHABET"
-
-export const bga_def = z
-  .object({
-    num_pins: z.number(),
-    grid: dim2d.optional(),
-    p: distance.default("0.8mm"),
-    w: length.optional(),
-    h: length.optional(),
-    ball: length.optional().describe("ball diameter"),
-    pad: length.optional().describe("pad width/height"),
-
-    tlorigin: z.boolean().optional(),
-    blorigin: z.boolean().optional(),
-    trorigin: z.boolean().optional(),
-    brorigin: z.boolean().optional(),
-
-    missing: function_call.default([]),
-  })
-  .transform((a) => {
-    let origin: "tl" | "bl" | "tr" | "br" = "tl"
-    if (a.blorigin) origin = "bl"
-    if (a.trorigin) origin = "tr"
-    if (a.brorigin) origin = "br"
-
-    if (!a.grid) {
-      // find the largest square for the number of pins
-      const largest_square = Math.ceil(Math.sqrt(a.num_pins))
-      a.grid = { x: largest_square, y: largest_square }
-    }
-
-    if (a.missing) {
-      a.missing = a.missing.map((s) => {
-        if (typeof s === "number") return s
-        if (s === "center") return "center"
-        if (s === "topleft") return "topleft"
-        const m = s.match(/([A-Z]+)(\d+)/)
-        if (!m) return s
-        let Y = ALPHABET.indexOf(m[1]!)
-        let X = parseInt(m[2]!) - 1
-        return Y * a.grid!.x + X + 1
-      })
-    }
-
-    const new_def = { ...a, origin }
-
-    return new_def as NowDefined<typeof new_def, "w" | "h" | "grid">
-  })
-
-export type BgaDefInput = z.input<typeof bga_def>
-export type BgaDef = z.infer<typeof bga_def>