@tscircuit/checks 0.0.145 → 0.0.146

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as circuit_json from 'circuit-json';
-import { AnyCircuitElement, PcbPortNotConnectedError, PcbTraceError, PcbPlacementError, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbPadPadClearanceError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, PcbConnectorNotInAccessibleOrientationWarning } from 'circuit-json';
+import { AnyCircuitElement, PcbPortNotConnectedError, PcbTraceError, PcbPlacementError, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbTraceTooLongWarning, PcbPadPadClearanceError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, PcbConnectorNotInAccessibleOrientationWarning } from 'circuit-json';
 import { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 
 declare function checkEachPcbPortConnectedToPcbTraces(circuitJson: AnyCircuitElement[]): PcbPortNotConnectedError[];
@@ -63,6 +63,8 @@ declare function checkPcbTracesOutOfBoard(circuitJson: AnyCircuitElement[], conf
  */
 declare function checkPcbComponentOverlap(circuitJson: AnyCircuitElement[]): PcbFootprintOverlapError[];
 
+declare const checkPcbTraceLengths: (circuitJson: AnyCircuitElement[]) => PcbTraceTooLongWarning[];
+
 declare function checkPadPadClearance(circuitJson: AnyCircuitElement[], { connMap, minClearance, }?: {
     connMap?: ConnectivityMap;
     minClearance?: number;
@@ -137,8 +139,8 @@ declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<
     subcircuit_id?: string;
 }[]>;
 declare function runAllPinSpecificationChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning)[]>;
-declare function runAllRoutingChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError)[]>;
-declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbFootprintOverlapError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | {
+declare function runAllRoutingChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbTraceTooLongWarning | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError)[]>;
+declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbFootprintOverlapError | circuit_json.PcbTraceTooLongWarning | circuit_json.PcbPadPadClearanceError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | {
     type: "source_pin_must_be_connected_error";
     source_pin_must_be_connected_error_id: string;
     error_type: "source_pin_must_be_connected_error";
@@ -150,4 +152,4 @@ declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circui
 
 declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElement[]): PcbConnectorNotInAccessibleOrientationWarning[];
 
-export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTracesAreContiguous, checkViaTraceClearance, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };
+export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTracesAreContiguous, checkViaTraceClearance, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };

package/dist/index.js

@@ -2491,6 +2491,68 @@ function checkPcbComponentOverlap(circuitJson) {
   return errors;
 }
 
+// lib/check-pcb-trace-lengths.ts
+var DEFAULT_VIA_LENGTH_MM = 1.6;
+var getRoutePointPosition = (routePoint) => routePoint.route_type === "through_pad" ? routePoint.start : { x: routePoint.x, y: routePoint.y };
+var getPcbTraceLength = (pcbTrace) => {
+  if (pcbTrace.trace_length !== void 0) return pcbTrace.trace_length;
+  let traceLength = 0;
+  for (let routePointIndex = 0; routePointIndex < pcbTrace.route.length; routePointIndex++) {
+    const routePoint = pcbTrace.route[routePointIndex];
+    if (!routePoint) continue;
+    if (routePoint.route_type === "via") {
+      traceLength += DEFAULT_VIA_LENGTH_MM;
+      continue;
+    }
+    const nextRoutePoint = pcbTrace.route[routePointIndex + 1];
+    if (!nextRoutePoint) continue;
+    const routePointPosition = getRoutePointPosition(routePoint);
+    const nextRoutePointPosition = getRoutePointPosition(nextRoutePoint);
+    traceLength += Math.hypot(
+      nextRoutePointPosition.x - routePointPosition.x,
+      nextRoutePointPosition.y - routePointPosition.y
+    );
+  }
+  return traceLength;
+};
+var checkPcbTraceLengths = (circuitJson) => {
+  const sourceTraces = circuitJson.filter(
+    (element) => element.type === "source_trace"
+  );
+  const pcbTraces = circuitJson.filter(
+    (element) => element.type === "pcb_trace"
+  );
+  const sourceTracesById = new Map(
+    sourceTraces.map((sourceTrace) => [
+      sourceTrace.source_trace_id,
+      sourceTrace
+    ])
+  );
+  const warnings = [];
+  for (const pcbTrace of pcbTraces) {
+    if (!pcbTrace.source_trace_id) continue;
+    const sourceTrace = sourceTracesById.get(pcbTrace.source_trace_id);
+    if (!sourceTrace) continue;
+    const maximumTraceLength = sourceTrace.max_length;
+    if (typeof maximumTraceLength !== "number") continue;
+    const actualTraceLength = getPcbTraceLength(pcbTrace);
+    if (actualTraceLength <= maximumTraceLength) continue;
+    warnings.push({
+      type: "pcb_trace_too_long_warning",
+      pcb_trace_too_long_warning_id: `pcb_trace_too_long_warning_${pcbTrace.pcb_trace_id}`,
+      warning_type: "pcb_trace_too_long_warning",
+      message: `PCB trace is ${actualTraceLength.toFixed(2)}mm long, exceeding the ${maximumTraceLength}mm maximum`,
+      pcb_trace_id: pcbTrace.pcb_trace_id,
+      source_trace_id: sourceTrace.source_trace_id,
+      source_net_id: sourceTrace.connected_source_net_ids[0],
+      actual_trace_length: actualTraceLength,
+      maximum_trace_length: maximumTraceLength,
+      subcircuit_id: pcbTrace.subcircuit_id ?? sourceTrace.subcircuit_id
+    });
+  }
+  return warnings;
+};
+
 // lib/check-pad-pad-clearance.ts
 import {
   getPrimaryId as getPrimaryId3,
@@ -3113,6 +3175,7 @@ async function runAllRoutingChecks(circuitJson) {
   return [
     ...checkEachPcbPortConnectedToPcbTraces(circuitJson),
     ...checkSourceTracesHavePcbTraces(circuitJson),
+    ...checkPcbTraceLengths(circuitJson),
     ...checkEachPcbTraceNonOverlapping(circuitJson),
     ...checkPadTraceClearance(circuitJson),
     ...checkViaTraceClearance(circuitJson),
@@ -3143,6 +3206,7 @@ export {
   checkPadTraceClearance,
   checkPcbComponentOverlap,
   checkPcbComponentsOutOfBoard,
+  checkPcbTraceLengths,
   checkPcbTracesOutOfBoard,
   checkPinMustBeConnected,
   checkSameNetViaSpacing,