Scripting
Build and test circuits from code, in your browser's console. For power users, teachers and automated tools.
The simulator you see has a scripting interface, Circuitpal, available in your browser's developer console on the simulator page. It does the same things you can do with the mouse, and it works on your own page only. Nothing is sent anywhere, except that the community calls talk to the Community page, like the buttons do. Want an AI assistant to use it for you? See Using Circuitpal with an AI agent.
An example#
await Circuitpal.setMode('2d'); Circuitpal.clear(); const b = Circuitpal.add('battery',{x:100,y:200,props:{v:5}}); const r = Circuitpal.add('resistor',{x:260,y:200}); Circuitpal.wire({part:b,pin:'+'},{part:r,pin:'A'}); Circuitpal.wire({part:r,pin:'B'},{part:b,pin:'−'}); Circuitpal.run(); await Circuitpal.step(300)
Methods#
| Method | What it does |
|---|---|
Circuitpal.mode | () -> "2d"|"3d" |
Circuitpal.setMode | (mode) -> Promise<mode> |
Circuitpal.types | () -> [{type,name,group,pins,defaults}] |
Circuitpal.state | () -> {mode,parts,wires,running} |
Circuitpal.clear | () |
Circuitpal.loadExample | (name) -> Promise<state> |
Circuitpal.add | (type, {x,y,rot,props} | {x,z,y,rot,props} | {board,hole,props}) -> id |
Circuitpal.wire | (a, b, color?) -> id a/b = {part,pin} | {board,hole} |
Circuitpal.set | (id, props) -> part |
Circuitpal.move | (id, {x,y}|{x,z,y}) -> part |
Circuitpal.rotate | (id, quarterTurns=1) -> part |
Circuitpal.remove | (partOrWireId) |
Circuitpal.lock | (id, on=true) -> locked |
Circuitpal.group | ([ids]) -> bool (3D) |
Circuitpal.hide | (id, on=true) (3D) |
Circuitpal.rename | (id, name) (3D) |
Circuitpal.run | () -> running |
Circuitpal.stop | () |
Circuitpal.voltages | () -> {id:[volts per pin]}|null |
Circuitpal.step | (ms) -> Promise<voltages> |
Circuitpal.export | () -> design JSON |
Circuitpal.import | (design) -> Promise<state> |
Circuitpal.screenshot | (w,h) -> data URL (3D) |
Circuitpal.describe | () |
Circuitpal.info | (type) -> what the part is, formula, pins |
Circuitpal.inspect | (id) -> the details panel as text |
Circuitpal.readings | (id?) -> {running,time,parts:{id:{v,i,p,...}},warnings} |
Circuitpal.scope | (id,{ms}) -> channels with stats and samples |
Circuitpal.settings | () -> settings |
Circuitpal.setSetting | (key,value) |
Circuitpal.environment | () -> {temperatureC,imperfections} |
Circuitpal.setEnvironment | ({temperatureC,imperfections:{on,tolerancePercent,seed}}) |
Circuitpal.speed | (x?) |
Circuitpal.timeStep | (seconds?) |
Circuitpal.undo | () (2D) |
Circuitpal.redo | () (2D) |
Circuitpal.examples | () -> [{id,name,mode}] |
Circuitpal.bode | ({input,probe:{part,pin},from,to,perDecade}) -> {frequencyHz,gainDb,phaseDeg,cornerHz} |
Circuitpal.sweep | ({part,prop,from,to,steps,log,probe}) -> {values,volts} |
Circuitpal.monteCarlo | ({probe,runs,tolerancePercent}) -> stats |
Circuitpal.spiceExport | () -> text |
Circuitpal.spiceImport | (text) -> Promise<summary> |
Circuitpal.lessons | () -> list |
Circuitpal.startLesson | (id) -> Promise<state> |
Circuitpal.lessonState | () |
Circuitpal.stopLesson | () |
Circuitpal.challenges | () -> list |
Circuitpal.startChallenge | (id) |
Circuitpal.challengeState | () |
Circuitpal.community | { me, search({kind,q,sort,by,page}), get(id), comments(id), open(id), share({kind,title,description,tags,steps}), comment(id,text), like(id) } (what is shared waits for a moderator) |
Call Circuitpal.describe() in the console for the full, current description.