BioMicroLab SampleScan Mini

Scanner Commands

• Select Scanner

  void selectScanner()Display a dialog to select the scanner.

• Get Scanner Manufacturer

  string getScannerManufacturer()Get the manufacturer name of the current scanning device.

  Returns:

  Manufacturer name.

• Get Scanner Family

  string getScannerFamily()Get the device-friendly name of the current scanning device.

  Returns:

  Family name.

• Get Scanner Name

  string getScannerName()Get the scanner name of the current scanning device.

  Returns:

  Scanner name.

• Edit Grid

  void editGrid(int rows, int columns)Display a rack template editor dialog.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.

• Read Frame X Offset

  int readFrameXOff(int rows, int columns)Gets the X-offset in 1/1000 inch of the scan area.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.

  Returns:

  X offset.

• Read Frame Y Offset

  int readFrameYOff(int rows, int columns)Gets the Y-offset in 1/1000 inch of the scan area.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.

  Returns:

  Y offset.

• Read Frame Width

  int readFrameWidth(int rows, int columns)Gets the width in 1/1000 inch of the scan area.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.

  Returns:

  Width.

• Read Frame Height

  int readFrameHeight(int rows, int columns)Gets the height in 1/1000 inch of the scan area.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.

  Returns:

  Height.

• Write Frame

  void writeFrame(int rows, int columns, int xOff, int yOff, int width, int height)Register a rack template.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.
  • xOffX offset in 1/1000 inch.
  • yOffY offset in 1/1000 inch.
  • widthWidth in 1/1000 inch.
  • heightHeight in 1/1000 inch.

• Acquire Image

  void acquireImage(int resolution, boolean progress, int xOff, int yOff, int width, int height, string bmpFile)Scan the rack image.

  Parameters:

  • resolutionSpecifies the scan resolution in DPI. (Max 600 for Fujitsu and 1200 for Epson)
  • progressTrue to show the progress dialog.
  • xOffX offset in 1/1000 inch.
  • yOffY offset in 1/1000 inch.
  • widthWidth in 1/1000 inch.
  • heightHeight in 1/1000 inch.
  • bmpFileFile to save the scanned image.

• Set Save Image Option

  void setSaveImageOption(int imageType, boolean flipOption)Set the save option.

  Parameters:

  • imageTypeCurrently ignored..
  • flipOptionTrue to flip the output bitmap.

• Reset Barcode

  void resetBarcode()Clear all previously decoded barcodes from memory.

• Set Decoder

  void setDecoder(int rows, int columns, int filterLevel, boolean detectMissing, int overlapPercent)Specify the rack’s spatial partitioning information and image-processing options for decoding.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.
  • filterLevelSpecifies the number of digital filters to be applied if the first decode attempt fails. Minimum: 0 Maximum: 10
  • detectMissingTrue to enable missing-tube-detection.
  • overlapPercentSpecifies the amount of overlap for each tube in the image.

• Set Decoder Ex

  void setDecoderEx(int rows, int columns, int filterLevel, string filterStr, boolean detectMissing, int overlapPercent, boolean powerMode)Specify the grid-structure (rows,columns) of a tube rack and image-processing options for decoding.

  Parameters:

  • rowsSpecifies the number of rows in the tube rack.
  • columnsSpecifies the number of columns in the tube rack.
  • filterLevelSpecifies the number of digital filters to be applied if the first decode attempt fails. Minimum: 0 Maximum: 10
  • filterStrReserved for future enhancement.
  • detectMissingTrue to enable missing-tube-detection.
  • overlapPercentSpecifies the amount of overlap for each tube in the image.
  • powerModeTrue to allow decoding in power mode.

• Start Decode

  void startDecode(boolean immediate)Start decoding the most recently scanned tube rack.

  Parameters:

  • immediateTrue to start the decoding process in a separate thread and return control immediately.

• Stop Decode

  void stopDecode()Send a stop request to cancel decoding.

• Get Decode Status

  boolean getDecodeStatus()Get the status of the decoding process.

  Returns:

  True if decoding is in progress, false if decoding has completed.

• Get Decode Success

  int getDecodeSuccess()Get the number of successfully decoded tubes so far.

  Returns:

  Number of successfully decoded tubes.

• Get Decode Noread

  int getDecodeNoread()Get the number of unreadable tubes so far.

  Returns:

  Number of unreadable tubes.

• Decode One

  void decodeOne(int row, int column)Decode an individual tube from the previously scanned rack.

  Parameters:

  • rowRow number for the tube to be decoded.
  • columnColumn number for the tube to be decoded.

• Get Barcode

  string getBarcode(int row, int column)Get the barcode.

  Parameters:

  • rowRow number of the tube of interest.
  • columnColumn number of the tube of interest.

  Returns:

  Barcode.

• Start MicroIO

  void startMicroIO(int port)Attempt to start the MicroIO interface.

  Parameters:

  • portSpecifies the port number.

• Stop MicroIO

  void stopMicroIO()Stop the active MicroIO interface.

• Get MicroIO Button Status

  int getMicroIOButtonStatus()Get which MicroIO button is currently being pressed.

  Returns:

  0 – none; 1 – left button; 2 – right button; 3 – both buttons.

• Is MS2 Enabled

  boolean isMS2Enabled()Check if the MS2 linear barcode reader is enabled.

  Returns:

  0 – none; 1 – left button; 2 – right button; 3 – both buttons.

• Start MS2

  void startMS2(int port)Attempt to start the linear barcode reader.

  Parameters:

  • portSpecifies the port number.

• Stop MS2

  void stopMS2()Stop the active linear barcode scanner.

• Set MS2 Timeout

  void setMS2Timeout(int timeout)Set the linear barcode reader timeout.

  Parameters:

  • timeoutSpecifies the timeout in seconds.

• MS2 Decode

  string ms2Decode()Trigger MS2 linear barcode reader to decode a linear barcode on the tube rack.

  Returns:

  Barcode.

• MS2 Decode Trigger

  void ms2DecodeTrigger()Start the MS2 barcode reader to start scanning for barcode.

• MS2 Decode Cancel

  void ms2DecodeCancel()Request to stop the current decoding process.

• MS2 Decode Status

  int ms2DecodeStatus()Get the status of the current decoding process of the MS2 barcode reader.

  Returns:

  -1 – reader not enabled; 0 – decoded OK; 1 – decoding in progress; 2 – no read; 3 – decoder error; 4 – thread creation error.

• MS2 Decode Result

  string ms2DecodeResult()Get the successfully read linear barcode.

  Returns:

  Barcode.