CLI

Home | Next Chapter >>

[[TOC]]

The CLI tool is a python console-based application used to interface with the CyDAQ by using serial communication. To run the tool, run the following commands.

If you haven't already, install the requirements (from the root directory of the repo)

python -m pip install -r requirements.txt

Now to run the CLI tool

python cli/main.py

You should now be met with a command line interface. Type "h" or "help" to get a list of commands to use.

Please note, the CLI stores its own version of the CyDAQ configuration, different from the one on the CyDAQ itself. If you want to send that configuration to the CyDAQ, use the "send" command.

Commands

h/help                              Print This Help Menu
p/ping                              Ping the Zybo
configure                           Configure Parameters (Guided)
clear                               Clear config to default
print                               Print Current Config
send                                Send config to cyDAQ
set, (key) (value)                  Set one config value
setm, (json list)                   Set multiple config values as a json object
wrapper, (enable/disable)           Enable Wrapper Mode for CLIWrapper library
flush                               Flush 
start                               Start sampling
stop, [filename]                    Stop Sampling
generate                            Start/Stop DAC Generation
mock, (enable/disable/status)       Enable CyDAQ serial mocking mode
bb_start                            Start Balance Beam Mode
bb_start, (kp) (ki) (kd) (N) (Set)  Start with specific balance beam values
bb_stop                             Stop Balance Beam Mode
bb_fetch_pos                        Fetch the current position the balance beam
bb_const, (kp) (ki) (kd) (N)        Send updated constants for bb calc
bb_set, (value)                     Send updated set value for bb calc
bb_offset_inc                       Increase the balance beam offset
bb_offset_dec                       Decrease the balance beam offset
bb_pause                            Pause the Balance Beam
bb_resume                           Resume the Balance Beam
q/quit                              Exit The Command-Line

Home | Next Chapter >>