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 Cambrionix connect, 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/cambrionix-cli

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.

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.

Communication Settings

The default communications settings are as below.

ANSI terminal emulation should be selected. Command sent must be terminated with

<CR><LF>

Lines received by the hub are terminated with

<CR><LF>

The hub will accept back-to-back commands, however, the host computer should wait for a response before issuing a new command.

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 below

>>

Except in boot mode where it is as below

boot>>

To reach a new boot prompt, send <ETX>. This cancels any partial command string.

Products and their Firmware

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