@tscircuit/checks 0.0.102 → 0.0.103
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -46
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,53 +9,27 @@ and output an array of arrays for any issues found.
|
|
|
9
9
|
|
|
10
10
|
| Function | Description |
|
|
11
11
|
| --- | --- |
|
|
12
|
-
| [`
|
|
13
|
-
| [`
|
|
14
|
-
| [`
|
|
15
|
-
| [`
|
|
16
|
-
| [`
|
|
17
|
-
| [`checkPcbComponentsOutOfBoard`](
|
|
18
|
-
| [`
|
|
19
|
-
| [`
|
|
12
|
+
| [`checkConnectorAccessibleOrientation`](./lib/check-connector-accessible-orientation.ts) | Returns `pcb_accessibility_error` for connectors whose orientation makes them inaccessible. |
|
|
13
|
+
| [`checkDifferentNetViaSpacing`](./lib/check-different-net-via-spacing.ts) | Returns `pcb_via_clearance_error` if vias on different nets are too close together. |
|
|
14
|
+
| [`checkEachPcbPortConnectedToPcbTraces`](./lib/check-each-pcb-port-connected-to-pcb-trace.ts) | Returns `pcb_trace_error` if any `source_port` is not connected to its corresponding PCB traces. |
|
|
15
|
+
| [`checkEachPcbTraceNonOverlapping`](./lib/check-each-pcb-trace-non-overlapping/check-each-pcb-trace-non-overlapping.ts) | Returns `pcb_trace_error` when `pcb_trace` segments overlap incompatible geometry on the same layer. |
|
|
16
|
+
| [`checkPcbComponentOverlap`](./lib/check-pcb-components-overlap/checkPcbComponentOverlap.ts) | Returns `pcb_footprint_overlap_error` when footprint elements from different components overlap in disallowed ways. |
|
|
17
|
+
| [`checkPcbComponentsOutOfBoard`](./lib/check-pcb-components-out-of-board/checkPcbComponentsOutOfBoard.ts) | Returns `pcb_placement_error` when PCB components do not fit inside the board area. |
|
|
18
|
+
| [`checkPcbTracesOutOfBoard`](./lib/check-trace-out-of-board/checkTraceOutOfBoard.ts) | Returns `pcb_trace_error` when any trace segment or via extends beyond the board boundary. |
|
|
19
|
+
| [`checkPinMustBeConnected`](./lib/check-pin-must-be-connected.ts) | Returns `pcb_trace_error` when required source pins are not connected. |
|
|
20
|
+
| [`checkSameNetViaSpacing`](./lib/check-same-net-via-spacing.ts) | Returns `pcb_via_clearance_error` if vias on the same net are closer than the allowed margin. |
|
|
21
|
+
| [`checkSourceTracesHavePcbTraces`](./lib/check-source-traces-have-pcb-traces.ts) | Returns `pcb_trace_error` when source traces are missing corresponding `pcb_trace` routes. |
|
|
22
|
+
| [`checkTracesAreContiguous`](./lib/check-traces-are-contiguous/check-traces-are-contiguous.ts) | Returns `pcb_trace_error` when trace endpoints are floating or do not connect as expected. |
|
|
23
|
+
| [`checkViasOffBoard`](./lib/check-pcb-components-out-of-board/checkViasOffBoard.ts) | Returns `pcb_placement_error` if any PCB via lies outside or crosses the board boundary. |
|
|
24
|
+
|
|
25
|
+
## Aggregate check runner functions
|
|
20
26
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
Returns `pcb_trace_error` if any `pcb_trace` is overlapping with another `pcb_trace`
|
|
29
|
-
that is not connected to the same net.
|
|
30
|
-
|
|
31
|
-
## `checkSameNetViaSpacing(circuitJson: AnyCircuitElement[]) => PcbViaClearanceError[]`
|
|
32
|
-
|
|
33
|
-
Returns `pcb_via_clearance_error` if any vias on the same net are placed closer
|
|
34
|
-
than the allowed margin.
|
|
35
|
-
|
|
36
|
-
## `checkDifferentNetViaSpacing(circuitJson: AnyCircuitElement[]) => PcbViaClearanceError[]`
|
|
37
|
-
|
|
38
|
-
Returns `pcb_via_clearance_error` if any vias on different nets are placed closer
|
|
39
|
-
than the allowed margin.
|
|
40
|
-
|
|
41
|
-
## `checkViasOffBoard(circuitJson: AnyCircuitElement[]) => PcbPlacementError[]`
|
|
42
|
-
|
|
43
|
-
Returns `pcb_placement_error` if any PCB via lies outside or crosses the board
|
|
44
|
-
boundary.
|
|
45
|
-
|
|
46
|
-
## `checkPcbComponentsOutOfBoard(circuitJson: AnyCircuitElement[]) => PcbPlacementError[]`
|
|
47
|
-
|
|
48
|
-
Returns `pcb_placement_error` when a PCB component does not fit inside the board
|
|
49
|
-
area.
|
|
50
|
-
|
|
51
|
-
## `checkPcbComponentOverlap(circuitJson: AnyCircuitElement[]) => PcbFootprintOverlapError[]`
|
|
52
|
-
|
|
53
|
-
Returns `pcb_footprint_overlap_error` when PCB footprint elements (SMT pads, plated holes, or holes) from different components overlap. SMT pads on the same electrical net are allowed to overlap.
|
|
54
|
-
|
|
55
|
-
## `checkTracesAreContiguous(circuitJson: AnyCircuitElement[]) => PCBTraceError[]`
|
|
56
|
-
|
|
57
|
-
Returns `pcb_trace_error` if a PCB trace is misaligned or does not properly
|
|
58
|
-
connect to its expected pads.
|
|
27
|
+
| Function | Description |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| [`runAllPlacementChecks`](./lib/run-all-checks.ts) | Runs all placement checks (`checkViasOffBoard`, `checkPcbComponentsOutOfBoard`, `checkPcbComponentOverlap`, and `checkConnectorAccessibleOrientation`). |
|
|
30
|
+
| [`runAllNetlistChecks`](./lib/run-all-checks.ts) | Runs all netlist checks (`checkEachPcbPortConnectedToPcbTraces`, `checkSourceTracesHavePcbTraces`, and `checkPinMustBeConnected`). |
|
|
31
|
+
| [`runAllRoutingChecks`](./lib/run-all-checks.ts) | Runs all routing checks currently enabled (`checkEachPcbTraceNonOverlapping`, same/different net via spacing, and `checkPcbTracesOutOfBoard`). |
|
|
32
|
+
| [`runAllChecks`](./lib/run-all-checks.ts) | Runs all placement, netlist, and routing checks and returns a combined list of errors. |
|
|
59
33
|
|
|
60
34
|
## Implementation Details
|
|
61
35
|
|