Update README
This commit is contained in:
parent
0ef521c516
commit
00d47de59a
24
README.md
24
README.md
|
@ -1,20 +1,30 @@
|
|||
## Scripts
|
||||
## Automatic Test Scripts
|
||||
|
||||
### Python
|
||||
#### Shell
|
||||
(Remember to **edit the settings** in `rp_ping_test` and `rp_shutdown` and the **test arguments** passed to `get_and_plot_sayma_data` according to your own setup!)
|
||||
|
||||
* `test_mlabs`: Run an automatically-timed test using M-Labs' current setup
|
||||
* `test_creotech`: Run an automatically-timed test using Creotech's current setup
|
||||
|
||||
## Data Collection & Analytics Tools
|
||||
|
||||
#### Python
|
||||
(To see detailed usage, add `--help` as an argument when running the script.)
|
||||
|
||||
* `rp_get_sayma_data.py`: Acquire and save data from RedPitayas over local network
|
||||
* `plot_sayma_data.py`: Load saved data and output phase skew analysis and data plots
|
||||
|
||||
### Shell
|
||||
#### Shell
|
||||
* `get_and_plot_sayma_data`: Acquire and analyse data from RedPitayas over local network
|
||||
* `get_and_plot_remote_sayma_data`: Acquire and analyse data from remote RedPitayas via SSH (often over different networks) to the local file system
|
||||
* Requires Python testsuite scripts present on the remote host
|
||||
|
||||
## System Utilities
|
||||
|
||||
#### Shell
|
||||
* `mch_start`: Power on the MCH and start logging serial outputs from Metlino and Saymas
|
||||
* `mch_stop`: Power off the MCH and stop logging serial outputs from Metlino and Saymas
|
||||
* `rp_ping_test`: Loop to ping a RedPitaya until it succeeds
|
||||
* The exit condition is where the RedPitaya is ready-to-use
|
||||
* `rp_shutdown`: Shut down the OS of a RedPitaya and loop to ping it until it fails
|
||||
* The exit condition is where the RedPitaya is ready for hardware power-off
|
||||
* `get_and_plot_sayma_data`: Acquire and analyse data from RedPitayas over local network
|
||||
* `get_and_plot_remote_sayma_data`: Acquire and analyse data from remote RedPitayas via SSH (often over different networks) to the local file system
|
||||
* Requires Python testsuite scripts present on the remote host
|
||||
|
||||
|
|
Loading…
Reference in New Issue