https://github.com/tscircuit/circuit-json-to-readable-netlist
Convert Circuit JSON into a readable netlist suitable for input to AI
https://github.com/tscircuit/circuit-json-to-readable-netlist
netlist tscircuit
Last synced: 8 months ago
JSON representation
Convert Circuit JSON into a readable netlist suitable for input to AI
- Host: GitHub
- URL: https://github.com/tscircuit/circuit-json-to-readable-netlist
- Owner: tscircuit
- License: mit
- Created: 2024-12-28T18:23:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-13T18:16:53.000Z (12 months ago)
- Last Synced: 2025-09-16T04:50:30.406Z (9 months ago)
- Topics: netlist, tscircuit
- Language: TypeScript
- Homepage:
- Size: 138 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# circuit-json-to-readable-netlist
Convert Circuit JSON into a readable netlist suitable for input to AI
[](https://badge.fury.io/js/circuit-json-to-readable-netlist) [](https://github.com/tscircuit/circuit-json-to-readable-netlist) ⋅ [tscircuit](https://github.com/tscircuit/tscircuit) ⋅ [discord](https://tscircuit.com/join) ⋅ [use tscircuit online](https://tscircuit.com)
## Installation
```bash
bun add circuit-json-to-readable-netlist
```
## Usage
### TypeScript
```typescript
import { convertCircuitJsonToReadableNetlist } from 'circuit-json-to-readable-netlist'
import type { CircuitJson } from 'circuit-json'
const circuitJson: CircuitJson = // ... your circuit JSON
const readableNetlist = convertCircuitJsonToReadableNetlist(circuitJson)
console.log(readableNetlist)
```
## Example Readable Netlist
```txt
NET: +3V3
- U1 Pin8 (ESP-12F VDD3.3)
- R1 Pin1 (Pull-up for RST)
- R2 Pin1 (Pull-up for EN)
- R3 Pin1 (Pull-up for GPIO0)
- R4 Pin1 (Pull-up for GPIO2)
- C1 Pin1 (Decoupling 10 µF)
- C2 Pin1 (Decoupling 0.1 µF)
NET: GND
- U1 Pin9 (ESP-12F GND)
- C1 Pin2 (Decoupling return)
- C2 Pin2 (Decoupling return)
- S1 Pin2 (Reset switch to ground)
- R5 Pin2 (Pull-down for GPIO15)
- J1 Pin1 (UART header ground, if applicable)
NET: RST
- U1 Pin1 (ESP-12F RST)
- R1 Pin2 (10 kΩ to +3V3)
- S1 Pin1 (Momentary switch to GND)
NET: EN
- U1 Pin3 (ESP-12F EN / CH_PD)
- R2 Pin2 (10 kΩ to +3V3)
NET: GPIO0
- U1 Pin12 (GPIO0 / boot mode select)
- R3 Pin2 (10 kΩ to +3V3)
- S2 Pin1 (Optional switch/jumper to GND for flashing)
```