Command Line Reference
Implemented commands only.
bd
Provides a breakdown of the architecture of the device, showing all hubs and ports.
Syntax
Response
Key value pairs, one per line.
Parameter | Description |
|---|---|
Ports | Number of USB ports |
Sync | 1=has sync capability |
Temp | 1=has temperature measuring capability |
EXTPSU | 1=uses an external PSU |
The attachments section can have the following:
Parameter | Value | Description |
|---|---|---|
Nodes | n | Number of USB hub nodes |
Node i Type | type | i indicates node number type indicates the node type |
Node i Ports | n | Number of ports on the node |
Displays | n | Number of LED display modules |
Display i LEDs | n | Number of LEDs on the display module |
For Hub i Port p:
Value | Description |
|---|---|
Hub j | Hub i has a downstream hub j connected to port p |
Control port | Hub i has a USB serial port attached to port p |
Expansion port | Hub i has an expansion port attached to port p |
Nodes types
Type | Description |
|---|---|
HUB | USB 2.0 hub |
Example response
bist_check
Run the internal built-in self check.
Syntax
Response
Self check information
boot_mode
Switch the device into boot mode. This allows the firmware on the device to be updated.
Syntax
Dverify
Check that the device is communicating correctly, by returning an ACK response
Syntax
Response
echo
Repeat the provided text back.
Syntax
Example
echo Hello, world response:
en_profile
Enable or disable a charging profile, applied to all ports.
Syntax
Parameter | Description | Value |
|---|---|---|
i | Profile number | |
e | Enable flag | 1=enabled 0=disabled |
Example
Disable charging profile 2 on all ports:
No profiles enabled
If all profiles are disabled, the product operates in biased mode. Device detection will work, but no charging will take place.
Response
No response
get_device_name
Return the Datamation product number
Syntax
Example response
get_profiles
This command shows the charging profile assigned to a port.
Syntax
Parameter | Description |
|---|---|
p | Port number, starting at 1 |
Response
Each port profile is listed on its own line, showing enabled or disabled
Example response
health
Show status information for the device.
Syntax
Response
A list of key:value pairs, one per line.
Key | Description | Value | Value Description |
|---|---|---|---|
| Current supply voltage | ||
| Lowest supply voltage seen | ||
| Highest supply voltage seen | ||
| Supply voltage error flags | No errors | |
5OV | Supply has gone over maximum acceptable voltage | ||
5UV | Supply has gone under minimum acceptable voltage | ||
| Current device temperature | ||
| Highest PCB temperature seen | ||
| Temperature error flags | No errors | |
OT | Device has exceeded maximum working temperature |
Example response
host
The device monitors if a host computer is attached to the sync socket. In auto mode, the device automatically changes into sync mode.
Running the host command without any parameters will display whether a host computer is attached.
Syntax
Example response
Mode parameter
Mode | Description |
|---|---|
auto | All populated ports change automatically into sync mode when a host is connected |
manual | Only commands are used to change port modes, the presence of a host has no effect on this. |
id
Get information on the hardware and firmware of the device.
Syntax
Response
One line of text containing a comma separated list of key:value pairs.
Name | Value |
|---|---|
mfr | Manufacturer name |
mode | Firmware operating mode |
hw | |
hwid | Hex value identifying the product |
fw | Firmware version number |
sn | Device serial number |
Example response
led
The led command assigns an RGB colour and flash bit pattern to an individual port LED.
Syntax
ledb
The ledb command assigns a flash bit pattern to an individual port LED.
Syntax
Parameter | Description |
|---|---|
port | Port number, starting at 1 |
row | LED row number, as below |
ptn | LED pattern code. Binary numbers should end with b, hexadecimal numbers with h. |
control | H: takes control of the LED without a remote command R: releases the LED back to normal operation. |
Rows types
Row | LED function | |
|---|---|---|
1 | Charged | Green |
2 | Charging | Red |
3 | Sync mode | Blue (only when host connected) |
Examples
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:
Response
None
leds
The leds command assigns flash pattern to one row of LEDs. This allows, for example, the charging LED on all ports to be set at once.
Syntax
See the row types in the ledb command for row numbers. The pattern string contains flash pattern characters, one per port.
Example
To set the row 1 LEDs:
Response
No response
list_profiles
Returns the list of globally enabled charging profiles.
Syntax
Response
A list of profiles, one per row, showing whether they are enabled.
Example response
logc
Display the current usage for all ports at a set time interval. Logging can be stopped by sending q or \<ETX\>
Syntax
seconds is the number of seconds between responses, from 1-32767
Response
A comma separated list of current consumption for each port, rounded to the nearest mA
Example response
logp
Display the power usage for all ports at a set time interval. Logging can be stopped by sending q or \<ETX\>
Syntax
seconds is the number of seconds between responses, from 1-32767
Response
A comma separated list of power consumption for each port, in Watts
Example response
mode
Set the mode of a port.
Syntax
Parameter | Description |
|---|---|
m | "Mode" character |
p | Port number |
cp | Charging profile |
See here for a list of port modes and here for a list of charging profiles.
Response
Empty response.
q
Stop output from log commands.
qa
Display the current port connection status as a continuous log. Used for QA purposes.
Response
One character per port.
Character | Description |
|---|---|
. | No device attached |
A | Attached |
C | Charging |
X | Finished charging |
read_device_id
Show the unique identifier for the microprocessor
Syntax
Response
Hexadecimal device ID
read_revision_id
Show the revision identifier for the microprocessor
Syntax
Response
Hexadecimal revision ID
read_serial_number
Show the Datamation device serial number
Syntax
Response
Serial number
read_system_voltage
Show the current system voltage.
Syntax
Response
Current system voltage
Example response
reboot
Reboot the product.
Syntax
remote
The LEDs on the device normally operate automatically. Remote mode allows the automatic working to be disabled and the LEDs to be set directly using commands.
Syntax
When remote mode is entered, all LEDs are turned off.
Parameter | Description |
|---|---|
empty | Enter remote mode |
exit/kexit | Leave remote mode and restore normal LED operation |
Response
No response
reset
Same as settings_reset
set_profiles
Info
Syntax
Parameter | Description |
|---|---|
p | Port number, starting at 1 |
cp |
To assign all system profiles to a port, issue set_profiles without a list of profiles.
Examples
To set profiles 2 and 3 for port 5:
To assign all profiles to port 8:
Response
No response
settings_display
Shows the current product settings.
Syntax
Response
Each setting parameter is displayed as a settings_set command.
settings_reset
Reset all settings back to factory defaults.
Syntax
Response
settings_set
Set an internal settings value.
Syntax
Response
No response
settings_unlock
Unlock the settings for writing. Must be used before settings_set and settings_reset.
Syntax
Response
show_remote_device_info
Show information on the LED board (remote device)
Syntax
state
Show the state of each port.
Response
One row per port, in this format:
system
Display system information (hardware code, firmware version etc.)