Available commands of the Application Server


Generic commands


  • acq start - start acquisition
  • acq stop - stop acquisition
  • acq state - return acquisition state
    • example response: "ok;acq state;1"
      • 1 = acquisition initialized but not running
      • 2 = acquisition running
  • acq info enable - enable object detection reporting on separate object stream
  • acq info disable - disable object detection reporting on separate object stream
  • acq info totalsize - return the total size of objects detected in the session
    • the total object size counter is reset when starting acquisition


  • acq darkref record - record dark reference
    • Only full frame references are supported (non-uniformity)
    • reference recording does not automatically close the shutter. Use camera-specific shutter command before to close the shutter and reopen after the reference recording.
  • acq whiteref record - record white reference
    • Only full frame references are supported (non-uniformity)


  • view clear - clear the display
  • view save FILENAME - save current display into PNG file named FILENAME in current directory (top-level data directory)
  • view acq MODE - set specific view mode
    • raw - view the raw data stream
    • corrected - view the reflectance corrected data stream (references need to be acquired)
    • decisions - show the decision layer (model needs to be defined)
    • objects - show object detections. The model and object segmentation needs to be defined in a model
    • waterfall - set the view type as waterfall (overwriting the data in a cyclical fashion)
    • belt - set the view type as a belt view (the stream moves like if watching belt from the top)
  • decisions - return the comma-separated list of model decisions
    • Example output when running a four class classifier: "ok;decisions;background,leaves,shells,nuts\n"
Control of perCass Mira Stage
  • stage connect - connect to the stage
  • stage disconnect - disconnect from the stage
  • stage stop  - stop any stage movement
  • stage left | right | center - move the stage right, left or center
  • stage position POS - moves the stage to the position POS (in mm). If POS is omitted, the current position is returned
  • stage speed SP - sets a specific speed SP (in mm/sec). If SP is omitted, the current speed is returned
  • stage scan - working with the scanning area 
    • stage scan - returns start and end position of the scanning area
    • stage scan START END - sets the start and end position of the scan area
    • stage scan start - moves the stage to the current START position
    • stage scan end - moves the stage to the current END position
  • stage cycle - starts cycling between START and END scan area
  • stage white - working with the area of the white reference
    • stage white - returns start and end position of the white reference
    • stage white START END - sets the start and end position of the white reference
    • stage white start - moves the stage to the current white reference START position
    • stage white end - moves the stage to the current white reference END position
Camera specific commands - Headwall MV.X
  • mvx Shutter.Close - close MV.X shutter
  • mvx Shutter.Open - open MV.X shutter
Camera specific commands - Specim Specsensor SDK

This specific interface mirrors command functionality of SpecSensor SDK. Please refer to SpecSensor documentation on the SDK commands for more details.


Basic commands to open and close the shutter:

  • specsensor Shutter.Open - open the shutter
  • specsensor Shutter.Close - close the shutter


Extended commands

  • specsensor Shutter.IsOpen - return if the shutter is open
  • specsensor Shutter.IsConnected - return if the shutter is connected.
  • specsensor Shutter.IsToggle - return if the shutter is toggled (flipped)
  • specsensor Shutter.IsToggle X - pass value to SpecSensor IsToggle
    • the value can be "enable", "on" or "true"  or "disable", "off" or "false"
    • Example: "specsensor Shutter.IsToggle enable"