Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SCPI interface planning & review #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SCPI interface planning & review #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/SCPI interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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` | | | | |
Comment on lines +32 to +33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a query version of the OFFS and RANGE commands to get the actual offset and range applied to a channel?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable to me, we probably want to have OFFS? and OFFS:ACTual? to allow for the reading of both requested offset (e.g. freshly loaded UI getting current state of scope) and actual offset.

Loading