website·Indexed 33 days ago
https://docs.tscircuit.comA hardware design tool that allows developers to design electronics using code. It features a CLI (tsci) for building, checking, and developing circuits, an NPM-based registry for components, and integration with KiCad and JLCPCB for footprint importing and fabrication file generation. The platform supports automatic PCB layout, custom autorouters, and AI-assisted design workflows.
The following elements are fundamental for building most circuits in tscircuit:
<board />: The root element that defines board size and autorouting settings.<chip />: Represents packaged integrated circuits (ICs) and discrete components.<trace />: Represents electrical connections between chips.<led />: Light emitting diode for power or status indicators.<resistor />: Resists the flow of electrical current.<capacitor />: Stores electrical charge and smooths voltage fluctuations.<diode />: Ensures current flows in only one direction.Fabrication files are a set of files used to upload to a fabricator or turn-key manufacturer (e.g., JLCPCB, PCBWay) to manufacture a circuit board. A tscircuit fabrication zip file contains three primary components:
Fabrication files in tscircuit are a collection of files packaged in a .zip archive used to order circuit boards from fabricators or turn-key manufacturers (e.g., JLCPCB, PCBWay). The archive contains three primary components:
<connector /> component represents a physical connector on a PCB, such as a USB receptacle, wire terminal, or board-to-board header. It handles placement and footprints similarly to the <chip /> component but includes specialized features for connectors, such as custom pin naming, internal shorting definitions, and standard connector hints for common families like USB-C and JST.tsci check is used to partially build a circuit and validate specific output aspects. It is designed to catch issues early in the development process without the overhead of running a full build. The command requires a subcommand (netlist, placement, or routing).tsci check <subcommand> [options]The tscircuit ecosystem consists of several specialized repositories. Key projects include:
<testpoint /> element defines a designated location on a PCB used for testing, debugging, and measuring electrical signals. It provides a reliable connection point for equipment like oscilloscope probes and multimeter leads. It features a single connection pin (pin1), also aliased as 'tp' or 'test'.tscircuit autorouters to describe PCB routing problems. It strips away complex PCB design details to provide only the essential information needed for routing algorithms: board boundaries, conductive layers, obstacles (keep-out areas), electrical nets (connections), and minimum trace width constraints. It can be generated from Circuit JSON and is conceptually similar to the Specctra DSN format.<silkscreengraphic /> element allows you to place images on the PCB silkscreen layer. It is ideal for logos, icons, orientation marks, or custom artwork. SVG images are converted into silkscreen geometry; simple, single-color SVGs provide the cleanest output. PNG images are also supported.const thumbsUpSvgUrl = "data:image/svg+xml,..."
export default () => (
<board width="14mm" height="12mm">
<silkscreengraphic
imageUrl={thumbsUpSvgUrl}
pcbX={0}
pcbY={0}
width="6mm"
height="6mm"
layer="top"
/>
</board>
)<jumper /> component represents a small multi-pin connector, such as a male or female header. It typically uses a pinrow style footprint and can be placed flexibly on a board, similar to a <chip /> component.export default () => (
<board width="10mm" height="10mm">
<jumper name="J1" footprint="pinrow4" />
</board>
)<trace /> element defines an electrical connection between two or more points in a circuit. It can connect component pins to other component pins or to named nets (like power and ground).export default () => (
<board width="10mm" height="10mm">
<resistor name="R1" resistance="1k" footprint="0402" pcbX={-2} schX={-2} />
<capacitor name="C1" capacitance="100nF" footprint="0402" pcbX={2} />
<trace
from=".R1 > .pin1"
to=".C1 > .pin1"
/>
</board>
)