CAMBRIONIX ThunderSync3-16, User Manual

Page: 8 / 12

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