@tscircuit/footprinter 0.0.38 → 0.0.40

package/README.md

@@ -42,12 +42,39 @@ fp.string("dip4_w7.62mm") // same as fp.dip(4).w(7.62)
 fp.string("dip4_w0.3in") // same as fp.dip(4).w("0.3in")
 ```
 
-## Magic
+## Getting JSON output from the builder
 
-`footprinter` comes with a `fp.magic` function which calls a remote server that
-attempts to convert the specified string into a `footprinter` string. This can
-help when you're looking at a random package designator from an online site. You
-should always confirm these footprints against the datasheet.
+Use the `.soup()` function to output [tscircuit soup JSON](https://github.com/tscircuit/soup)
+
+```ts
+fp.string("res0402").soup()
+/*
+[
+  {
+    type: 'pcb_smtpad',
+    x: -0.5,
+    y: 0,
+    width: 0.6000000000000001,
+    height: 0.6000000000000001,
+    layer: 'top',
+    shape: 'rect',
+    pcb_smtpad_id: '',
+    port_hints: [ '1' ]
+  },
+  {
+    type: 'pcb_smtpad',
+    x: 0.5,
+    y: 0,
+    width: 0.6000000000000001,
+    height: 0.6000000000000001,
+    layer: 'top',
+    shape: 'rect',
+    pcb_smtpad_id: '',
+    port_hints: [ '2' ]
+  }
+]
+*/
+```
 
 ## Generation Defaults
 
@@ -69,14 +96,20 @@ industry best practices or otherwise "reasonable" defaults. In theory, upgrading
 footprinter could cause the defaults to change, which is why sloppy definitions
 are generally not desirable.
 
-## Adding new footprint functions
+An example of a sloppy definition is `bga64`. It's very underconstrained and
+unlikely to be correct (what's the pitch? pad size?). tscircuit strict mode
+or a linter will eventually error if it sees these.
 
-You can add new footprint functions by introducing a new function in the [src/fn](https://github.com/tscircuit/footprinter/tree/main/src/fn)
-directory. You'll also need to export it from the [footprint function index file](https://github.com/tscircuit/footprinter/blob/main/src/fn/index.ts)
+## Adding a new footprint function
+
+You can add new footprint functions by introducing a new function in the [src/fn directory](https://github.com/tscircuit/footprinter/tree/main/src/fn). You'll also need to export it from the [footprint function index file](https://github.com/tscircuit/footprinter/blob/main/src/fn/index.ts)
 
 After you've written the function, you can introduce a quick test, e.g. [soic.test.ts](https://github.com/tscircuit/footprinter/blob/main/tests/soic.test.ts)
 Currently it's not possible to see if a given definition is sloppy.
 
-An example of a sloppy definition is `bga64`. It's very underconstrained and
-unlikely to be correct (what's the pitch? pad size?). tscircuit strict mode
-or a linter will eventually error if it sees these.
+To run tests, just run `npx ava ./tests/soic.test.ts` or whatever your test
+file is.
+
+You'll sometimes see this `logSoup` function- this makes some debug output
+appear at https://debug.tscircuit.com. Make sure to hit "pcb" and "pcb_renderer"
+after the design.

package/dist/index.cjs

@@ -3670,12 +3670,12 @@ ${JSON.stringify(
 var import_zod5 = require("zod");
 var import_soup3 = __toESM(require_dist(), 1);
 var extendSoicDef = (newDefaults) => import_zod5.z.object({
-  soic: import_zod5.z.literal(true),
   num_pins: import_zod5.z.number(),
   w: import_soup3.length.default(import_soup3.length.parse(newDefaults.w ?? "5.3mm")),
   p: import_soup3.length.default(import_soup3.length.parse(newDefaults.p ?? "1.27mm")),
   pw: import_soup3.length.optional(),
-  pl: import_soup3.length.optional()
+  pl: import_soup3.length.optional(),
+  legsoutside: import_zod5.z.boolean().optional().default(newDefaults.legsoutside ?? false)
 }).transform((v) => {
   if (!v.pw && !v.pl) {
     v.pw = import_soup3.length.parse("0.6mm");
@@ -3688,16 +3688,18 @@ var extendSoicDef = (newDefaults) => import_zod5.z.object({
   return v;
 });
 var soic_def = extendSoicDef({});
-var getCcwSoicCoords = (pinCount, pn, w, p) => {
-  const ph = pinCount / 2;
+var getCcwSoicCoords = (params) => {
+  const { num_pins, pn, w, p, pl, legsoutside } = params;
+  const ph = num_pins / 2;
   const isLeft = pn <= ph;
   const leftPinGaps = ph - 1;
   const gs = p;
   const h = gs * leftPinGaps;
+  const legoffset = legsoutside ? pl / 2 : -pl / 2;
   if (isLeft) {
-    return { x: -w / 2, y: h / 2 - (pn - 1) * gs };
+    return { x: -w / 2 - legoffset, y: h / 2 - (pn - 1) * gs };
   } else {
-    return { x: w / 2, y: -h / 2 + (pn - ph - 1) * gs };
+    return { x: w / 2 + legoffset, y: -h / 2 + (pn - ph - 1) * gs };
   }
 };
 var soic = (raw_params) => {
@@ -3706,16 +3708,18 @@ var soic = (raw_params) => {
 var soicWithoutParsing = (params) => {
   const pads = [];
   for (let i = 0; i < params.num_pins; i++) {
-    const { x, y } = getCcwSoicCoords(
-      params.num_pins,
-      i + 1,
-      params.w,
-      params.p ?? 1.27
-    );
-    pads.push(rectpad(i + 1, x, y, params.pw ?? "0.6mm", params.pl ?? "1mm"));
+    const { x, y } = getCcwSoicCoords({
+      num_pins: params.num_pins,
+      pn: i + 1,
+      w: params.w,
+      p: params.p ?? 1.27,
+      pl: params.pl,
+      legsoutside: params.legsoutside
+    });
+    pads.push(rectpad(i + 1, x, y, params.pl ?? "1mm", params.pw ?? "0.6mm"));
   }
-  const sw = params.w - params.pw - 0.4;
-  const sh = (params.num_pins / 2 - 1) * params.p + params.pl + 0.4;
+  const sw = params.w - (params.legsoutside ? 0 : params.pl * 2) - 0.2;
+  const sh = (params.num_pins / 2 - 1) * params.p + params.pw;
   const silkscreenBorder = {
     layer: "top",
     pcb_component_id: "",
@@ -4095,10 +4099,11 @@ var tssop = (raw_params) => {
 // src/fn/sot236.ts
 var sot236_def = extendSoicDef({
   p: "0.95mm",
-  w: "1.6mm"
+  w: "1.6mm",
+  legsoutside: true
 });
 var sot236 = (params) => {
-  return soicWithoutParsing(sot236_def.parse(params));
+  return soicWithoutParsing(sot236_def.parse({ ...params, num_pins: 6 }));
 };
 
 // src/helpers/is-not-null.ts