KiCad - the KiCad Bridge

@@ -319,7 +319,7 @@ dependencies = [  [[package]] name = "kicad-bridge"-version = "1.0.78"+version = "1.0.79" dependencies = [  "adom-eda-checks",  "kicad-core",@@ -331,7 +331,7 @@ dependencies = [  [[package]] name = "kicad-core"-version = "1.0.78"+version = "1.0.79" dependencies = [  "kicad-ipc-rs",  "kicad-platform",@@ -358,7 +358,7 @@ dependencies = [  [[package]] name = "kicad-platform"-version = "1.0.78"+version = "1.0.79" dependencies = [  "serde",  "serde_json",

@@ -3,7 +3,7 @@ resolver = "2" members = ["crates/*"]  [workspace.package]-version = "1.0.78"+version = "1.0.79" edition = "2021" license = "MIT" publish = false

@@ -108,5 +108,3 @@ kicad_upgrade kicad_validate_for_fab kicad_verb_times kicad_zone_state-kicad_export_spice-kicad_simulate

@@ -1,4 +1,4 @@-# The EDA Bridge Standard's verb names (adom/eda-bridge-standard verbs/standard.json, reference altium 0.2.76). Generated by tools/sync_standard_names.py; do not edit.+# The EDA Bridge Standard's verb names (adom/eda-bridge-standard verbs/standard.json, reference altium 0.2.79). Generated by tools/sync_standard_names.py; do not edit. a365_configure a365_files_upload a365_library_overview@@ -85,6 +85,7 @@ export_library_part export_manufacturing export_odb export_pdf+export_spice export_step extension_ping extract_intlib@@ -236,6 +237,7 @@ signin_status silk_designators silk_state silkscreen_prep+simulate state status swap_footprint

@@ -29,9 +29,9 @@ pub static VERBS: &[Verb] = &[         name: "kicad_simulate",         summary: "Simulate a schematic with SPICE, headless: KiCad's netlist of the sheet run by the ngspice library KiCad installs, with the analysis you give (transient, AC, DC sweep, operating point) or the one the schematic carries; each probe comes back downsampled with its first, last, min and max values (AC as dB and phase), and as a CSV file.",         mechanism: Mechanism::Cli, risk: "write", timeout_sec: 300,-        input: "{\"schPath\": \"C:/.../x.kicad_sch\", \"analysis\"?: \".tran 10u 5m\" | [\".op\", ...], \"probes\"?: [\"V(/OUT)\", \"I(V1)\"], \"points\"?: 200, \"outputDir\"?: \"C:/...\", \"timeoutSec\"?: 120}",-        example: "kicad_simulate {\"schPath\":\"C:/Users/john/proj/filter.kicad_sch\",\"analysis\":\".ac dec 20 10 1meg\",\"probes\":[\"V(/OUT)\"]}",-        hint: "probes are node voltages V(/NET) (or the vector names in available) and source currents I(V1); without probes every node and branch comes back (at most 24). sweep is time, frequency or the DC sweep. An AC probe has db and phaseDeg. csvPath holds the same points. Read log for ngspice's own messages when a run fails.",+        input: "{\"schPath\" | \"schematic\": \"C:/.../x.kicad_sch\", \"analysis\"?: {\"type\": \"op\"} | {\"type\": \"dc\", \"source\", \"start\", \"stop\", \"step\"} | {\"type\": \"ac\", \"sweep\": \"dec|oct|lin\", \"points\", \"start\", \"stop\"} | {\"type\": \"tran\", \"step\", \"stop\", \"start\"?} | {\"type\": \"raw\", \"text\": \".noise ...\"} | \".tran 10u 5m\" (or a list), \"probes\"?: [{\"net\": \"OUT\"}, {\"current\": \"V1\"}] | [\"V(/OUT)\"], \"points\"?: 200, \"outputDir\"?: \"C:/...\", \"timeoutSec\"?: 120}",+        example: "kicad_simulate {\"schPath\":\"C:/Users/john/proj/filter.kicad_sch\",\"analysis\":{\"type\":\"ac\",\"sweep\":\"dec\",\"points\":20,\"start\":10,\"stop\":1000000},\"probes\":[{\"net\":\"OUT\"}]}",+        hint: "signals[{signal, x, y, xUnit, yUnit, phase?}] is the standard's answer (#23): each probe's own points, at most points of them with the first, last and extreme points kept; AC as dB with unwrapped phase in degrees. engine names the ngspice and KiCad versions. probes are nets ({net: \"OUT\"}, or V(/OUT)) and source currents ({current: \"V1\"}); without probes every node and branch comes back (at most 24). sweep is time, frequency or the DC sweep. An AC probe has db and phaseDeg. csvPath holds the same points. Read log for ngspice's own messages when a run fails.",         related: &["kicad_export_spice", "kicad_build_schematic", "kicad_sch_set_property"],         pitfalls: &["Every part needs a SPICE model: R, C and L work from their values; sources come from the Simulation_SPICE library; ICs need a model file (Sim.Library).", "Runs on Windows through KiCad's ngspice.dll.", "A long transient with a tiny step returns many points: points downsamples the reply, not the run."],     },@@ -64,7 +64,7 @@ fn export(state: &mut State, sch: &Path, out: &Path, format: &str) -> Result<(St }  fn sch_arg(args: &Value) -> Result<PathBuf, Value> {-    let Some(p) = arg_any(args, &["schPath", "filePath"]).map(PathBuf::from) else {+    let Some(p) = arg_any(args, &["schPath", "schematic", "filePath"]).map(PathBuf::from) else {         return Err(fail("missing_arg", "schPath is required", "The .kicad_sch to simulate (the root sheet of a project)."));     };     if !p.is_file() {@@ -85,6 +85,7 @@ fn export_spice(state: &mut State, args: &Value) -> Result<Value, Value> {     v["success"] = json!(true);     v["path"] = json!(norm(&out));     v["format"] = json!(format);+    v["dialect"] = json!("ngspice"); // KiCad writes ngspice's SPICE (#23)     v["output"] = json!(format!("SPICE netlist of {} written to {}", norm(&sch), norm(&out)));     v["_hint"] = json!("kicad_simulate {schPath, analysis, probes} runs it through KiCad's ngspice.");     Ok(v)@@ -92,12 +93,15 @@ fn export_spice(state: &mut State, args: &Value) -> Result<Value, Value> {  fn simulate(state: &mut State, args: &Value) -> Result<Value, Value> {     let sch = sch_arg(args)?;-    let analyses: Vec<String> = match args.get("analysis") {-        Some(Value::String(s)) => vec![s.clone()],-        Some(Value::Array(a)) => a.iter().filter_map(Value::as_str).map(String::from).collect(),+    // the standard's analysis ({type: op|dc|ac|tran|raw, ...}, #23) or SPICE text, one or a list+    let given: Vec<Value> = match args.get("analysis") {+        Some(Value::Array(a)) => a.clone(),+        Some(v) if !v.is_null() => vec![v.clone()],         _ => Vec::new(),     };-    let probes: Vec<String> = args.get("probes").and_then(Value::as_array).map(|a| a.iter().filter_map(Value::as_str).map(String::from).collect()).unwrap_or_default();+    let analyses: Vec<String> = given.iter().map(spice::analysis_text).collect::<Result<_, _>>().map_err(|e| fail("bad_args", e, "analysis: {type: \"ac\", sweep: \"dec\", points: 20, start: 10, stop: 1e6}, {type: \"tran\", step: 1e-5, stop: 5e-3}, {type: \"dc\", source: \"V1\", start, stop, step}, {type: \"op\"} or {type: \"raw\", text: \".noise ...\"}."))?;+    // probes: {net: "OUT"} | {current: "V1"} | "V(/OUT)", as ngspice's vector names+    let probes: Vec<String> = args.get("probes").and_then(Value::as_array).map(|a| a.iter().filter_map(spice::probe_vector).collect()).unwrap_or_default();     let points = args.get("points").and_then(Value::as_u64).unwrap_or(200) as usize;     let tmp = std::env::temp_dir().join(format!("adom-kicad-sim-{}-{}", std::process::id(), std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).map(|d| d.as_millis()).unwrap_or(0)));     let _ = std::fs::create_dir_all(&tmp);@@ -123,7 +127,11 @@ fn simulate(state: &mut State, args: &Value) -> Result<Value, Value> {         v["netlist"] = json!(lines);         return Err(v);     }-    let mut v = spice::summarize(&run, &probes, points).map_err(|e| fail("no_such_probe", e, "Probe node voltages as V(/NET) and source currents as I(V1); available lists this run's vectors."))?;+    let mut v = spice::summarize(&run, &probes, points).map_err(|e| fail("no_such_probe", e, "Probe nets as {net: \"OUT\"} (or V(/OUT)) and source currents as {current: \"V1\"}; available lists this run's vectors."))?;+    // the standard's signals (#23): each probe's own x and y, the first, last and extreme points kept+    let (signals, missing) = spice::signals(&run, &probes, points);+    v["signals"] = json!(signals);+    v["missing"] = json!(missing);     let out_dir = arg_str(args, "outputDir").map(PathBuf::from).unwrap_or_else(|| sch.parent().unwrap_or(Path::new(".")).join("sim_output"));     let _ = std::fs::create_dir_all(&out_dir);     let stem = sch.file_stem().map(|s| s.to_string_lossy().into_owned()).unwrap_or_else(|| "sim".into());@@ -134,7 +142,10 @@ fn simulate(state: &mut State, args: &Value) -> Result<Value, Value> {     v["analysis"] = json!(lines.iter().filter(|l| l.starts_with('.') && !l.eq_ignore_ascii_case(".end") && !l.to_lowercase().starts_with(".title") && !l.to_lowercase().starts_with(".include")).collect::<Vec<_>>());     v["log"] = json!(run["log"].as_array().map(|l| l.iter().rev().take(12).rev().cloned().collect::<Vec<_>>()).unwrap_or_default());     v["seconds"] = json!((started.elapsed().as_secs_f64() * 100.0).round() / 100.0);-    v["engine"] = json!("ngspice (KiCad's ngspice.dll)");+    // the simulator and its version, so runs from two tools can be compared (#23)+    let ng = run["log"].as_array().into_iter().flatten().filter_map(Value::as_str).find_map(|l| l.split("ngspice-").nth(1).and_then(|t| t.split_whitespace().next()).map(String::from));+    let kicad = state.kicad_info().primary().map(|p| p.cli_version.clone()).unwrap_or_default();+    v["engine"] = json!(format!("ngspice {} (KiCad {})", ng.unwrap_or_else(|| "?".into()), if kicad.is_empty() { "?" } else { kicad.as_str() }));     v["output"] = json!(format!("{} vector(s) of {} over {} point(s)", v["probes"].as_array().map_or(0, |a| a.len()), v["plot"].as_str().unwrap_or(""), v["of"]));     v["_hint"] = json!("probes[].values follow sweep.values (AC: db and phaseDeg). csvPath holds the same points; pull it with ab pull_file. missing lists probes this run did not have.");     Ok(v)

@@ -1593,10 +1593,11 @@ def main():           {"ref": "R1", "symbol": "Device:R", "comment": "1k"}, {"ref": "C1", "symbol": "Device:C", "comment": "100n"}],           "nets": {"IN": ["V1.1", "R1.1"], "OUT": ["R1.2", "C1.1"], "GND": ["V1.2", "C1.2"]}}, 400)         ex = C("export_spice", {"schPath": rc}, 200)-        own("export_spice", ex, ok(ex) and ex.get("elements") == 3 and (ex.get("path") or "").endswith(".cir"), "no 3-element SPICE netlist of the RC")-        ac = C("simulate", {"schPath": rc, "analysis": ".ac dec 20 10 100k", "probes": ["V(/OUT)"], "points": 500}, 300)-        f = ((ac.get("sweep") or {}).get("values") or [])-        db = (((ac.get("probes") or [{}])[0]).get("db") or [])+        own("export_spice", ex, ok(ex) and ex.get("elements") == 3 and (ex.get("path") or "").endswith(".cir") and ex.get("dialect") == "ngspice", "no 3-element ngspice netlist of the RC")+        # the standard's shape (#23, 1.0.79): structured analysis, probes by net, signals[{signal, x, y}]+        ac = C("simulate", {"schematic": rc, "analysis": {"type": "ac", "sweep": "dec", "points": 20, "start": 10, "stop": 100000}, "probes": [{"net": "OUT"}], "points": 500}, 300)+        sig = ((ac.get("signals") or [{}])[0])+        f, db = sig.get("x") or [], sig.get("y") or []         # the crossing interpolated in log frequency: at 20 points a decade the grid steps past it (1584.9 Hz is -2.99 dB)         f3 = None         for i in range(len(min(f, db, key=len)) - 1):@@ -1605,7 +1606,7 @@ def main():                 f3 = 10 ** (math.log10(f[i]) + t * (math.log10(f[i + 1]) - math.log10(f[i])))                 break         bad = C("simulate", {"schPath": rc, "analysis": ".dc V9 0 1 0.1"}, 200)-        own("simulate", {"ac": ac, "bad": bad}, ok(ac) and f3 is not None and abs(f3 - 1591.5) / 1591.5 < 0.02 and ac.get("csvPath") and bad.get("errorCode") == "simulation_failed",+        own("simulate", {"ac": ac, "bad": bad}, ok(ac) and sig.get("signal") == "V(OUT)" and sig.get("yUnit") == "dB" and str(ac.get("engine") or "").startswith("ngspice ") and f3 is not None and abs(f3 - 1591.5) / 1591.5 < 0.02 and ac.get("csvPath") and bad.get("errorCode") == "simulation_failed",             f"the RC's -3 dB point was {f3} Hz, not about 1592, or a failing analysis did not fail")         pr = C("plan_route", {"filePath": CK, "source": "file", "net": "/DRV_GHC", "from": "R12.1", "to": "U4.13"}, 200)         rn = pr.get("routeNet") or {}

@@ -29,16 +29,19 @@ Every verb here edits files or the live board the way KiCad would, answers what  `kicad_simulate {schPath, analysis, probes}` runs the sheet through ngspice, the simulator KiCad itself uses (KiCad's own ngspice.dll on Windows), in a child process so a bad circuit cannot take the bridge down:-- `analysis`: `".tran 10u 5m"`, `".ac dec 20 10 1meg"`, `".dc V1 0 5 0.1"` or `".op"` (or a list); without-  it, the analysis the schematic carries runs.-- `probes`: node voltages `V(/OUT)` and source currents `I(V1)`; without them every node and branch comes-  back (24 at most). `available` lists this run's vectors.-- Each probe comes back downsampled to `points` (200) with its first, last, min and max; an AC probe as-  `db` and `phaseDeg`. `csvPath` holds the same points; `sweep` is time, frequency or the DC sweep.+- `analysis` in the EDA Bridge Standard's form: `{type: "ac", sweep: "dec", points: 20, start: 10, stop: 1e6}`,+  `{type: "tran", step: 1e-5, stop: 5e-3}`, `{type: "dc", source: "V1", start, stop, step}`, `{type: "op"}`,+  or `{type: "raw", text: ".noise ..."}`; SPICE text (`".tran 10u 5m"`) works too. Without it, the analysis+  the schematic carries runs.+- `probes`: `[{net: "OUT"}, {current: "V1"}]` (or `"V(/OUT)"`); without them every node and branch comes back+  (24 at most). `available` lists this run's vectors.+- `signals[{signal, x, y, xUnit, yUnit, phase?}]` is the answer: each probe's own points, at most `points`+  (200) of them with the first, last and extreme points always kept; AC as dB with unwrapped phase in degrees.+  `engine` names the ngspice and KiCad versions; `csvPath` holds the points.  Every part needs a SPICE model: R, C and L work from their values, sources come from the `Simulation_SPICE` library (VSIN, VDC, VPULSE...), ICs need a model file (their Sim.Library field). `kicad_export_spice` writes-KiCad's netlist (`.cir`) and says what it holds. Checked: an RC of 1k and 100n is -3 dB at 1.58 kHz, -45 deg.+KiCad's netlist (`.cir`, `dialect: ngspice`) and says what it holds. Checked: an RC of 1k and 100n is -3 dB at 1.58 kHz, -45 deg.  ## Board (`kicad_*` on a .kicad_pcb)