API Reference¶

GeckoCIRCUITS provides multiple interfaces for automation, integration, and programmatic control.

Available Interfaces¶

Interface Comparison¶

• REST API is currently in design phase, implementation is pending.

Quick Start¶

GeckoSCRIPT (Built-in)¶

// Parameter sweep example
for (D = 0.2; D <= 0.8; D += 0.1) {
    setParameter("PWM.1", "dutyCycle", D);
    runSimulation();
    Vout = getMeasurement("SCOPE.1", "ch1_avg");
    print("D=" + D + ", Vout=" + Vout);
}

MATLAB (RMI)¶

% Connect to GeckoCIRCUITS
gecko = GeckoRemoteInterface('localhost', 1099);

% Load and run
gecko.loadCircuit('buck.ipes');
gecko.setParameter('PWM.1', 'dutyCycle', 0.5);
gecko.runSimulation();
vout = gecko.getMeasurement('Vout');

Python (REST API - Planned)¶

import requests

# Run simulation (when REST API is implemented)
response = requests.post('http://localhost:8080/api/simulate', json={
    'circuit': 'buck.ipes',
    'parameters': {'D': 0.5}
})
results = response.json()
print(f"Vout = {results['Vout']}")

cURL (REST API - Planned)¶

# Get simulation status (when REST API is implemented)
curl http://localhost:8080/api/status

# Run simulation
curl -X POST http://localhost:8080/api/simulate \
  -H "Content-Type: application/json" \
  -d '{"circuit": "buck.ipes", "time": 0.01}'

Core API Methods¶

Circuit Control¶

Parameter Access¶

Data Retrieval¶

Related Tutorials¶

• GeckoSCRIPT Basics
• MATLAB Integration
• Python Integration