From 941fee375a5b5c821f2c4c60f2f68fba5b27dd34 Mon Sep 17 00:00:00 2001
From: macaba <1031306+macaba@users.noreply.github.com>
Date: Fri, 26 Jul 2024 17:45:12 +0100
Subject: [PATCH] Create SCPI interface.md

---
 docs/SCPI interface.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 docs/SCPI interface.md

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 <Femtoseconds>` | | | | |
+| `DEPTHS?` | Query the available sample counts. | | | |
+| `DEPTH <Sample Count>` | | | | |
+| `RUN` | | | | |
+| `STOP` | | | | |
+| `FORCE` | | | | |
+| `SINGLE` | | | | |
+| `NORMAL` | | | | |
+| `AUTO` | | | | |
+| `STREAM` | | | | |
+| `TRIG:LEV <Volts>` | | | | |
+| `TRIG:SOU <ChannelIndex>` | | | | |
+| `TRIG:DELAY <Femtoseconds>` | | | | |
+| `TRIG:EDGE:DIR <RISING:FALLING>` | | | | |
+| `<ChannelIndex>:ON` | | | | |
+| `<ChannelIndex>:OFF` | | | | |
+| `<ChannelIndex>:COUP` | | | | |
+| `<ChannelIndex>:OFFS` | | | | |
+| `<ChannelIndex>:RANGE` | | | | |
\ No newline at end of file