Cambrionix 2023 Command Line Interface User Manual

Node type can be one of the following:

will change
Turbo Hub j| A USB hub capable of operating in Turbo mode with index j
USB3 Hub j| A USB 3.x hub with index j

Example 3.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.

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

Syntax: (see Command structure)

Response: (see Response structure) 3.4. cls (Clear screen)
Sends ANSI escape sequences to clear and reset the terminal screen.
Syntax: (see Command structure) Response: (see Response structure)

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) Response: (see Response structure)

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

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

No flags: voltage is acceptable
UV| Under-voltage event occurred
OV| Over-voltage event occurred
Temperature Now| PCB temperature, °C| >100 C| Temperature is above 100°C
<0.0 C| Temperature is below 0°C
tt.t C| Temperature, e.g. 32.2°C
Temperature Min| Lowest PCB temperature seen, °C| <0.0 C| Temperature is below 0°C
Temperature Max| Highest PCB temperature seen, °C| >100 C| Temperature is above 100°C
Temperature Flags| Temperature error flags| | No flags: temperature is acceptable
OT| Over-temperature (over-heat) event occurred
Rebooted Flag| Used to detect if system has booted| R| System has booted or rebooted
| Flag cleared using crf command

Example *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)

Table for mode in the Universal Firmware

connected or disconnected
manual| Only 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

Charging is always enabled unless the port is turned off.
off| If the host is no longer detected, all charging ports will be turned off.

Response if parameter is supplied: (see Response structure)

Response if no parameter is supplied:

Table for present in all firmware

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: To determine if a host is present, and the get the mode:

And with a host attached: 3.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) Response: (see Response structure)
A single line of text containing multiple name:value pairs separated by commas, that can be used to identify the product.

main)
hw| The part number of the hardware Part numbers)
hwid| A hexadecimal value used internally to identify the product (eg, 0x13)
fw| A pseudo number representing the firmware revision (eg, 1.68)
bl| A pseudo number representing the bootloader revision (eg, 0.15)
sn| A serial number. If not used will show all zeros (eg, 000000)
group| Used 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.
fc| Firmware Code is used to denote which firmware type the product accepts

Example

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) Live 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 /

Example

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)

port: is the port number, starting at 1
row: is the LED row number, starting at 1. Typically these are arranged as follows:

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

Example
To flash the charging LED on port 8 at 50/50 duty cycle, use: To turn on the port 1 charged LED continuously (i.e. no flashing): To turn off the port 1 sync LED:

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) row: 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:

Issue the command: Note 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)

Example *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 .
Universal Firmware Syntax: (see Command structure) seconds is the interval between responses in the range 1..32767

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

Example 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.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) [seconds] is the interval between responses in the range 1..32767
Response: (see Response structure)
CSV (comma separated values).
Example

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
Syntax: (see Command structure) [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:

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)

Response: (see ‘Response structure)

mode parameters for Universal Firmware

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
Sync| The 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
Biased| Port is detected but no charging or syncing will take place.| o
Off| Power 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

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.

devices)
3| Samsung
4| 2.1A (Apple and others with long detection time)
5| 1.0A (Typically used by Apple)
6| 2.4A (Typically used by Apple)

Examples
To turn off all ports: To put just port 2 in charge mode:

To put just port 4 in charge mode using profile 1:

3.17. Reboot (reboot the product)
Reboots the product.
Syntax: (see Command structure) If 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) The 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) To leave remote control mode, and allow the console to be controlled by the firmware, issue an exit command parameter.

mode.
kexit| Tells 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)

flags is one or more of the below parameters, when sending multiple flags a space is required between each parameter.

Example
To set the 5UV and OT flags:

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) [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

valid yet).
energy| Energy 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.

Flag| Description
O| Port is in OFF mode
S| Port is in SYNC mode
B| Port is in Biased mode
I| Port is in charge mode, and is IDLE
P| Port is in charge mode, and is PROFILING
---|---
C| Port is in charge mode, and is CHARGING
F| Port is in charge mode, and is has FINISHED charging
A| Device is ATTACHED to this port
D| No device is attached to this port. Port is DETACHED
T| Device has been stolen from port: THEFT
E| ERRORs are present. See health command
R| System has REBOOTED. See crf command
r| Vbus 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 flag| Description
A| Device is ATTACHED to this port
D| No device is attached to this port. Port is DETACHED
P| Port has established a PD contract with device
C| Cable has non-type-C connector at far end, no device detected
2nd flag|
I| Port is IDLE
S| Port is the host port and is connected
C| Port is CHARGING
F| Port has FINISHED charging
O| Port is in OFF mode
c| Power is enabled on port but no device is detected
3rd flag|
_| Quick charge mode is disallowed
+| Quick charge mode is allowed but not enabled
---|---
q| Quick charge mode is enabled but not in use
Q| Quick 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.

move
T| A 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 1 Another device attached to port 8. This is being profiled using profile_id 2 prior to charging: A global system error reported by the EE flag: 3.21. system (View system parameters)
To view system parameters, issue the system command.
Syntax: (see Command structure) Response: (see Response structure)
First row: system title text.
Subsequent rows: parameter:value pairs, one pair per row.

0..9
Compiled| Release time and date of the Firmware|
Group| Group letter read from PCB jumpers| 1 character, 16 values: “-”, “A” .. “O” “-”means no group jumper is fitted
Panel ID| Panel ID number of front panel product| “None” if no panel was detected Otherwise “0” .. “15”
LCD| Presence 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)

Response: (see Response structure) Notes

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 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) Response: (see Response structure)

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) p: 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: 3.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)

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

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) Response: (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.
Example 3.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)

0 = disabled
Profile parameter| Description
---|---
0| Intelligent charging algorithmwhich will select a profile 1-6
1| 2.1A (Apple and others with short detection time)
2| BC1.2 Standard (This covers the majority of Android phones and other devices)
3| Samsung
4| 2.1A (Apple and others with long detection time)
5| 1.0A (Typically used by Apple)
6| 2.4A (Typically used by Apple)

Response: (see Response structure)

Example
To disable a profile for all ports use the command: Operation 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)

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)

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

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) Response to no parameters: (see Response structure) Response to arm|disarm parameter: (see Response structure) Examples
To arm the system:

To disarm the system: To obtain the armed state:

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)

current speed
fast| Increase serial speed
slow| Reduce serial speed

Response: (see Response structure)

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: If 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 command Failure 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)

Response: (see Response structure)

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) Response: (see Response structure)

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

Response: (see Response structure)

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) 3.36. keyswitch
To show the current position of the keyswitch issue the keyswitch command.
Syntax: (see Command structure) Response: (see Response structure)

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)

p is the port number.
Response: (see Response structure) 3.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)

LEDs. in the format ‘aarrggbb’
level parameters| Description
---|---
aa| Sets the maximum level for the LEDs on this port, the other LEDs are all scaled from this setting
rr| Sets the level for the Red LED
gg| Sets the level for the Green LED
bb| Sets the level for the Blue LED

Response: (see Response structure

3.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)

motor above which it is determined that a gate has stalled.

Response: (see Response structure) ****

Errors

Failed commands will respond with an error code of the form below.

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

Example
Specifying a non-existent port to the mode command: 4.1. Fatal errors
When the system encounters a fatal error, the error is reported to the terminal immediately in the following format:

“nnn” is a three-digit error reference number.
“Explanation” describes the error.
When a fatal error has occurred the CLI will only respond to and . If either of these are received, then the systemwill enter boot mode. If or 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 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) In boot mode, non-bootloader commands will be responded to with: For 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.

devices)
3| Samsung
4| 2.1A (Apple and others with long detection time)
5| 1.0A (Typically used by Apple)
6| 2.4A (Typically used by Apple)

Port modes

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

channels open)
Biased| Detect the presence of a device but it will not sync or charge it.
Off| Turn 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.

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

● No fault with the product
● Host connected| Blue
Power| Fault with code| ● Major fault condition| Red Flashing (Fault code pattern)
Port| Device Disconnected / Port Disabled| ● Device disconnected or port disabled| Off
Port| Not Ready / Warning| ● Device resetting, starting, changing mode of operation or updating firmware| Yellow
Port| Charge Mode Profiling| ● Fault with connected device| Green Flashing (on/off in once second intervals)
Port| Charge Mode Charging| ● Port in charge mode
● Device connected and charging| Green Pulsing (dim/brightens in one second intervals)
Port| Charge Mode Charged| ● Port in charge mode
● Device connected, and charge threshold met or unknown| Green
Port| Sync Mode| ● Port in sync mode| Blue
Port| Fault| ● Fault with connected device| Red

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.

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

must directly precede settings_set and settingsreset.
It is not possible to change NV RAM settings without entering this command.
settings display| Displays 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_ reset| This command resets the memory back to the default settings. This command must be preceded by settingsunlock. The existing settings are displayed before being reset. Only if the command succeeds will there be a response.
company name | Sets the company name. The name cannot contain ‘%’ or ‘\’. Maximum length of the name is 16 characters. This command must be preceded by settingsset
default profile | Sets the default profile to be used by each port.