Table of Contents
Advertisement
sample Python code can be obtained from
integrate many of these functions into your process workflow alongside the full User Guide.
5.5.3 Command Line Instructions (CLI)
Command Line Instructions can also be used to control and monitor the functions of the
hub 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. If you would like more information please look at
our more in depth information here
Once you have installed your preferred terminal emulator, please connect to the hub's 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:
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> [I]
sec [arm|disarm]
host [auto|manual]
id
bd
logc <s>
loge [s]
|
PP8S
www.cambrionix.com/cli
Command
www.cambrionix.com/products/api
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, temperatures, 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 <I> 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
to help you
Action
Page 12 of 18
Advertisement
Table of Contents
