What's supported?

The Flux API gives you access to Flux documents and the electronics simulation engine.

Supported

✅ Linear DC Analysis

Ability to evaluate the DC currents and DC voltages for a lumped, linear time-invariant circuit.

✅ Nonlinear DC Analysis

Ability to obtain the quiescent operating point of a circuit which contains nonlinear elements such as a transistor.

✅ Linear transient analysis

Ability to determine the time domain response of a circuit to various input waveforms starting with the initial conditions obtained from the linear dc analysis.

✅ Large signal transient analysis

Ability to obtain the time domain response of a circuit which contains nonlinear elements, such as transistors. The time domain responses are determined by considering the various input waveforms starting with the initial conditions obtained from the nonlinear dc analysis.

✅ Reading the documents diagram

The API gives you access to all nodes of the diagram and their fields and child nodes.

✅ Set and update the atomic simulator models

The API lets you configure and automate the atomic simulation model of a document.

✅ Reading simulator outputs

The API lets you read the voltage and current at any point in the circuit. Use these values to define the behavior of a part or to show data to the user.

✅ Listen to UI inputs

The API lets you register callbacks for UI input events from buttons, sliders, and other controls. Users can then interact with your part models.

✅ Write Metrics to UI

The API lets you write data, such as simulator metrics, to the Flux UI.

✅ Change parts diagram symbol

The API lets you load different symbols for a part. For example, you can show the open and closed states of a switch.

✅ Display notifications to users

The API lets you show popup notifications to the user in the UI.

✅ Write debug messages to stdout

The API lets you write debugging information to the in-app console.

✅ Interactivity

Add interactive controls to your parts, such as push buttons and sliders.

✅ In-app debugging tools

Debugging code without having to resort to your browsers debugging tools.

✅ Simulated Circuits can be nested infinite levels deep

Documents can be nested infinitely deep.

On This Page
What's supported?Supported✅ Linear DC Analysis✅ Nonlinear DC Analysis✅ Linear transient analysis✅ Large signal transient analysis✅ Reading the documents diagram✅ Set and update the atomic simulator models✅ Reading simulator outputs✅ Listen to UI inputs✅ Write Metrics to UI✅ Change parts diagram symbol✅ Display notifications to users✅ Write debug messages to stdout✅ Interactivity✅ In-app debugging tools✅ Simulated Circuits can be nested infinite levels deep