KBiosciences

SonoLite
Updated 30-March-2010 11:30 Tuesday

This is a windows application for controlling the Covaris acoustic transducer system. This software may be used to act as a slave to a host application using a DLL file. This program behaves as a simplified version of SonoLab with the addition of the slave functions.

Index - click on the links below

Install SonoLite for the first time
Update an existing SonoLite installation
Control SonoLite remotely

SonoLite screenshot

Install SonoLite for the first time

Download installation file

Please download and save the installation file and run it on the target PC. It will self-install after all the default options have been selected.

The DLL and example files are all included in the installation.

SonoLite can be run in simulation mode without the hardware connected to get your host software development going. It can also control the hardware from the SonoLite control panel. The software only needs activating when the DLL is used to control the hardware. Follow the on-screen instructions for software activation.

Download USB driver. (0.4 MB) This is required if the USB interface is used. If the serial port option is used then this is not required. This file is be included in SonoLite version 1.4 onwards.

Update SonoLite to 2.07.

Download update file

This is for updating existing installations. This self-extracting file should be run on the computer connected to the Covaris S2 module.

You can find out what version you are running from the text on the top right corner of the SonoLite window.

Whats in the new version? The full change log may be viewed by clicking here. Version 2.07 ------------- 30/03/2010 Run : Duration : Increased maximum time from 600 to 10000 seconds. Run : End : Play a sound when finished running if duration is greater than 30 seconds Version 2.05 ------------- 14/07/2009 Communication AFA module : Delay after command : This is now user definable. Version 2.04 ------------- 13/07/2009 Communication AFA module : Timeout : Serial port is reset and 100ms delay is added before retry. Version 2.03 ------------- 08/07/2009 Register software : The status is now displayed when system connects to instrument. Version 2.02 ------------- 07/07/2009 Register software : Key is stripped of spaces Version 2.01 ------------- 20/11/2008 Power sensing - Added tick box to advanced settings window that bypasses the no power error. For DNA shearing of long fragments we do need to go much lower in small tubes. Version 2.00 ------------- 26/06/2008 Run duration increased from 100 to 600 seconds. Version 1.99 ------------- 22/06/2008 Remote batch run - If batch does not exist then an error message is now displayed. Cycles / burst setting is minimum value is 50 (was 10) Batch mode now stores correct dose name in log file. Current dose name is saved when application is closed. This is dose will be opened when the application is re-started. Version 1.98 ------------- 09/04/2008 API - Run dose command now returns error if a non-existent dose is requested. API - Run batch command now returns error if a non-existent batch is requested. Log file - If log file path is missing, SonoLite will attempt to re-create full path at startup. API - Error reporting - Removed source text from error messages. If power drops to zero after 1 second during a run, the run will be stopped and a "zero power" error occurs. API - Added "get.status.run+" which behaves like "get.status.run" plus returns "3" if a run error (like zero power) has occurred. This is cleared when "error.clear" is issued or a new run is started. API - If "istatus" is sent, the system will return Unrecognized external command "#istatus" Version 1.97 ------------- 11/03/2008 Fixed problem introduced in version 1.96 with batch and starting. Notes are saved at the end of a batch, not after every dose. Degas pump auto start timer feature Notes may be added after a run if the tick box for this is ticked in the set-up tab. Version 1.96 ------------- 06/03/2008 Auto Degas off uses water sensor instead of guarding When remotely sending a dose and the dose does not exist, no error was generated the second time. Activation status is displayed in debug window Version 1.95 ------------- 04/03/2008 Degas pump is turned off when guard is open. This is checked every 3 seconds. When batch is "Saved as", the new batch name is loaded. Connecting to hardware message added. Version 1.94 ------------- 04/03/2008 Extra error report information available when an error occurs Log file folder not found now displays an error Barcode read before run for the log file Egg timer cursor used when initialising Display temperature all the time Degas is automatically turned back on when idling if the Covaris firmware bug turns it off. If the log file folder is blank, the temporary folder is used Version 1.93 ------------- 28/02/2008 Help web link is now updated to http://www.kbiosciences.co.uk/download/covaris_sonolite/ Version 1.92 ------------- 24/01/2008 High power is now displayed correctly above 255.

Control SonoLite remotely

SonoLite can be controlled using a dynamic link library (kbs_api.dll)which, is installed in the Windows system32 folder during installation of SonoLite. Any programming application such as VB, VBA (Excel, word), C, C++, LabView can control SonoLite. A command line program is also available which allows SonoLite to be controlled with batch files and basic scheduling software.

Download command line file (for version 1.1 and above) This file should be run on the same computer to start doses and setup dose properties from the command line and is not needed if you just want to control the system manually.

External Commands

As of version 1.3, batch commands and run=<dose name> have been added and a command line program is included kbs_commandline.exe with the installation file. This file may be used to run doses and batches from a DOS style command line with the same command syntax for the argument. For example "kbs_commandline.exe run=Default" will run the dose named "Default".

hide
show
run
run=<dose name>
run.batch
run.batch=<batch name>
stop
open=<dose name>
open.batch=<batch name>
save=<dose name>
get.status (Returns: degas,Interlock,Water level,Error)
get.status.run (Returns 1 if running, 0 if not running)
get.temperature
get.error
get.power
exit
error.clear
init
duration=<value>
degas=<1|0>
duty=<value>
intensity=<value>
burst=<value>
mode=<0|1>
ping

These commands make use of the kbs_api.dll dynamic link library. This must exist in the windows system32 folder. Example files should exist in the same folder as this program.

VB or VBA example
Private Declare Function kbs_command_vb Lib "kbs_api.dll" (ByVal s As String) As String
Sub test()
   kbs_command_vb "degas=1"
   kbs_command_vb "run"
   MsgBox kbs_command_vb("get.power")
End Sub

C example
#include <win.h>

typedef long (*BASIC_DEF)(void);
   BASIC_DEF Simple_Run;
   BASIC_DEF Ping;

typedef long (*LINK_DEF)(char *str, char *reply);
   LINK_DEF kbs_command;

int main()
   {
   char reply[80];
   HINSTANCE dllfile;

 dllfile = LoadLibrary("kbs_api.dll");
   if(!dllfile)
   {
   MessageBox(0,"Unable to Load Library: kbs_api.dll","Error",MB_OK);
   return 1;
   }

 Ping = GetProcAddress(dllfile,"kbs_ping");
   Simple_Run = GetProcAddress(dllfile,"kbs_run");
   kbs_command = GetProcAddress(dllfile,"kbs_command_c");

 Ping();			// Test the DLL connection which runs a dialog box
   kbs_command("ping",reply);		// Query the Covaris Application version number 
   MessageBox(0, reply,"Covaris application Version",MB_OK);;
   kbs_command("degas=1",reply);	// Turn degas pump on
   Simple_Run();					// Run the current dose
   }