diff --git a/docs/SCPI interface.md b/docs/SCPI interface.md new file mode 100644 index 0000000..78aad42 --- /dev/null +++ b/docs/SCPI interface.md @@ -0,0 +1,33 @@ +# SCPI interface + +## Background + +Refer to https://github.com/ngscopeclient/scopehal/wiki/SCPI-API-design for guidance. + +Most of the commands below reflect the current command set which is open to change as it hasn't been carefully curated. + +## Command set + +| Command | Description | Format | Example | Notes | +| --- | --- | --- | --- | --- | +| `*IDN?` | Query the ID of the instrument | `[Model],[Model variant],[Serial number],[SCPI protocol version]` | `ThunderScope,Rev4.1 (TB),0123456789,1.0.0` | SCPI protocol version to follow semantic versioning, where major version change indicates incompatible protocol change, minor version change indicates new features and bug fixes. More detailed information, e.g. firmware versions or interface details, will be a separate command. | +| `RATES?` | Query the available sample rates. | | | | +| `RATE ` | | | | | +| `DEPTHS?` | Query the available sample counts. | | | | +| `DEPTH ` | | | | | +| `RUN` | | | | | +| `STOP` | | | | | +| `FORCE` | | | | | +| `SINGLE` | | | | | +| `NORMAL` | | | | | +| `AUTO` | | | | | +| `STREAM` | | | | | +| `TRIG:LEV ` | | | | | +| `TRIG:SOU ` | | | | | +| `TRIG:DELAY ` | | | | | +| `TRIG:EDGE:DIR ` | | | | | +| `:ON` | | | | | +| `:OFF` | | | | | +| `:COUP` | | | | | +| `:OFFS` | | | | | +| `:RANGE` | | | | | \ No newline at end of file