Cambrionix logoCommand Line Interface
User Manual
CLI

Introduction

This manual describes how to control products via their control interface. The Command Line Interface (CLI) enables the hub or hubs to be integrated into a larger system that is controlled by a host computer. A Serial terminal emulator must be installed to be able to use the CLI, and the emulator requires access to the COM port, so no other software, such as LiveViewer, can access the port at the same time. An example emulator that can be used is puTTY which can be downloaded from the following link.
www.putty.org
Commands that are issued via the COM port are referred to as commands. Some settings modified by commands in this document are volatile – that is, the settings are lost when the hub is rebooted or powered off, please see individual commands for detail.
Throughout this manual optional parameters are shown in square brackets: [ ]. ASCII control characters are shown within <> brackets.
This document and commands are subject to change. Data should be parsed such to be tolerant of both upper and lower case, white space, additional new line characters …etc.
You can download the latest version of this manual from our website at the following link.
www.cambrionix.com/cli

2.1. Device location

The system appears as a virtual serial port (also called a VCP). On Microsoft Windows™ , the system will appear as a numbered communication (COM) port. The COM port number can be found by accessing device manager.
On macOS®, a device file is created in the /dev directory. This is of the form/dev/tty.usbserial S where S is an alpha-numeric serial string unique to each device in the Universal Series.

2.2. USB Drivers
Communication to our products is enabled through a virtual COM port, this communication requires USB drivers.
On Windows 7 or later, a driver may automatically be installed (if Windows is configured to download drivers from the internet automatically). If this is not the case, the driver can be downloaded from www.ftdichip.com. The VCP drivers are required. For Linux® or Mac® computers, the default OS drivers should be used.

2.3. Communication Settings
The default communications settings are as below.

Communication settingValue
Number of bits per second (baud)115200
Number of data bits8
ParityNone
Number of stop bits1
Flow controlNone

ANSI terminal emulation should be selected. Command sent must be terminated withCambrionix 2023 Command Line Interface - ANSILines received by the hub are terminated withCambrionix 2023 Command Line Interface - LinesThe hub will accept back-to-back commands, however, the host computer should wait for a response before issuing a new command.

RAZER Kaira Hyperspeed Wireless Gaming Headset - Icon 1CAUTION
The hub may become unresponsive
For serial communications you must wait for a response from any commands before issuing a new command. Failure to do so can cause the hub to become unresponsive and require a full power reset.

2.4. Boot text and command prompt
At boot, the hub will issue a string of ANSI escape sequences to reset an attached terminal emulator.
The title block follows this, then a command prompt.
The command prompt received is as belowCambrionix 2023 Command Line Interface - commandExcept in boot mode where it is as belowCambrionix 2023 Command Line Interface - bootTo reach a new boot prompt, send <ETX>. This cancels any partial command string.

2.5. Products and their Firmware
Below is a list of products, their part numbers and the Firmware type it uses.

FirmwarePart NumberProduct Name
UniversalPP15SPowerPad15S
UniversalPP15CPowerPad15C
UniversalPP8SPowerPad8S
UniversalSS15SuperSync15
UniversalTS3-16ThunderSync3-16
TS3-C10TS3-C10ThunderSync3-C10
UniversalU16S SpadeU16S Spade
UniversalU8SU8S
PowerDeliveryPDS-C4PDSync-C4
UniversalModIT-MaxModIT-Max
MotorControlMotor control boardModIT-Max

2.6. Command structure
Each command follows the below format.Cambrionix 2023 Command Line Interface - EachThe command will need to be entered first, if no parameters exist for the command then this will need to be followed immediately by <CR> and <LF> to send the command.
Not every command has mandatory parameters but if they are applicable then these will need to be entered for the command to work, once the command and mandatory parameters are entered then <CR> and <LF> will be required to signify the end of a command.
Optional parameters are shown inside square brackets e.g. [port]. These do not need to be entered for the command to be sent, but if they are included they will need to be followed by <CR> and <LF> to signify the end of a command.

2.7. Response structure
Each command will receive it’s specific response followed by <CR><LF>, a command prompt and then a space. The response is terminated as shown below.

Cambrionix 2023 Command Line Interface - commandSome command responses are “live” meaning there will be a continuous response from the product until the command is cancelled by sending an <ETX> command. In these instances you will not receive the standard response as above until <ETX> command has been sent. If you disconnect the product it will not stop the data stream and reconnecting will result in the continuation of the data stream.

Commands

Below is a list of commands that are supported by all products

CommandDescription
bdProduct description
cefClear error flags
clsClear terminal screen
crfClear rebooted flag
healthShow voltages, temperature, errors and boot flag
hostShow if USB host is present, and set mode change
idShow id string
lLive view (Periodically sends responses on the current state of the product)
ledbSets the LED pattern using a bit format
ledsSets the LED pattern using a string format
limitsShow voltage and temperature limits
logeLog state and events
modeSets the mode for one or more ports
rebootReboots the product
remoteEnter or exit mode where LEDs are controlled manually or automatically
sefSet error flags
stateShow state for one or more ports
systemShow system hardware and firmware information

Below is a table of commands specific to the Universal Firmware

CommandDescription
beepMakes the product beep
clcdClear LCD
en_profileEnables or disables profile
get_profilesGet list of profiles associated with a port
keysRead key click event flags
lcdWrite a string to the LCD display
list_profilesList all profiles on system
logcLog current
secSet or get security mode
serial_speedChange serial interface speed
set_delaysChange internal delays
set_profilesSet profiles associated with a port

Below is a list of commands specific to the PD Sync and TS3-C10 Firmware

CommandDescription
detailshow state for one or more ports
logpLog current
powerset product max power or get product power for one or more ports
qcmodeset quick charge mode for one or more ports.

Below is a list of commands specific to the Motor Control Firmware

CommandDescription
gateOpen, close or stop gates
keyswitchShow state of keyswitch
proxyDistinguish commands meant for Motorcontrol board
stallSet stall current for motors,
rgbSet LEDs to RGB override enable on ports
rgb_ledSet LEDs on ports to RGBA value in hex

3.1. Notes

  1. Some products don’t support all the commands. See the Supported Products section for
  2. All commands meant for the Motor control board must be prefixed with the proxy

3.2. bd (Product Description)
The bd command provides a description of the architecture of the product. This includes all upstreand downstream ports. This is to provide external software the architecture of the USB connection tree.
Syntax: (see ‘Command structure)Cambrionix 2023 Command Line Interface - Syntax

Response: (see Response structure)
Name value pairs indicating the presence of features of the product. This is followed by a description of each USB hub in turn, listing what is attached to each port of that hub. Each port of a hub will be attached to a charging port, an expansion port, a downstream hub, a USB device or is unused.
The features are indicated by these entries:

ParameterValue
PortsThe number of USB ports
SyncA ‘1’ indicates the product provides sync capability
TempA ‘1’ indicates the product can measure temperature
EXTPSUA ‘1’ indicates the product is supplied with an external PSU that is greater than 5V

The attachment section can have the following entries, all indices are 1 based:

ParameterValueDescription
NodesnA number indicating the number of nodes this description set includes. A node will be either a USB hub or a USB controller.
Node i Typetypei is an index indicating which node this is. type is an entry from the Node Table below.
Node i PortsnA number indicating how many ports this node has.
Hub <i> Port <p>Hub <j>The USB hub <i> has a down-stream hub <j> connected to its port <p>
Control PortThe USB hub <i> has the USB serial port attached to port <p>
Expansion Port <e>The USB hub <i> has an expansion port attached to port <p>
Port <c>The USB hub <i> has the charging port <c> attached to port <p>
Optional Hub <j>The USB hub <i> may have a down-stream hub <j> connected to its port <p> but this is optional so may not be fitted
Turbo Hub <j>The USB hub <i> has a USB hub capable of operating in Turbo mode attached to port <p>
USB3 Hub <j>The USB hub <i> has a USB 3.x hub attached to port <p>
Unused PortThe USB hub <i> has nothing attached to its port <p>

Node type can be one of the following:

Node TypeDescription
Hub jA USB 2.0 hub index j
Optional Hub jA USB hub that may be fitted, index j
Root rA USB controller with a root hub which also means the USB bus number will change
Turbo Hub jA USB hub capable of operating in Turbo mode with index j
USB3 Hub jA USB 3.x hub with index j

ExampleCambrionix 2023 Command Line Interface - Example3.3 cef (Clear error flags)
The CLI has error flags which will signify if a specific error has occurred. The flags will only be cleared by using the cef command or through a product reset or power on / off cycle.

“UV”Under-voltage event occurred
“OV”Over-voltage event occurred
“OT”Over-temperature (over-heat) event occurred

If the error condition persists, the hub will set the flag again after it is cleared.

Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - Command structure

Response: (see Response structure)Cambrionix 2023 Command Line Interface - Response3.4. cls (Clear screen)
Sends ANSI escape sequences to clear and reset the terminal screen.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - ANSIResponse: (see Response structure)Cambrionix 2023 Command Line Interface - Response 1

3.5. crf (Clear rebooted flag)
The rebooted flag is to inform you if the hub has rebooted in between commands and can be cleared using the crf command.
If the rebooted flag is found to be set, then previous commands changing the volatile settings will have been lost.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - changingResponse: (see Response structure)Cambrionix 2023 Command Line Interface - changing 1

3.6. health (System health)
The health command displays the supply voltages, PCB temperature, error flags and the rebooted flag.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - health

Response: (see Response structure)
parameter: value pairs, one pair per row.

ParameterDescriptionValue
Voltage NowPresent supply voltage
Voltage MinLowest supply voltage seen
Voltage MaxHighest supply voltage seen
Voltage FlagsList of voltage supply rail error flags, separated by spacesNo flags: voltage is acceptable
UVUnder-voltage event occurred
OVOver-voltage event occurred
Temperature NowPCB temperature, °C>100 CTemperature is above 100°C
<0.0 CTemperature is below 0°C
tt.t CTemperature, e.g. 32.2°C
Temperature MinLowest PCB temperature seen, °C<0.0 CTemperature is below 0°C
Temperature MaxHighest PCB temperature seen, °C>100 CTemperature is above 100°C
Temperature FlagsTemperature error flagsNo flags: temperature is acceptable
OTOver-temperature (over-heat) event occurred
Rebooted FlagUsed to detect if system has bootedRSystem has booted or rebooted
Flag cleared using crf command

ExampleCambrionix 2023 Command Line Interface - Example 1*output from a SS15

3.7. host (Host detection)
The hub monitors the host USB socket for an attached host computer. In auto mode if the product detects a host it will change to sync mode.
The host command can be used to determine if a host computer is attached. It can also be used to prevent the hub from automatically changing modes.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - automatically

Table for mode in the Universal Firmware

Mode Description
autoThe mode of all populated ports changes automatically when a host is connected or disconnected
manualOnly commands can be used to change modes. The presence or absence of a host will not change the mode

Table for mode in the PDSync and TS3-C10 Firmware

Mode Description
autoThe ports will enable sync connectivity as the host comes and goes. Charging is always enabled unless the port is turned off.
offIf the host is no longer detected, all charging ports will be turned off.

Response if parameter is supplied: (see Response structure)Cambrionix 2023 Command Line Interface - parameter

Response if no parameter is supplied:Cambrionix 2023 Command Line Interface - parameter 1

ParameterDescriptionValue
PresentWhether a host is present or notYes / No
Mode changeThe mode the hub is inAuto /Manual

Table for present in all firmware

PresentDescription
yeshost is detected
nohost is not detected

Notes

  1.  The presence of the host computer is still reported if the mode is set to manual.
  2. On charge only products the host command is present, but as the products are charge only and cannot obtain device information the command is redundant.
  3. Only the U8S can report the host to be not present as it is the only product that has a separate control and host connection.
  4. The default host mode is auto for all products.

Examples
To set host mode to manual:Cambrionix 2023 Command Line Interface - hostTo determine if a host is present, and the get the mode:Cambrionix 2023 Command Line Interface - host Present

And with a host attached:Cambrionix 2023 Command Line Interface - attached3.8. id (Product identity)
The id command is used to identify the product and also provides some basic information about the firmware running on the product.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - Product identityResponse: (see Response structure)
A single line of text containing multiple name:value pairs separated by commas, that can be used to identify the product.Cambrionix 2023 Command Line Interface - hwid

NameValue
mfrManufacturer string (eg, cambrionix)
modeA string to describe which operating mode the firmware is in (eg, main)
hwThe part number of the hardware Part numbers)
hwidA hexadecimal value used internally to identify the product (eg, 0x13)
fwA pseudo number representing the firmware revision (eg, 1.68)
blA pseudo number representing the bootloader revision (eg, 0.15)
snA serial number. If not used will show all zeros (eg, 000000)
groupUsed on some products to order firmware updates which is useful when updating products that are daisy-chained together so that down-stream products are updated and rebooted first.
fcFirmware Code is used to denote which firmware type the product accepts

ExampleCambrionix 2023 Command Line Interface - Example 2

3.9. l (Live view)
Live view provides a continuous stream of data to view the port states and flags. Ports can be commanded using single key presses as per the table below.
Syntax (see Command structure)Cambrionix 2023 Command Line Interface - (Live viewLive view is designed to be interactive using a terminal. It makes extensive use of ANSI escape sequences to control the cursor position. Do not try to script the control of the live view.
The terminal size (rows, columns) must be large enough or the display will be corrupted. The hub attempts to set the number of rows and columns of the terminal when entering live viewmode.

Commands :
Type the below commands to interact with live view.
Select a port by typing a 2-digit port number (e.g. 01) to toggle all ports use /

CommandDescription
/Toggle all ports
oTurn port off
cTurn port to charge only
sTurn port to sync mode
q /<ETX>Quit live view

ExampleCambrionix 2023 Command Line Interface - Example 3

3.10. ledb (LED bit flash pattern)
The ledb command can be used to assign a flash bit pattern to an individual LED.
Syntax: (see Command structure)

Cambrionix 2023 Command Line Interface - ledbport: is the port number, starting at 1
row: is the LED row number, starting at 1. Typically these are arranged as follows:

Row LED Function
1Charged
2Charging
3Sync mode

ptn: can be specified as decimal (range 0..255), hexadecimal (range 00h to ffh) or binary (range 00000000b to 11111111b). Hexadecimal number must end with ‘h’. Binary numbers must end with ‘b’. More significant digits can be omitted for all radices. For example, ‘0b’ is the same as ‘00000000b’.
Hexadecimal numbers are not case-sensitive. The valid pattern characters can be seen in the LED control
Control
using the [H | R] optional parameters

Parameter Description
Htakes over control of the LED without a remote command
Rreleases control of the LED back to normal operation.

Example
To flash the charging LED on port 8 at 50/50 duty cycle, use:Cambrionix 2023 Command Line Interface - flashTo turn on the port 1 charged LED continuously (i.e. no flashing):Cambrionix 2023 Command Line Interface - chargedTo turn off the port 1 sync LED:Cambrionix 2023 Command Line Interface - ledb 1

Notes

  1. When no LEDs are present the commands is not found.
  2. The LED state is not re-established when remote mode is exited and then re-entered.

3.11. leds (LED string flash pattern)
The leds command can be used to assign a string of flash patterns to one row of LEDs. This is much faster for controlling an entire row of LEDs. Just three uses of the leds command can set all the LEDs on the system.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - leds rowrow: is address as for ledb above.
[ptnstr] is a string of characters, one per port, starting at port 1. Each character represents a different flash pattern to be assigned to the port. A string of characters will assign flash patterns to the ports.
The valid pattern characters can be seen in the LED control
Example
To set up the following flash pattern on the row containing LED one:

Port LED function
1Unchanged
2On
3Flash fast
4Single pulse
5Off
6On continuously
7On continuously
8Unchanged

Issue the command:Cambrionix 2023 Command Line Interface - leds 1Note that the first LED (port 1) needed to be skipped using the x character. Port 8 was not altered as the pattern string only contained 7 characters.

Notes

  1. When no LEDs are present the commands is not found.
  2. The LED state is not re-established when remote mode is exited and then re-entered.

3.12. limits (system limits)
To show the limits (thresholds) at which the under-voltage, over-voltage and over-temperature errors are triggered, issue the limits command.
Syntax (see Command structure)Cambrionix 2023 Command Line Interface - limits

ExampleCambrionix 2023 Command Line Interface - Example 4*output from SS15
Notes

  1. The limits are fixed in the firmware and cannot be changed by a command.
  2. The measurements are sampled every 1ms. The voltages must be over or under voltage for 20ms before a flag is raised.
  3. The temperature is measured every 10ms. A running average of 32 samples are used to give the result.
  4. If the downstream voltage is sampled twice in a row outside product specifications then the ports will be shutoff

3.13. logc (Log port current)
For the Universal firmware the logc command is used to display the current for all ports at a pre-set time interval. Alongside current temperature and fan speed.
The logging for both instances can be stopped by sending q or <ETX>.
Universal Firmware Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - Firmwareseconds is the interval between responses in the range 1..32767

Response: (see Response structure)
CSV (comma separated values).

ExampleCambrionix 2023 Command Line Interface - Example 5Notes

  1. The parameter is specified in seconds, but is confirmed as minutes:seconds for convenience:
  2.  Current logging works in both charge and sync modes.
  3. The output is rounded to 1mA prior to display

3.14. logp (Log port power)
For the PDSync and TS3-C10 firmware the logp command is used to display the current and voltage for all ports at a pre-set time interval.
The logging for both instances can be stopped by pressing q or CTRL C.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - logp[seconds] is the interval between responses in the range 1..32767
Response: (see Response structure)
CSV (comma separated values).
ExampleCambrionix 2023 Command Line Interface - Example 6

Notes

  1. The parameter is specified in seconds, but is confirmed as minutes:seconds for convenience:
  2. Current logging works in both charge and sync modes.
  3. The output is rounded to 1mA prior to display

3.15. loge (Log events)
The loge command is used to report port status change events and periodically report the state of all ports.
The logging is stopped by sending <ETX>
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - logging[seconds] is the interval between responses in the range 0..32767
Response: (see Response structure)
CSV (comma separated values).
Example
Here is a device being attached to port 4, left for 6 seconds, and then removed:Cambrionix 2023 Command Line Interface - Example 7

Notes

  1. Commands are accepted while in this mode but commands are not echoed and the command prompt is not issued.
  2. If a seconds value of ‘0’ is specified then the periodic reporting is disabled and only port status change events will be reported. If no seconds parameter is supplied a default value of 60s will be used.
  3. A time stamp in seconds is output before each event or periodic report the time stamp is the time the hub is switched on.

3.16. mode (Hub mode)
Each port can be placed into one of four modes by using the mode command.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - mode m

ParameterDescription
mA valid mode character
pThe port number
cpThe charging profile

Response: (see ‘Response structure)Cambrionix 2023 Command Line Interface - Response 2

mode parameters for Universal Firmware

Parameter Description Value
ChargeThe port is readied for charging a device, and can detect if a device is attached or detached. If a device is attached, the charger profiles enabled for that port are tried one by one. Then the device is charged using the profile that yielded the highest current. During the above, the port is disconnected from the host USB bus.s
SyncThe port is attached to the host USB bus via a USB hub. The device may draw charging current from VBUS depending on the device capabilities.b
BiasedPort is detected but no charging or syncing will take place.o
OffPower to the port is removed. No charging occurs. No device attach or detach detection is possible.c

mode parameters for PDSync and TS3-C10 Firmware

Parameter Description Value
SyncThe device can charge whilst communicating with the host connected to the hub.c
OffPower (VBUS) to the port is removed. No charging occurs. No device attach or detach detection is possible.o

The port parameter
[p], is optional. It can be used to specify the port number. If left blank, all ports are affected by the command.
The charging profile parameter
[cp] is optional but can only be used when putting a single port into charge mode. If specified then that port will directly enter charge mode using the chosen profile.

Profile parameteDescription
0Intelligent charging algorithmwhich will select a profile 1-6
12.1A (Apple and others with short detection time)
2BC1.2 Standard (This covers the majority of Android phones and other devices)
3Samsung
42.1A (Apple and others with long detection time)
51.0A (Typically used by Apple)
62.4A (Typically used by Apple)

Examples
To turn off all ports:Cambrionix 2023 Command Line Interface - mode oTo put just port 2 in charge mode:

Cambrionix 2023 Command Line Interface - mode c

To put just port 4 in charge mode using profile 1:Cambrionix 2023 Command Line Interface - mode 1

3.17. Reboot (reboot the product)
Reboots the product.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - RebootsIf the watchdog parameter is included then the systemwill lock into an infinite, unresponsive loop whilst the watchdog timer expires. The expiration takes several seconds, after which the systemwill reboot.
If the reboot command is issued without a parameter, the reboot command is executed immediately.
Response: (see ‘Response structure)Cambrionix 2023 Command Line Interface - immediatelyThe reboot command is a soft reset which will only affect software. To perform a full product reset you will need to power-cycle the hub.
Rebooting sets the ‘R’ (rebooted) flag, which is reported by the health and state commands.

3.18. remote (Remote control)
Some products have interface devices such as indicators, switches and displays which can be used to interact with the hub directly. The function of these interfaces can be controlled via commands. This command disables normal function, and allows control via commands instead.

Entering remote control mode
The indicators will be turned off when entering remote control mode. The display will be unaffected and previous text will remain. Use clcd to clear the display. To disable the console control from the firmware, and allow it to be controlled via commands, issue the remote command without parameters:
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - EnteringTo leave remote control mode, and allow the console to be controlled by the firmware, issue an exit command parameter.

Parameteexit Description
exitThe LEDs will be reset and the LCD cleared when leaving remote control mode.
kexitTells the hub to enter remote control mode, but exit automatically when a console key is pressed:

Notes

  1. In remote kexit mode, the keys command will not return key press events.
  2. You can move from remote mode into remote kexit mode, and vice-versa.
  3. Charging, syncing and security still operate in remote mode. However, their status will not be reported to the console, and the user will need to poll the status flags (using the state and health commands) to determine the system state.
  4. If the keys, lcd, clcd, leds or ledb commands are issued when not in remote or remote kexit mode, then an error message will be shown, and the command will not be executed.

3.19. sef (Set Error flags)
It can be useful to set the error flags to examine the system behaviour when an error occurs.
Syntax: (see Command structure)

Cambrionix 2023 Command Line Interface - sef flagsflags is one or more of the below parameters, when sending multiple flags a space is required between each parameter.

ParameterDescription
3UV3V rail under-voltage
3OV3V rail over-voltage
5UV5V rail under-voltage
5OV5V rail over-voltage
12UV12V rail under-voltage
12OV12V rail over-voltage
OTPCB over-temperature

Example
To set the 5UV and OT flags:Cambrionix 2023 Command Line Interface - sef 5UV OT

Notes

  1. Calling sef without parameters is valid, and sets no error flags.
  2. Error flags may be set using sef on any product even if the flag is not relevant to the hardware.

3.20. state (List port state)
After a port is placed into a particular mode (e.g. charge mode) it can transition into a number of states. The state command is used to list the state of each port. It also shows the current being delivered to the device, any error flags, and the charge profile employed.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - state[p] is the port number.
Response: (see Response structure)
Comma separated parameters, one row per port.
Row format: p, current_mA, flags, profile_id, time_charging,time_charged,energy

ParameterDescription
pThe port number pertaining to the row
current_mACurrent being delivered to the mobile device, in mA (milliamperes)
flagsSee below tables
profile_id TThe unique profile ID number. “0” if not charging or profiling
time_chargingTime in seconds the port has been charging
time_chargedTime in seconds that the port has been charged for ( x means not valid yet).
energyEnergy the device has consumed in watthours ( calculated every second)

Note : See product manual for current measurement resolution.
Flags for the Universal firmware range

List of case-sensitive flag characters, separated by spaces. O, S, B, I, P, C, F are mutually exclusive. A, D are mutually exclusive.
FlagDescription
OPort is in OFF mode
SPort is in SYNC mode
BPort is in Biased mode
IPort is in charge mode, and is IDLE
PPort is in charge mode, and is PROFILING
CPort is in charge mode, and is CHARGING
FPort is in charge mode, and is has FINISHED charging
ADevice is ATTACHED to this port
DNo device is attached to this port. Port is DETACHED
TDevice has been stolen from port: THEFT
EERRORs are present. See health command
RSystem has REBOOTED. See crf command
rVbus is being reset during mode change

Flags for the PDSync and TS3-C10 firmware range
3 flags are always returned for the Powerync firmware

List of case-sensitive flag characters, separated by spaces. Flags may mean different things in different columns
1st flagDescription
ADevice is ATTACHED to this port
DNo device is attached to this port. Port is DETACHED
PPort has established a PD contract with device
CCable has non-type-C connector at far end, no device detected
2nd flag
IPort is IDLE
SPort is the host port and is connected
CPort is CHARGING
FPort has FINISHED charging
OPort is in OFF mode
cPower is enabled on port but no device is detected
3rd flag
_Quick charge mode is disallowed
+Quick charge mode is allowed but not enabled
qQuick charge mode is enabled but not in use
QQuick charge mode is in use

Flags for the Motor Control firmware range
Case sensitive flag characters. One of o, O, c, C, U will always be present. T and S are only present when their condition is detected.

FlagDescription
oGate is opening
OGate is open
cGate is closing
CGate is closed
UGate position is unknown, neither open nor closed and not moving
SA stall condition was detected for this gate when it was last commanded to move
TA timeout condition was detected for this gate when it was last commanded to move. ie the gate did not finish moving in a reasonable time nor did it stall.

Examples
A device connected to port 5, which is charging at 1044mA using profile_id 1Cambrionix 2023 Command Line Interface - device connectedAnother device attached to port 8. This is being profiled using profile_id 2 prior to charging:Cambrionix 2023 Command Line Interface - Another deviceA global system error reported by the EE flag:Cambrionix 2023 Command Line Interface - global3.21. system (View system parameters)
To view system parameters, issue the system command.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - systemResponse: (see Response structure)
First row: system title text.
Subsequent rows: parameter:value pairs, one pair per row.Cambrionix 2023 Command Line Interface - Title text

Parameter Description Possible values
HardwarePart number
FirmwareFirmware version stringIn a “n.nn” format, n is a decimal number 0..9
CompiledRelease time and date of the Firmware
GroupGroup letter read from PCB jumpers1 character, 16 values: “-”, “A” .. “O” “-”means no group jumper is fitted
Panel IDPanel ID number of front panel product“None” if no panel was detected Otherwise “0” .. “15”
LCDPresence of LCD display“Absent” or “Present” If product can support an LCD

Notes

  1. The system title text may change across firmware releases.
  2. The ‘Panel ID’ is updated at power-up or reboot.
  3. The ‘LCD’ parameter can only become ‘Present’ at power-up or reboot. It can become ‘Absent’ during run-time if the LCD is no longer detected. Only applicable to products with removable displays.

3.22. beep (Make product beep)
Makes the sounder beep for a specified amount of time. The beep is performed as a background task – so the system can process other commands whilst the beep is produced.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - beep

Parameter Description
msthe length of beep in milliseconds (range 0..32767)

Response: (see Response structure)Cambrionix 2023 Command Line Interface - Response 3Notes

  1. The time [ms] has a resolution of 10ms
  2. A beep will not be interrupted by a shorter or zero-length beep.
  3. The beep from an alarm is overridden by the continuous tone from a beep command. when the continuous beep completes, the systemwill return to the alarm beep.
  4. Sending <BEL> from the terminal will cause a short beep to be generated.
  5. Beeps are only audible on products with sounders fitted.

3.23. clcd (Clear LCD)
The lcd is cleared by using the clcd command.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - lcdResponse: (see Response structure)Cambrionix 2023 Command Line Interface - lcd 1

Notes

  1. This is only applicable to products fitted with displays.

3.24. get_profiles (get port profiles)
To get the profiles assigned to a port, use the get_profiles command. For more information on profiles see Charging profiles
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - profilesp: is the port number
Response: (see Response structure’)
Port profiles are listed and defined whether they are enabled or disabled
Example
To get the profiles assigned to port 1:Cambrionix 2023 Command Line Interface - Example 83.25. set_profiles (set port profiles)
To assign profiles to an individual port, use the set_profiles command. For more information on profiles see Charging profiles
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - profiles

Parameter Description
pPort number
cpCharging profile

To assign all system profiles to a port, issue set_profiles without a list of profiles.
Response: (see Response structure)Cambrionix 2023 Command Line Interface - profiles 1Example
To set profiles 2 and 3 for port 5:Cambrionix 2023 Command Line Interface - profiles 2To assign all profiles to port 8:Cambrionix 2023 Command Line Interface - profiles 3

Notes

  1. Use get_profiles to obtain list of profiles set on each port.

3.26. list_profiles (List global profiles)
The list of profiles can be obtained by using the list_profiles command: For more information on profiles see Charging profiles
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - list_profilesResponse: (see Response structure)
Each profile listed has 2 parameters separated by a comma: profile_id, enabled_flag.
The profile_id is a unique number that always corresponds to one profile type. It is a positive integer starting at 1. A profile_id of 0 is reserved for when the absence of a profile is to be indicated.
enabled_flag can be enabled or disabled depending on whether the profile is active on the product.
ExampleCambrionix 2023 Command Line Interface - enabled_flag3.27. en_profile (Enable / disable profiles)
The en_profile command is used to enable and disable each profile. The effect applies to all ports.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - command 2

Parameter Description Value
iProfile parametersee below table
eEnable flag1 = enabled
0 = disabled
Profile parameter Description
0Intelligent charging algorithmwhich will select a profile 1-6
12.1A (Apple and others with short detection time)
2BC1.2 Standard (This covers the majority of Android phones and other devices)
3Samsung
42.1A (Apple and others with long detection time)
51.0A (Typically used by Apple)
62.4A (Typically used by Apple)

Response: (see Response structure)

Cambrionix 2023 Command Line Interface - profiles 1

Example
To disable a profile for all ports use the command:Cambrionix 2023 Command Line Interface - disableOperation with no enabled profiles
If all profiles for a port are disabled, the port will transition into the Biased port state. This permits device attach and detach detection to work, but no charging will occur. Security (theft detection) will still operate if all profiles are disabled, as will the attach (AA) and detach (DD) flags reported by the state command.

Notes

  1.  This command has an immediate effect. If the command is issued whilst a port is profiling, then the command will only have an effect if that profile has not yet been reached.

3.28. keys (Key states)
The product may be fitted with up to three buttons. When a button is pressed, a key ‘click’ flag is set.
This flag remains set until it is read. To read the key click flags, use the keys command. The result is a comma-separated list, with one flag per key:
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - keys

Keys A, B and C are listed respectively. A ‘1’ means the key has been pressed since the keys command was last called. The flags are cleared after keys is run:
Notes

  • The keys command only works in remote mode. It does not work in remote kexit mode
  • This command will only work on products with buttons installed.

3.29. lcd (Write to the LCD)
If an LCD is attached, it can be written to by using this command.
Syntax: (see ‘Command structure)Cambrionix 2023 Command Line Interface - lcd row

ParameterDescription
row0 is the first row, 1 is for the second row
colThe column number, starting at 0
stringDisplayed on the LCD. It may contain spaces before, within and after.

Example
To write “Hello, world” on the far left of the second row:Cambrionix 2023 Command Line Interface - lcd 2Displaying Icons
As well as ASCII characters, the LCD can display several custom icons. These are accessed by sending the escape sequence <ESC> c, where c is the character ‘1’ .. ‘8’:

cIcon
1Empty battery
2Continuously animated battery
3Cambrionix filled ‘o’ glyph
4Full battery
5Padlock
6Egg timer
7Custom numeral 1 (aligned to right of bitmap)
8Custom numeral 1 (aligned to middle of bitmap)

3.30. sec (Device security)
The product can log if a device was unexpectedly removed from a port. The sec command can be used to put all ports into an ‘armed’ security state. If a device is removed in the armed state, then an alarm can be triggered, and the T flag is shown.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - armdisarmResponse to no parameters: (see Response structure)Cambrionix 2023 Command Line Interface - disarmedResponse to arm|disarm parameter: (see Response structure)Cambrionix 2023 Command Line Interface - profiles 1Examples
To arm the system:Cambrionix 2023 Command Line Interface - ec arm

To disarm the system:Cambrionix 2023 Command Line Interface - sec disarmTo obtain the armed state:Cambrionix 2023 Command Line Interface - sec disarmed

Notes

  • If theft detection is needed, but no device charging or syncing is desired, set the ports to Biased mode. If using Biased mode and the device battery runs out then the alarmwill be raised
  • To clear all theft bits and silence a sounding alarm, disarm then re-arm the system.

3.31. serial_speed (Set serial speed)
Sets the serial speed.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - speed

ParameterDescription
testTest whether the product supports an increase in serial speed from current speed
fastIncrease serial speed
slowReduce serial speed

Response: (see Response structure)Cambrionix 2023 Command Line Interface - Response 4

Response Description
OKThe product supports an increase in speed
ErrorThe product does not support an increase in speed

You should flush the serial buffer after the first “serial_speed fast“ before the speed is changed to 1Mbaud. If during operation at 1Mbaud any serial errors are detected the speed is automatically dropped to 115200baud without warning. The host code must be aware of this and take suitable action. If the link regularly fails do not to try increase the speed again.
Example
To increase the serial speed to 1Mbaud use the following sequence:Cambrionix 2023 Command Line Interface - speed fastIf any error is detected in the above sequence the speed increase won’t occur or will be reset.
Before exiting the host should return the speed back to 115200baud with the following commandCambrionix 2023 Command Line Interface - serial_speed slowFailure to do so will result in the first characters being lost until the hub detects the incorrect baud rate as serial errors and drops back to 115200baud.

3.32. set_delays (Set delays)
Sets internal delays
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - set_delays

ParameterDescriptionDefault values
port_reset_ delay_msTime left unpowered when changing modes. (ms)400
attach_blanking_ msTime device attach detection will be delayed to avoid a quick insert and  removal. (ms)2000
deattach_countReserved for future use.30
deattach_sync_ countA number value to set the depth of filtering a deattach event in sync mode14

Response: (see Response structure)

Cambrionix 2023 Command Line Interface - profiles 1

Notes

  • The use of this command may prevent correct charging.
  • ADET_PIN gives a false positive (it shows a device is attached when none is present). It remains in this erroneous state for about 1 second after leaving PORT_MODE_OFF.

3.33. boot (Enter boot-loader)
Boot mode is used to update the firmware within the hub. We do not provide public information about using the hub in boot mode.
If you find the product in boot mode, you can return to normal operation by sending the reboot command or by power-cycling the system.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface -bootResponse: (see Response structure)Cambrionix 2023 Command Line Interface - boot 1

3.34. gate (Gate command)
The gate command is used to control the movement of gates.
Syntax: (see Command structure)

Cambrionix 2023 Command Line Interface - position

Parameter Description
positionThe desired gate command (stop|open|close)
portEither the port number or ‘all’ for all ports
strengthAn integer that alters the speed of movement (0-2047)

Response: (see Response structure)

Cambrionix 2023 Command Line Interface - profiles 1

3.35. proxy
In order to distinguish commands targeted at the Motor Control Board from those for the host unit itself, there is a host unit command ‘proxy’ which takes as its arguments the commands for the Motor Control Board.
The user must prefix all the commands meant for the Motor Control board with ‘proxy’ when they are sent to the host unit’s command line interface.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - proxy3.36. keyswitch
To show the current position of the keyswitch issue the keyswitch command.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - keyswitchResponse: (see Response structure)Cambrionix 2023 Command Line Interface - parameter

Parameter Description
OpenThe keyswitch is in the open position.
ClosedThe keyswitch is in the closed position.

3.37. rgb
The rgb command is used to set one or more ports into LED override mode. In order to set the individual RGB LED levels on a port, the port must first be set into LED override mode which will stop the mirroring of the host unit’s LEDs onto that port. On entering LED override mode the LEDs on that port will all be turned off.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - rgb override

Override parameterDescription
startUsed to enter RGB override mode
leaveUsed to exit override mode

p is the port number.
Response: (see Response structure)Cambrionix 2023 Command Line Interface - profiles 13.38. rgb_led
The rgb_led command is used to set the RGB LED levels on one or more ports to the value specified.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - rgb override

Override parameterDescription
pA single port or a range of ports.
levelAn eight digit hex number that represents the levels to set for the RGB LEDs. in the format ‘aarrggbb’
level parametersDescription
aaSets the maximum level for the LEDs on this port, the other LEDs are all scaled from this setting
rrSets the level for the Red LED
ggSets the level for the Green LED
bbSets the level for the Blue LED

Response: (see Response structure

Cambrionix 2023 Command Line Interface - profiles 13.39. stall
The stall command is used to set the current at which it is determined that a gate has stalled.
Syntax: (see Command structure)Cambrionix 2023 Command Line Interface - tall current

ParameterDescription
currentThe value in mA that will be used as the level of current draw by the motor above which it is determined that a gate has stalled.

Response: (see Response structure)Cambrionix 2023 Command Line Interface - profiles 1

Errors

Failed commands will respond with an error code of the form below.Cambrionix 2023 Command Line Interface - Explanation

“nnn” is always a three digit decimal number.
Command error codes

Error codeError nameDescription
400ERR_COMMAND_NOT_RECOGNISEDCommand is not valid
401ERR_EXTRANEOUS_PARAMETERToo many parameters
402ERR_INVALID_PARAMETERParameter is not valid
403ERR_WRONG_PASSWORDInvalid password
404ERR_MISSING_PARAMETERMandatory parameter missing
405ERR_SMBUS_READ_ERRInternal system management communication read error
406ERR_SMBUS_WRITE_ERRInternal system management communication write error
407ERR_UNKNOWN_PROFILE_IDInvalid profile ID
408ERR_PROFILE_LIST_TOO_LONGProfile list exceeds limit
409ERR_MISSING_PROFILE_IDRequired profile ID missing
410ERR_INVALID_PORT_NUMBERPort number not valid for this product
411ERR_MALFORMED_HEXADECIMALInvalid hexadecimal value
412ERR_BAD_HEX_DIGITInvalid hex digit
413ERR_MALFORMED_BINARYInvalid binary
414ERR_BAD_BINARY_DIGITInvalid binary digit
415ERR_BAD_DECIMAL_DIGITInvalid decimal digit
416ERR_OUT_OF_RANGENot within defined range
417ERR_ADDRESS_TOO_LONGAddress exceeds character limit
418ERR_MISSING_PASSWORDRequired password missing
419ERR_MISSING_PORT_NUMBERRequired port number missing
420ERR_MISSING_MODE_CHARRequired mode character missing
421ERR_INVALID_MODE_CHARInvalid mode character
422ERR_MODE_CHANGE_SYS_ERR_FLAGSystem error on mode change
423ERR_CONSOLE_MODE_NOT_REMOTERemote mode required for product
424ERR_PARAMETER_TOO_LONGParameter has too many characters
425ERR_BAD_LED_PATTERNInvalid LED pattern
426ERR_BAD_ERROR_FLAGInvalid error flag

Example
Specifying a non-existent port to the mode command:Cambrionix 2023 Command Line Interface - mode 54.1. Fatal errors
When the system encounters a fatal error, the error is reported to the terminal immediately in the following format:Cambrionix 2023 Command Line Interface - ERROR Ennn

“nnn” is a three-digit error reference number.
“Explanation” describes the error.
When a fatal error has occurred the CLI will only respond to <ETX> and <CR>. If either of these are received, then the systemwill enter boot mode. If <ETX> or <CR> are not received within the watchdog timeout period (approximately 9 seconds) then the systemwill reboot.

Important
If a fatal error occurs whilst a command is sending a <ETX> or ENTER character to the hub, then boot mode will be entered. If the product enters boot mode then you will need to send the reboot command to return to normal operation.
Boot mode is indicated by receiving the below response (sent on a new line)Cambrionix 2023 Command Line Interface -boot In boot mode, non-bootloader commands will be responded to with:Cambrionix 2023 Command Line Interface - bootloaderFor testing purposes, boot mode can be entered by using the boot command.

Charging profiles

When a device is attached to a hub, the product can provide a variety of different charging levels.
Each of these different variations is called a ‘profile’. Some devices will not charge properly unless presented with the correct profile. A device not presented with a charging profile it recognises will draw less than 500mA as per USB specifications.
When a device is attached to the product, and it is in ‘charge mode’, it tries each profile in turn. Once all the profiles have been tried, the hub selects the profile that drew the highest current.
In some cases it may not be desirable for the hub to scan all the profiles in this way. For example, if only devices from one manufacturer are attached, then only that specific profile will need to be active. This reduces the time delay when a user attaches a device, and sees evidence of the device charging properly.
The hub provides the means to limit the profiles tried, both on a ‘global’ level (across all ports) and on a port-by-port basis.

Profile parameterDescription
0Intelligent charging algorithmwhich will select a profile 1-6
12.1A (Apple and others with short detection time)
2BC1.2 Standard (This covers the majority of Android phones and other devices)
3Samsung
42.1A (Apple and others with long detection time)
51.0A (Typically used by Apple)
62.4A (Typically used by Apple)

Port modes

The port modes are defined by the ‘host’ and ‘mode’ commands.

ChargeTurn specific ports or the whole hub to charge mode
SyncTurn specific ports or the whole hub to sync mode (data and power channels open)
BiasedDetect the presence of a device but it will not sync or charge it.
OffTurn specific ports on or off or switch the whole hub on or off. (no power and no data channels open)

Not all products have each mode available, check individual product user manuals for the modes that are supported.

LED control

There are two methods to control to the LEDs in remote control mode: ledb and leds. First, however, the operation of the LEDs will be described.
The flash pattern is an 8-bit byte. Each bit is repeatedly scanned in sequence fromMSB to LSB (i.e. left to right). A ‘1’ bit turns the LED on, and a ‘0’ turns it off. For example, a bit pattern of decimal 128 (binary 10000000b) would pulse the LED briefly. A bit pattern of decimal 127 (binary 01111111b) would see the LED on for most of the time, only turning off briefly.

Pattern CharacterLED functionFlash pattern
0 (number)Off00000000
1On continuously (not flashing)11111111
fFlash fast10101010
mFlash medium speed11001100
sFlash slowly11110000
pSingle pulse10000000
dDouble pulse10100000
O (Capital letter)Off (no remote command needed)00000000
COn (no remote command needed)11111111
FFlash fast (no remote command needed)10101010
MFlash medium speed (no remote command needed)11001100
SFlash slowly (no remote command needed)11110000
PSingle pulse (no remote command needed)10000000
DDouble pulse (no remote command needed)10100000
RRelease “no remote command needed “ LEDs back to normal use
xunchangedunchanged

In auto mode the defaults can be seen in the table below, some products may vary so please see individual product user manuals to confirm LED functions.
www.cambrionix.com/product-user-manuals

LED TypeMeaningConditionsIndicator Light Display
PowerPower Off● Soft power off (standby) or no powerOff
PowerPower On No Host Connected● Power on
● No fault with the product
Green
PowerPower On Host Connected● Power on
● No fault with the product
● Host connected
Blue
PowerFault with code● Major fault conditionRed Flashing (Fault code pattern)
PortDevice Disconnected / Port Disabled● Device disconnected or port disabledOff
PortNot Ready / Warning● Device resetting, starting, changing mode of operation or updating firmwareYellow
PortCharge Mode Profiling● Fault with connected deviceGreen Flashing (on/off in once second intervals)
PortCharge Mode Charging● Port in charge mode
● Device connected and charging
Green Pulsing (dim/brightens in one second intervals)
PortCharge Mode Charged● Port in charge mode
● Device connected, and charge threshold met or unknown
Green
PortSync Mode● Port in sync modeBlue
PortFault● Fault with connected deviceRed

Internal hub Settings

8.1. Introduction
Cambrionix products have Internal settings which are used to store settings which need to remain even after the product has had power removed. This section describes how to apply Internal hub setting changes along with their affect on the product they are applied to.
There are two methods for changing the product settings:

  1. Entering the required command settings.
  2. Change the settings on the LiveViewer application.
RAZER Kaira Hyperspeed Wireless Gaming Headset - Icon 1CAUTION
Changing Internal hub settings on a Cambrionix product may cause the product to function incorrectly.

8.2. Internal hub settings and their correct usage.
Notes:

  • Only if a command succeeds will there be a visible response within the terminal window.
  • The command settings_unlock needs to be entered prior to a settings_set or settings_reset command
SettingUsage
settings_ unlockThis command unlocks the memory for writing. This command must directly precede settings_set and settings_reset.
It is not possible to change NV RAM settings without entering this command.
settings_ displayDisplays the current NV RAM settings in a formwhich can be copied and pasted back into the serial terminal. Also useful to create a .txt file backup of your settings for future reference.
settings_ resetThis command resets the memory back to the default settings. This command must be preceded by settings_unlock. The existing settings are displayed before being reset. Only if the command succeeds will there be a response.
company_ name <name>Sets the company name. The name cannot contain ‘%’ or ‘\’. Maximum length of the name is 16 characters. This command must be preceded by settings_set
default_ profile <list>Sets the default profile to be used by each port. <list> is a space separated list of the profile number to be applied to each port in ascending order. Specifying a profile of ‘0’ for any port means that there is no default profile applied to that port, this is the default behaviour on reset. All ports must have an entry in the list. This command must be preceded by settings_set
1 = Apple 2.1A or 2.4A if the product supports 2.4A charging (short detect time).
2 = BC1.2 which covers a number of standard devices.
3 = Samsung charging profile.
4 = Apple 2.1A or 2.4A if the product supports 2.4A charging (long detection time).
5 = Apple 1A profile.
6 = Apple 2.4A profile.
remap_ ports <list>This setting allows you to map ports numbers on the Cambrionix products to port numbers on your own product, which may not have the same number order. This command must be preceded by settings_set
ports_on <list>Sets a port to be always powered regardless of attach status. This must only be used in conjunction with a default profile. <list> is a space separated list of flags for each port in ascending order. A ‘1’ denotes that the port will be always powered. A ‘0’ denotes default behaviour which is that the port will not be powered until an attached device is detected. This command must be preceded by  settings_set
sync_chrg <list>‘1’ denotes thats CDP is enabled for a port. CDP cannot be turned off with ThunderSync products. This command must be preceded by settings_set
charged_ threshold <0000>Sets the charged_threshold in 0.1mA steps must have leading zeros to make a four digit number. This command must be preceded by settings_set

8.3. Examples
To reset a Cambrionix product back to factory defaults:Cambrionix 2023 Command Line Interface - settings_unlockTo view the current settings on a Cambrionix product:Cambrionix 2023 Command Line Interface - settings_displayTo configure a PowerPad15S to perform in a similar manner to the discontinued BusMan product (ie. no automatic switching between charging and sync modes if a host is connected or disconnected)Cambrionix 2023 Command Line Interface - settings_unlock 1To change the attach threshold on a Cambrionix product to 30mACambrionix 2023 Command Line Interface - settings_unlock 1To set the Company and Product name on a Cambrionix product to match your own (applicable to OEM products only): Cambrionix 2023 Command Line Interface - settings_unlock

Supported Products

Here you can find a table with all commands and which products they are valid for.

U8SU16S SpadePP15SPP8SPP15CSS15TS2- 16TS3- 16TS3- C10PDS- C4ModIT- Max
bdxxxxxxxxxxx
cefxxxxxxxxxxx
clsxxxxxxxxxxx
crfxxxxxxxxxxx
healthxxxxxxxxxxx
hostxxxxxxxxxx
idxxxxxxxxxxx
lxxxxxxxxxxx
ledbxxxxxxx
ledsxxxxxxx
limitsxxxxxxxxxxx
logexxxxxxxxxxx
modexxxxxxxxxxx
rebootxxxxxxxxxxx
remotexxxxxxx
sefxxxxxxxxxxx
statexxxxxxxxxxx
systemxxxxxxxxxxx
beepxxxxxxxxxxx
clcdxxx
en_profilexxxxxxxxx
get_ profilesxxxxxxxxx
keysxxx
lcdxxx
list_ profilesxxxxxxxxx
logcxxxxxxxxx
secxxx
serial_ speedxxxxxxxxx
set_delaysxxxxxxxxx
set_ profilesxxxxxxxxx
detailxxxxxxxxxxx
logpxx
powerxx
qcmodex
gatex
keyswitchx
proxyx
stallx
rgbx
rgb_ledx

ASCII Table

dechexoctcharCtrl char
00000<NULL>ctrl-@
11001<SOH>ctrl-A
22002<STX>ctrl-B
33003<ETX>ctrl-C
44004<EOT>ctrl-D
55005<ENQ>ctrl-E
66006<ACK>ctrl-F
77007<BEL>ctrl-G
88010<BS>ctrl-H
99011<TAB>ctrl-I
10a012<LF>ctrl-J
11b013<VT>ctrl-K
12c014<FF>ctrl-L
13d015<CR>ctrl-M
14e016<SOH>ctrl-N
15f017<SI>ctrl-O
1610020<DLE>ctrl-P
1711021<DC1>ctrl-Q
1812022<DC2>ctrl-R
1913023<DC3>ctrl-S
2014024<DC4>ctrl-T
2115025<NAK>ctrl-U
2216026<SYN>ctrl-V
2317027<ETB>ctrl-W
2418030<CAN>ctrl-X
2519031<EM>ctrl-Y
261a032<SUB>ctrl-Z
271b033<ESC>ctrl-[
281c034<FS>ctrl-\
291d035<GS>ctrl-]
301e036<RS>ctrl-^
311f037<US>ctrl-_
3220040space
3321041!
3422042
3523043#
3624044$
3725045%
3826046&
3927047
4028050(
4129051)
422a052*
432b053+
442c054,
452d055
462e056.
472f057/
48300600
49310611
50320622
51330633
52340644
53350655
54360666
55370677
56380708
57390719
583a072:
593b073;
603c074<
613d075=
623e076>
633f077?
6440100@
6541101A
6642102B
6743103C
6844104D
6945105E
7046106F
7147107G
7248110H
7349111I
744a112J
754b113K
764c114L
774d115M
784e116N
794f117O
8050120P
8151121Q
8252122R
8353123S
8454124T
8555125U
8656126V
8757127W
8858130X
8959131Y
905a132Z
915b133[
925c134\
935d135]
945e136^
955f137_
9660140`
9761141a
9862142b
9963143c
10064144d
10165145e
10266146f
10367147g
10468150h
10569151i
1066a152j
1076b153k
1086c154l
1096d155m
1106e156n
1116f157o
11270160p
11371161q
11472162r
11573163s
11674164t
11775165u
11876166v
11977167w
12078170x
12179171y
1227a172z
1237b173{
1247c174|
1257d175}
1267e176~
1277f177DEL

Terminology

TermExplanation
U8 devicesAny device in the U8 sub-series. E.g. U8C, U8C-EXT, U8S, U8S-EXT
U16 devicesAny device in the U16 sub-series. E.g. U16C, U16S Spade
VCPVirtual COM port
/dev/Devices directory on Linux® and macOS®
ICIntegrated Circuit
PWMPulse width modulation. The duty cycle is the percent of time the PWM is in the high (active) state
Sync modeSynchronisation mode (hub provides USB connection to host computer)
PortUSB socket on the front of hub that is used to connect mobile devices.
MSBMost significant bit
LSBLeast significant bit
Internal hubNon-Volatile RAM

Licensing

The use of Command Line Interface is subject to the Cambrionix Licence agreement, the document can be downloaded and viewed using the following link.
https://downloads.cambrionix.com/documentation/en/Cambrionix-Licence-Agreement.pdf

Use of Trademarks, Registered Trademarks, and other Protected Names and Symbols
This manual may make reference to trademarks, registered trademarks, and other protected names and or symbols of third-party companies not related in any way to Cambrionix. Where they occur these references are for illustrative purposes only and do not represent an endorsement of a product or service by Cambrionix, or an endorsement of the product(s) to which this manual applies by the third-party company in question.
Cambrionix hereby acknowledges that all trademarks, registered trademarks, service marks, and other protected names and /or symbols contained in this manual and related documents are the property of their respective holders
“Mac® and macOS® are trademarks of Apple Inc., registered in the U.S. and other countries and regions.”
“Intel® and the Intel logo are trademarks of Intel Corporation or its subsidiaries.”
“Thunderbolt™ and the Thunderbolt logo are trademarks of Intel Corporation or its subsidiaries.”
“Android™ is a trademark of Google LLC”
“Chromebook™ is a trademark of Google LLC.”
“iOS™ is a trademark or registered trademark of Apple Inc,in the US and other countries and is used under license.”
“Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries”
“ Microsoft™ and Microsoft Windows™ are trademarks of the Microsoft group of companies.”
“Cambrionix® and the logo are trademarks of Cambrionix Limited.”

© 2023-05 Cambrionix Ltd. All rights reserved.

Cambrionix Limited
The Maurice Wilkes Building
Cowley Road
Cambridge CB4 0DS
United Kingdom
+44 (0) 1223 755520
enquiries@cambrionix.com
www.cambrionix.com
Cambrionix Ltd is a company registered in England and Wales
with the company number 06210854

Documents / Resources

Cambrionix 2023 Command Line Interface [pdf] User Manual
2023 Command Line Interface, 2023, Command Line Interface, Line Interface, Interface

References

Leave a comment

Your email address will not be published. Required fields are marked *