Skip to content

Add documentation for SPICE simulation elements #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seveibar wants to merge 1 commit into
base: main
Choose a base branch
from
+160 −0
Open

Add documentation for SPICE simulation elements #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions docs/elements/analogsimulation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: <analogsimulation />
description: Configure and run SPICE simulations for a tscircuit board.
---

## Overview

`<analogsimulation />` enables SPICE simulation for a `<board />` and sets the
solver configuration, such as duration and time step. Place this element inside
your board alongside sources and probes to generate simulation results.

import CircuitPreview from "@site/src/components/CircuitPreview"

<CircuitPreview
defaultView="schematic"
hidePCBTab={true}
hide3DTab={true}
verticalStack={true}
showSimulationGraph={true}
code={`
export default () => (
<board routingDisabled>
<voltagesource name="V1" voltage="5V" />
<resistor name="R1" resistance="1k" />

<trace from=".V1 > .pin1" to=".R1 > .pin1" />
<trace from=".V1 > .pin2" to=".R1 > .pin2" />

<voltageprobe name="VP_IN" connectsTo=".V1 > .pin1" />
<voltageprobe name="VP_OUT" connectsTo=".R1 > .pin1" />

<analogsimulation duration="10ms" timePerStep="0.1ms" spiceEngine="ngspice" />
</board>
)
`}
/>

## Properties

| Property | Description | Example |
| --- | --- | --- |
| `duration` | Total simulation time. Accepts numbers or time strings. | `"10ms"` |
| `timePerStep` | Time interval between simulation steps. | `"0.1ms"` |
| `spiceEngine` | SPICE engine to use. Typically `"ngspice"` or `"spicey"`. | `"ngspice"` |

Use `<analogsimulation />` once per `<board />` to define how the simulation
runs. Combine it with `<voltagesource />` and `<voltageprobe />` elements to
create and observe waveforms.
53 changes: 53 additions & 0 deletions docs/elements/voltageprobe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: <voltageprobe />
description: Measure voltages at specific nodes during SPICE simulation.
---

## Overview

`<voltageprobe />` records voltage values during SPICE simulation. It attaches to
an existing node in your schematic and appears in the simulation graph output.
Use probes to capture input/output signals or differential measurements across
components.

import CircuitPreview from "@site/src/components/CircuitPreview"

<CircuitPreview
defaultView="schematic"
hidePCBTab={true}
hide3DTab={true}
verticalStack={true}
showSimulationGraph={true}
code={`
export default () => (
<board routingDisabled>
<voltagesource name="V1" voltage="5V" />
<resistor name="R1" resistance="1k" />

<trace from=".V1 > .pin1" to=".R1 > .pin1" />
<trace from=".V1 > .pin2" to=".R1 > .pin2" />

<voltageprobe name="VP_IN" connectsTo=".V1 > .pin1" />
<voltageprobe
name="VP_DIFF"
connectsTo=".R1 > .pin1"
referenceTo=".R1 > .pin2"
/>

<analogsimulation duration="10ms" timePerStep="0.1ms" spiceEngine="ngspice" />
</board>
)
`}
/>

## Properties

| Property | Description | Example |
| --- | --- | --- |
| `name` | Optional label for the probe trace in graphs. | `"VP_OUT"` |
| `connectsTo` | Port selector that identifies the measurement node. | `".R1 > .pin1"` |
| `referenceTo` | Optional port selector for differential measurements. | `".R1 > .pin2"` |

Add probes for every signal you want plotted in the simulation graph. When you
provide `referenceTo`, the probe measures the voltage difference between the
`connectsTo` node and the reference node.
59 changes: 59 additions & 0 deletions docs/elements/voltagesource.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: <voltagesource />
description: Add a voltage source for SPICE simulations and schematic power inputs.
---

## Overview

`<voltagesource />` defines a two-pin voltage source that can drive your circuit
in SPICE simulations. It supports DC sources as well as waveform-driven sources
(sine, square, or triangle). Use this element to provide input stimulus for
filters, rectifiers, power converters, and other analog designs.

import CircuitPreview from "@site/src/components/CircuitPreview"

<CircuitPreview
defaultView="schematic"
hidePCBTab={true}
hide3DTab={true}
verticalStack={true}
showSimulationGraph={true}
code={`
export default () => (
<board routingDisabled>
<voltagesource
name="V1"
waveShape="square"
amplitude="5V"
offset="2.5V"
frequency="1kHz"
dutyCycle={0.5}
/>
<resistor name="R1" resistance="1k" />

<trace from=".V1 > .pin1" to=".R1 > .pin1" />
<trace from=".V1 > .pin2" to=".R1 > .pin2" />

<voltageprobe name="VP_OUT" connectsTo=".R1 > .pin1" />
<analogsimulation duration="5ms" timePerStep="0.05ms" spiceEngine="ngspice" />
</board>
)
`}
/>

## Properties

| Property | Description | Example |
| --- | --- | --- |
| `name` | Reference designator for the source. | `"V1"` |
| `voltage` | DC voltage (when you want a steady source). | `"5V"` |
| `waveShape` | Waveform shape for AC sources. Common values are `"sinewave"`, `"square"`, and `"triangle"`. | `"square"` |
| `frequency` | Frequency of the waveform. | `"1kHz"` |
| `amplitude` | AC amplitude (peak) for the waveform. | `"5V"` |
| `offset` | DC offset added to the waveform. | `"2.5V"` |
| `dutyCycle` | Duty cycle for square waves, from `0` to `1`. | `0.5` |
| `schX`, `schY`, `schRotation` | Schematic placement controls. | `schRotation={270}` |

Use `<voltagesource />` alongside `<analogsimulation />` to define inputs for
SPICE analysis. For physical power sources on a PCB, consider `<battery />` or a
connector instead.
Loading