diff options
| -rw-r--r-- | specifications.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/specifications.md b/specifications.md new file mode 100644 index 0000000..6919894 --- /dev/null +++ b/specifications.md @@ -0,0 +1,44 @@ +# Use Cases + +## Presets + +Useful presets are stored persistently (JSON or YAML) and recalled with a single command. Preset configuration is applied to both function generator and oscilloscope. The intention is to quickly restore a state that can then be used for manual tests. + +## Screen capture + +Capture screen, dump to PNG. File name can be parameterised including special codes for date, time and incrementing counter. + +## Frequency response measurement + +With a single command, a frequency response sweep is performed. + +Parameters: +* Frequency range (from, to in Hz) +* Measurement steps + * Linear or logarithmic? +* Signal generator channel +* Oscilloscope channel(s) + +Data is stored in an array of tuples (freq, [measurements]). + +Output options: +* CSV +* SVG plot? +* PNG plot? +* HTML report containing test parameters, data, plot, etc + +## Repeated measurement mode + +1. User specifies a set of actions to be taken on each round + * Record measurement on a specific channel + * Screen capture + * Frequency response sweep +2. System goes to measurement mode: whenever a specific key (enter) is pressed, all actions are taken + * System provides feedback when ready to accept new input +3. User exits measurement mode by pressing a special key (q) +4. Optionally, acquired data is handled. Options: + * Save to CSV + * Print to console + * Pass as argument to user callback + + |