User Tools

Site Tools


Compact ICE API

The list of API Commands for the Compact ICE can be found below in the “Downloads” section. Links to related pages are also included, as well as instructions for sending commands over the Mini USB-B connector.

Implementation Instructions

Listed below is the command set for the Application Programming Interface (API).

Computer communication to the Compact ICE instrument occurs by first establishing a Serial COM port via the mini USB-B physical interface. The following table shows the serial port settings:

Baud Rate 115200
Data Bits 8
Parity None
Stop Bits 1
Flow Control None

To perform an operation, an ASCII-based text message is first constructed from a command and its arguments, and then the message is transmitted to the Compact ICE instrument through the COM port. The following rules apply:

  1. Syntax is insensitive to case.
  2. A message is an ASCII string composed of a command followed by zero or more arguments.
  3. A command and its arguments are delimited by spaces.
  4. Messages are terminated by a carriage return (“\r”).
  5. All valid messages return an ASCII string value*.
  6. [Int] refers to an integer argument that has no decimal point.
  7. [Float] refers to a floating point argument that has a decimal point in its value.

*To receive a reply from Compact ICE, #shadowusart true must be sent first

compact_ice/api.txt · Last modified: 2022/08/26 22:33 by