Validity check functions. These functions generally take [a tscircuit json array](https://github.com/tscircuit/soup) and output an array of arrays for any issues found.
npm install @tscircuit/checksValidity check functions. These functions generally take a tscircuit json array
and output an array of arrays for any issues found.
Getting Started Contributor Video
| Function | Description |
| --- | --- |
| checkEachPcbPortConnected | Verifies every source_port is connected to a net or its fellow source ports. |
| checkEachPcbTraceNonOverlapping | Detects overlapping pcb_trace segments that aren't on the same net. |
| checkSameNetViaSpacing | Ensures vias sharing a net respect the minimum spacing margin. |
| checkDifferentNetViaSpacing | Flags vias on different nets that violate clearance requirements. |
| checkViasOffBoard | Checks for vias that extend beyond or cross the PCB boundary. |
| checkPcbComponentsOutOfBoard | Identifies PCB components that don't fit entirely within the board outline. |
| checkPcbComponentOverlap | Detects overlapping PCB footprint elements (pads, holes) from different components on different nets. |
| checkTracesAreContiguous | Validates that traces align correctly and connect to their intended pads. |
checkEachPcbPortConnected(soup: AnySoupElement[]) => PCBTraceError[]Returns pcb_trace_error if any source_port is not connected to a net or it's other
source ports.
checkEachPcbTraceNonOverlapping(soup: AnySoupElement[]) => PCBTraceError[]Returns pcb_trace_error if any pcb_trace is overlapping with another pcb_trace
that is not connected to the same net.
checkSameNetViaSpacing(circuitJson: AnyCircuitElement[]) => PcbViaClearanceError[]Returns pcb_via_clearance_error if any vias on the same net are placed closer
than the allowed margin.
checkDifferentNetViaSpacing(circuitJson: AnyCircuitElement[]) => PcbViaClearanceError[]Returns pcb_via_clearance_error if any vias on different nets are placed closer
than the allowed margin.
checkViasOffBoard(circuitJson: AnyCircuitElement[]) => PcbPlacementError[]Returns pcb_placement_error if any PCB via lies outside or crosses the board
boundary.
checkPcbComponentsOutOfBoard(circuitJson: AnyCircuitElement[]) => PcbPlacementError[]Returns pcb_placement_error when a PCB component does not fit inside the board
area.
checkPcbComponentOverlap(circuitJson: AnyCircuitElement[]) => PcbFootprintOverlapError[]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.
checkTracesAreContiguous(circuitJson: AnyCircuitElement[]) => PCBTraceError[]Returns pcb_trace_error if a PCB trace is misaligned or does not properly
connect to its expected pads.
> [!NOTE]
> It can be helpful to look at an example soup file
tscircuit soup JSON array containing elements. For checks involving source ports,
and pcb traces here are the relevant elements (the types are produced below)
> [!NOTE]
> For the most up-to-date types, check out @tscircuit/soup
``ts
// You can import these types from the @tscircuit/soup package e.g.
// import type { PCBPort, PCBTrace, AnySoupElement } from "circuit-json"
import { z } from "zod"
import { distance } from "../units"
export const pcb_trace = z.object({
type: z.literal("pcb_trace"),
source_trace_id: z.string().optional(),
pcb_component_id: z.string().optional(),
pcb_trace_id: z.string(),
route: z.array(
z.union([
z.object({
route_type: z.literal("wire"),
x: distance,
y: distance,
width: distance,
start_pcb_port_id: z.string().optional(),
end_pcb_port_id: z.string().optional(),
layer: z.string(),
}),
z.object({
route_type: z.literal("via"),
x: distance,
y: distance,
from_layer: z.string(),
to_layer: z.string(),
}),
])
),
})
export type PCBTraceInput = z.input
export type PCBTrace = z.output
import { distance } from "../units"
import { layer_ref } from "./properties/layer_ref"
export const pcb_port = z
.object({
type: z.literal("pcb_port"),
pcb_port_id: z.string(),
source_port_id: z.string(),
pcb_component_id: z.string(),
x: distance,
y: distance,
layers: z.array(layer_ref),
})
.describe("Defines a port on the PCB")
export type PCBPort = z.infer
export type PCBPortInput = z.input
export const source_port = z.object({
type: z.literal("source_port"),
pin_number: z.number().optional(),
port_hints: z.array(z.string()).optional(),
name: z.string(),
source_port_id: z.string(),
source_component_id: z.string(),
})
export type SourcePort = z.infer
export const source_net = z.object({
type: z.literal("source_net"),
source_net_id: z.string(),
name: z.string(),
member_source_group_ids: z.array(z.string()),
is_power: z.boolean().optional(),
is_ground: z.boolean().optional(),
is_digital_signal: z.boolean().optional(),
is_analog_signal: z.boolean().optional(),
})
export type SourceNet = z.infer
export type SourceNetInput = z.input
import { z } from "zod"
export const pcb_trace_error = z
.object({
pcb_error_id: z.string(),
type: z.literal("pcb_error"),
error_type: z.literal("pcb_trace_error"),
message: z.string(),
pcb_trace_id: z.string(),
source_trace_id: z.string(),
pcb_component_ids: z.array(z.string()),
pcb_port_ids: z.array(z.string()),
})
.describe("Defines a trace error on the PCB")
export type PCBTraceErrorInput = z.input
export type PCBTraceError = z.infer
``