Command Line Instructions (Cli) - CAMBRIONIX ThunderSync2-16 User Manual

5.2 Command Line Instructions (CLI)

Command Line Instructions can also be used to
control and monitor the functions of the TS2-16
and attached devices over a VCP (Virtual COM
Port). In order to use the command line interface a
serial terminal emulator must be installed on the
host computer.
Command
mode <m> [p]
mode c <p> [cp]
state [p]
system
health
cef
sef [flags]...
crf
limits
list_profiles
en_profile <i> <1|0>
set_profiles <p> [l]
get_profiles <p>
sec [arm|disarm]
host [auto|manual]
id
bd
logc <s>
loge [s]
l
remote [exit|kexit]
ledb <p> <row> <ptn>
leds <row> [ptnstr]
keys
lcd <row> <col> <str>
clcd
beep [ms]
cls
reboot [watchdog]
serial_speed [test|fast|slow]
set_delays
host [auto/manual/charge/sync/off]
NOTES:
[p] is port number.
<m> is port mode:
<l> is a list of profile IDs.
<i> is a single profile ID.
Parameters:
Tab key
Cursor up
Typing "l" will give equivalent information to
LiveViewer and, using the command "logc X", will
output the data to a log file every "X" seconds.
This allows live data to be captured in an Excel file
for storage.
8
Examples include Serial, ZTerm, PuTTy, and Minicom.
Once you have installed your preferred terminal
emulator, please connect to the TS2-16 COM port
using 115,200 baud, 8 data bits, No Parity, 1 Stop Bit.
Once you get a command prompt, type "help" for a
list of commands and their usage, as shown below:
Action
Set mode <m> for port [p] or all ports
Set charge mode for a port <p> with optional profile [cp] to enter
immediately
Show state for port [p] or all ports
Show hardware and firmware information
Show voltages, temperature, errors and boot flag
Clear error flags
Set error flags
Clear rebooted flag
Show voltage and temperature limits
List all profiles on system
Enable (1) or disable (0) profile <i>
Set profiles <l> associated with port <p>
List profiles associated with port <p>
Set or reveal security mode
Show if USB host is present, and set mode change
Show id string
Board description
Report mA for each port every <s> seconds
Report state for all ports every [s] seconds and events as they
occur
Live view (periodically updated screen showing system state)
Enter or exit mode where console is controlled by terminal
Set individual LED on row <row>, port <p> to flash bit pattern <ptn>
Set flash pattern of a string of LEDs on row <row> to string <ptnstr>
Read key click event flags
Write string <s> to LCD at row <row>, column <col>
Clear LCD
Make console beep for [ms] milliseconds
Clear terminal screen
Reboot (optionally by using watchdog timeout)
Change serial interface speed
Change internal delays
Show if USB host is present, and set mode change
Range 1...16. Omit for 'all'
c=Charge, s=Sync, o=Off, b=Biassed
Blank to use all profiles.
Optional parameters are shown in [ ]. Compulsory in < >.
Re-runs previous command.
recalls last command.
To return to the prompt at any time, please type "q".
For further advice on using CLI to control your TS2-
16, please contact support@cambrionix.com.
www.cambrionix.com