Script Modu Module v1.5 ule v1 - Fluigent€¦ · Module v1.5 User manual Page - 1 : FR 53 487 636...

Siège social : Bio

SA à Directoire et Conseil de Surveillance au capital de

Script Modu

Version March 2016

FLUIGENT

Biopark – 1 mail du Professeur Georges Mathé – 94800 Villejuif – France

Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com

apital de 141 284.95 € - Siret : 487 636 409 00038 – N°TVA UE/EU VAT Number : FR

Module v1.5

User manual

Page - 1

: FR 53 487 636 409

ule v1.5

Page - 2

FLUIGENT

Siège social : Biopark – 1 mail du Professeur Georges Mathé – 94800 Villejuif – France

Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com

SA à Directoire et Conseil de Surveillance au capital de 141 284.95 € - Siret : 487 636 409 00038 – N°TVA UE/EU VAT Number : FR 53 487 636 409

Table of contents

1 Software general information ............................................................................................ 3

1.1 System Requirements .................................................................................................. 3

1.2 Installation Instructions ............................................................................................... 3

1.3 Compatibility ............................................................................................................... 3

2 How to start ........................................................................................................................ 4

2.1 Start the Script Module ............................................................................................... 4

2.2 Script panel description ............................................................................................... 4

2.3 Main Shortcuts ............................................................................................................ 5

3 Script Module Software ..................................................................................................... 7

3.1 General functions ........................................................................................................ 7

3.2 Pressure & Flow-rate functions ................................................................................... 8

3.2.1 Functions available with MFCS™ .......................................................................... 8

3.2.2 Functions available with Flow-Rate Platform ...................................................... 9

3.2.3 Functions available with FRCM ............................................................................ 9

3.3 Functions available with ESS™ ................................................................................... 10

4 General rules .................................................................................................................... 14

4.1 Debugger ................................................................................................................... 14

4.2 Syntax ........................................................................................................................ 14

4.3 Writing and running a script ...................................................................................... 15

4.4 Remarks ..................................................................................................................... 19

4.5 Script support ............................................................................................................ 19

5 Script example .................................................................................................................. 21

5.1 Script .......................................................................................................................... 21

5.2 Product requirements for the script example ........................................................... 23

Page - 3

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


1 Software general information

1.1 System Requirements

This installation requires one of the following MicrosoftTM 32/64 bit operating systems:

• Windows XP Service Pack 3

• Windows Vista

• Windows 7

• Windows 8

• Windows 10

The Script requires:

• A minimum of 512 Mo of RAM (2 Go recommended)

• Minimum process or Intel Pentium 1.6 GHz

• Minimum screen size 800 x 600

1.2 Installation Instructions

Before installing the Script Module, log in as Administrator or as a user with Administrator privileges. The Script Module setup program must have Administrator privileges because the program modifies the configuration registry of your system. Complete the following steps to install the Script Module.

1. If you install the Script Module for the first time go to step 2. Go in “add and remove program” in “windows panel configuration” and uninstall all previous versions of the Script.

2. Plug your MaesfloTM or ESSTM USB key. Navigate into the USB key using WindowsTM Explorer and launch the Fluigent_ScriptModule_Installer.exe from the Script Module file.

3. The installation wizard guides you through the necessary steps to install Script Module. You can go back and change values where appropriate by clicking the Back button. You can exit the setup where appropriate by clicking Cancel.

4. When the installation is complete, click Finish.

1.3 Compatibility

The Script Module v1.5 is compatible with all MaesfloTM versions from 3.1.0 and higher, and ESSTM Control versions from 1.2 and higher. If two versions are installed on your computer, the Script Module will be functioning with the last installed version of Maesflo™.

Page - 4

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


2 How to start

2.1 Start the Script Module

Double click on the Script Example shortcut on your desktop to launch the script module software. All

double clicks on an extension file type “.au3” must open the software SciTE.exe.

If WindowsTM doesn’t recognize the extension “.au3” right click on the script example and click on “open with…”, then select “SciTE-lite…” and check the box to always open a “.au3” extension with this software.

The script main panel appears.

Page - 5

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


2.2 Script panel description

The blue zone corresponds to the tool bar of the script window. The tool bar useful functions will be directly used with shortcuts such as F5 for running the script.

The black zone corresponds to the line number of the script.

The red zone corresponds to the workspace. You must write the script in this area and respect the syntax of the commands you are using. (§3)

2.3 Main Shortcuts

When a script is running, you can perform 3 different actions:

Page - 6

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


Run the script: when you press “F5” the script is saved, the debugger starts, then if there is no mistake the script runs, else a syntax report is returned.

Pause: when clicking shift-space, the script is paused. The script is taken back while clicking again on

shift-space.

Exit: when clicking on shift-escape, the script is stopped.

Page - 7

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


3 Script Module Software

The Script Module is associated to the MaesfloTM and the ESSTM software. It allows you to program and run various events and protocols. Several functions are available for the script edition and syntax is explained below. The list of available functions is given in the following list:

3.1 General functions

Function Short description

#include <Group.au3> • This line must be written at the beginning of the script (mandatory).

Init() • Start the script (mandatory).

Wait(X) • The script waits for X seconds at this line (mandatory).

• X cannot be below 0.1 second.

• X does not need to be an integer.

for $i=0 to X

…

next

• This structure allows you to program a loop to repeat the sequence between “for” and “next”.

• Repeat from 0 to X the sequence you've written between [for and next] and increment the loop value $i by 1.

• Also you can set the increment: Ex: For $i = 1 to 5 step 2

• X is the number of iterations of the loop if the step is equal to 1 (must be an integer).

End() • This line must be written at the end of the script (mandatory).

Note: All scripts MUST be constructed like this:

#include <Group.au3> Init()

Your script End()

Page - 8

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


3.2 Pressure & Flow-rate functions

The Script Module is compatible with the Maesflo™, so that you can write sequences of pressure and flow-rate commands of your MFCS™, Flow-Rate Platform, FRCM, and synchronize them.

3.2.1 Functions available with MFCS™


Pressure (a, b, c, d) • Set pressure (mbar) to the 4 pressure channels. MFCS 4C: Ch1=a, Ch2=b, Ch3=c, Ch4=d.

• Missing value(s) = 0 mbar.

• The following examples: Pressure (0, ,20,20) such as Pressure(,10,20,20) are not allowed. The space is not considered as a

missing value.

• Example: If you are using a 8 channel MFCS and if you enter the action: Pressure(10,10,10,10), the first 4 channels will be set at 10

mbars and the last 4 channels at 0 mbars.

P(X,Y) • Set the pressure value Y (mbar) to the pressure channel number X.

IncrP(X,Y) • Add Y mbar to the pressure channel number X.

IncrxP(a, b, c, d) • Add a mbar to the pressure channel number 1, b mbar to the pressure channel number 2…

• Missing value(s) = add 0.

DecrP(X,Y) • Subtract Y mbar to the pressure channel number X.

DecrxP(a, b, c, d) • Subtract a mbar to the pressure channel number 1, b mbar to the pressure channel number 2…


Pressure () • Set all pressures to 0.

Note: The script only works with pressure in mbar, the Maesflo™ automatically change the mbar pressure in PSI if you are using Maesflo™ in PSI.

Page - 9

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


3.2.2 Functions available with Flow-Rate Platform


V(X, Y) Wait until the volume Y (µl) passing through the FLOW UNIT X is reached (µl).

Volume(a,b,c) Wait until the first volume a,b or c (µl) is reached (volumes passing through FLOW UNIT 1, 2 and 3 respectively).

3.2.3 Functions available with FRCM


Load("file name") • Load the identification file (necessary to control flows by flow-rate).

• Ex: Load("MF(_320)_FRCM_myfile")

Flowrate(a,b,c) • Set the flow-rate values (µL/min) to the 3 flow-rate channels: FLOW UNIT number 1 = a, FLOW UNIT number 2 = b…

• Missing value(s) = 0 µl/min.

Q(X,Y) • Set the flow-rate value Y (µl/min) to the FLOW UNIT number X.

IncrQ(X,Y) • Add the value Y (µl/min) to the FLOW UNIT X.

IncrxQ(a, b) • Add a µl/min to the FLOW UNIT 1 and b µl/min to the FLOW UNIT 2.


DecrQ(X,Y) • Subtract the value Y (µl/min) to the FLOW UNIT X.

DecrxQ(a, b) • Subtract a µl/min to the FLOW UNIT 1 and b µl/min to FLOW UNIT 2.

• Missing value(s) = subtract 0.

Page - 10

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


The Script Module software is compatible with the ESS™ Control, so that you can write sequences of position on your connected ROT-SWITCH™ (L or M model) and 2-SWITCH™, and synchronize them.

3.3 Functions available with ESS™


TwoSw(X, Y) • TwoSw (port number, position number)

• Applies the position Y to the 2-SWITCH™ connected on port X on the SWITCHBOARD (Blue cable SWITCHBOARDsection)

• X = 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 –If any other value is given the debugger will generate a syntax error.

• Y = 1 or 2 – If any other value is given the debugger will generate a syntax error.

MSw(‘’X’’, Y) • MSw (‘’port letter’’, position number)

• Applies the position Y to the M-SWITCH™ connected on port X ( white cable SWITCHBOARD section) on the SWITCHBOARD.

• “X” = “A” or “B” or “C” or “D” – If any other value is given the debugger will generate a syntax error.

• Y = 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 or 9 or 10 – If any other value is given the debugger will generate a syntax error.

Warning: port letter must be written between quotation marks to be understood. Else, it will generate a SciTE error.

LSw(‘’X’’, Y) • LSw (‘’port letter’’, position number)

• Applies the position Y to the L-SWITCH™ connected on port X (white cable SWITCHBOARD section)on the SWITCHBOARD.

• “X” = “A” or “B” or “C” or “D” – If any other value is given the debugger will generate a syntax error.

• Y = 1 or 2 – If any other value is given the debugger will generate a syntax error.

Warning: port letter must be written between quotation marks to be understood. Else, it will generate a SciTE error.

TwoSwX(a,b,c,d,e,f,g,h) • Applies positions a,b,c,d,e,f,g,h to the 2-SWITCH™ connected to your SWITCHBOARD, in order of the 2-SWITCH™ RJ45 ports

numbering on the SWITCHBOARD.

• a, b,c, d, e, f, g, h = 1 or 2 (each) -If any other value is given the debugger will generate a syntax error.

• You can write from one to eight arguments in this function (number of 2-SWITCH™ RJ45 ports on the SWITCHBOARD).

• You can write fewer arguments than your number of connected 2-SWITCH™, but you should not write more arguments than your

number of connected 2-SWITCH™.

• Examples: three (3) 2-SWITCH™ are connected to the SWITCHBOARD to RJ45 ports #3, #4 and #6

Page - 11

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


o TwoSwX(1,2,2) will apply Position 1 to the 2-SWITCH™ connected on port #3, because it is the first connected port in the

order of the SWITCHBOARD 2-SWITCH™ RJ45 ports. Position 2 for the 2-SWITCH™ connected on port #4 will also be

applied, and Position 2 for the 2-SWITCH™ connected on port #6.

o TwoSwX(1,2) will apply Position 1 to the 2-SWITCH™ on port #3 and Position 2 for the 2-SWITCH™ on port #4. The 2-

SWITCH™ on port #6 is not concerned, since there are fewer arguments in the function than the number of connected 2-

SWITCH™, and it is the last connected 2- SWITCH™ in order of the SWITCHBOARD RJ45 ports.

o TwoSwX(1) only applies Position 1 to the 2-SWITCH™ on port #3. The 2-SWITCH™ on ports #4 and #6 are not concerned,

since there are fewer arguments in the function than the number of connected 2-SWITCH™.

o TwoSwX(1,2,2,1,1) : as there are more arguments in the function than the number of connected 2-SWITCH™ the debugger

will generate a syntax error..

MSwX(i,j,k,l) • This function is equivalent to TwoSwX but for the connected M-SWITCH™. It applies positions i, j, k, l to the M-SWITCH™ connected

to your SWITCHBOARD (White cable SWITCHBOARD section), in order of the M-SWITCH™ RJ45 ports numbering on the

SWITCHBOARD.

• i, j, k, l = 1 or 2 or 3 or 4 or 5 or 6 or 7 or 8 or 9 or 10 (each) - If any other value is given the debugger will generate a syntax error.

• You can write from one to four arguments in this function (number of M-SWITCH™ RJ45 ports on the SWITCHBOARD).

• You can write fewer arguments than your number of connected M-SWITCH™, but you should not write more arguments than your

number of connected M-SWITCH™.

• Examples: two (2) M-SWITCH™ are connected to the SWITCHBOARD, to ports B and C.

o MSwX (7,3) will apply Position 7 to the M-SWITCH™ connected to port B, because it is the first connected port in the order

of the SWITCHBOARD M-SWITCH™ RJ45 ports. Position 3 is applied to the M-SWITCH™ on port C.

o MSwX(7) only applies Position 7 to the M-SWITCH™ on port B. The M-SWITCH™ on port C is not concerned, since there are

fewer arguments in the function than the number of connected M-SWITCH™, and it is the second connected M-SWITCH™ in

order of the SWITCHBOARD RJ45 ports.

o MSwX(7,3,5,6) : as there are more arguments in the function than the number of connected M-SWITCH™, the debugger will

generate a syntax error.

LSwX(i,j,k,l) • This function is equivalent to TwoSwX but for the connected L-SWITCH™. It applies positions i, j, k, l to the L-SWITCH™ connected to

your SWITCHBOARD (White cable SWITCHBOARD section), in order of the L-SWITCH™ RJ45 ports numbering on the

SWITCHBOARD.

• i, j, k, l = 1 or 2 (each) - If any other value is given the debugger will generate a syntax error.

• You can write from one to four arguments in this function (number of L-SWITCH™ RJ45 ports on the SWITCHBOARD).

Page - 12

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


• You can write fewer arguments than your number of connected L-SWITCH™, but you should not write more arguments than your

number of connected L-SWITCH™.

• Examples: two (2) L-SWITCH™ are connected to the SWITCHBOARD, to ports B and C.

o LSwX (1,2) will apply Position 1 to the L-SWITCH™ connected to port B, because it is the first connected port in the order of

the SWITCHBOARD L-SWITCH™ RJ45 ports. Position 2 is applied to the L-SWITCH™ on port C.

o LSwX (2) only applies Position 2 to the L-SWITCH™ on port B. The L-SWITCH™ on port C is not concerned, since there are

fewer arguments in the function than the number of connected L-SWITCH™, and it is the second connected L-SWITCH™ in

order of the SWITCHBOARD RJ45 ports.

o LSwX(1,1,1,2) : as there are more arguments in the function than the number of connected L-SWITCH™, the debugger will

generate a syntax error.

ESS(sw(1),

ROTSwX(i,j,k,l),

TwoSwX(a,b,c,d,e,f,g,h))

• This function enables you to send synchronized orders to all connected ROT-SWITCH™ (M-SWITCHTM and/or L-SWITCHTM) and

2-SWITCH™.

• There always has to be 3 arguments in the ESS function:

o The first argument of the ESS function must always be “sw(1)”. If any other value is given or any argument is omitted the

debugger will generate a syntax error.

o The second argument must always be a ROTSwX argument. The syntax of the ROTSwX argument is the same as the MSwX

or LSwX function detailed above (depending on connected switch) – The same kind of errors as for the MSwX/LSwX

functions will be generated by the debugger if the syntax is not respected. Depending on SWITCH type and connection order

on the board; ROTSwX is equal to MSwX or to LSwX.

o The third argument must always be a TwoSwX argument. The syntax of the TwoSwX argument is the same as the TwoSwX

function detailed above – The same kind of errors as for the TwoSwX function will be generated by the debugger if the

syntax is not respected in the TwoSwX argument.

• Examples: one (1) L-SWITCH™ , one (1) M-SWITCH™ are connected to the SWITCHBOARD, to ports B and C and three (3) 2-

SWITCH™ are connected to the SWITCHBOARD to RJ45 ports #3, #4 and #6

o ESS(sw(1), ROTSwX(1,3), TwoSwX(1,2,2)) will apply Position 1 on the L-SWITCH™ of port B / Position 3 on the M-

SWITCH™ of port C / Position 1 on the 2-SWITCH™ of port #3 / Position 2 on the 2-SWITCH™ of port #4 / Position 2 on the

2-SWITCH™ of port #6.

o ESS(sw(1), ROTSwX(2), TwoSwx(1,2)) will apply Position 2on the L-SWITCH™ of port B / Position 1 on the 2-SWITCH™ of

port #3 / Position 2 on the 2-SWITCH™ of port #4 . The M-SWITCH™ on port C and the 2-SWITCH™ on port #6 are not

concerned.

o ESS(sw(1), TwoSwX(1,2,2)) : the argument ROTSwX() is missing so the debugger will generate a syntax error. If you want

Page - 13

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


to actuate 2-SWITCH™ devices only, please use the TwoSwX function alone.

o ESS(sw(1), MSwX(1,2,2)) the argument TwoSwX() is missing so the debugger will generate a syntax error. If you want to

actuate ROT-SWITCH™ devices only, please use the MSwX or LSwX functions alone.

Note: TwoSwX command takes 200ms to run and ROTSwX command takes 1500ms to run.

Page - 14

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


4 General rules

4.1 Debugger

The debugger provides first a syntax error. Example: pressure compare to pressure () will return an immediate error in the console box.

The debugger ensures the quality of the script you are about to use. It prevents from mistakes that could stop a running script. The debugger doesn’t allow users to start script with mistakes, and displays the error(s) in a report file, how to solve it and the line where it occurs. The debugger starts directly after the user press F5.

If you restart the script without any change of a script with previous mistakes, a message remembers you that you didn’t correct mistakes in the script and you will not be able to perform a script.

You can find the script syntax report file at “C:\Fluigent\SciTe\Syntax report.au3”.

4.2 Syntax

Be careful to respect the syntax described in the tables presented previously. If some mistakes remain, the debugger will give you indications regarding the script line number, where the mistake and the nature of the mistake have been identified.

Check that all opened brackets are closed in the same script line. The automated syntax highlighting will help you to identify the complementary brackets.

An entry help assists you to select the function that you want to use, and reminds you of the syntax and the purpose of the function.

Page - 15

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


Check that there are not more brackets than what is shown in the function description table. The automated syntax highlighting will help you to identify the complementary brackets.

?

The space character is not taken into account in the function syntax. The letter case is not taken into account in the function syntax. For example, you can write equally “mswx” or “MSWX” or “MSwX”. The tabulation character is forbidden.

You can write comments in your script by using the “;” character. Everything written after the “;” character and on the same line is considered as a comment (green italic format).

Do not write several functions on the same line. The debugger will generate an error.

4.3 Writing and running a script

When you start running a Script (F5), an initialization process will start and recognize functions you are using in your script. If you are using pressure functions, you must have the Maesflo™ software running, same for ESS™ control, and if your script uses both commands related to Maesflo™ and ESS™ control, you must have both software running before using the script.

Page - 16

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


If software needed is not running you will have an error message asking you to run the corresponding software before running the script.

Write your script, with the correct beginning and ending lines (note §4), and the correct syntax for the functions. An asterisk “*” at the end of the script name indicates that the script has not been saved yet, remember that pressing F5 will save the actual script and run it.

Press F5 to launch your script.

The first step of the debugger will run. It displays the potential errors in the information frame at the bottom of the window. If errors are reported at this step, they must be corrected before pressing F5 again.

Page - 17

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


If no errors are reported by the first step of the debugger, the second step will check the script functions.

A message appears if errors are found, and the Syntax report is displayed explaining the errors.

Once all errors are corrected, press F5. The debugger will run, and if no more remaining errors are detected, a message will ask the user if he wants to start the script.

Page - 18

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


If you select “Yes” the script will be performed. If you select “No” you just debugged the script and it didn’t start. If you press “F5” again without changing the script you have debugged, the script runs immediately without asking a question.

The information frame at the bottom of the Script Editor window shows in live the executed functions, the time needed to execute a function, and the time passed since the beginning of the run (Dt).

The ESS™ Control & Maesflo™ Main Panels become gray and cannot be actuated. ESS™ status line indicates that a script is playing.

When the script is finished: “Exit” is indicated in the information frame of the Script Editor in blue, with the total time of the script execution.

All software Main Panels related to the script become accessible again.

Page - 19

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


4.4 Remarks

Please note that only the connected devices associated with the SWITCHBOARD RJ45 port to which they are connected are taken into account for the script debugger and during the run. The device configuration should remain the same from the debugger launch to the end of the script run. Fluigent advises you not to disconnect or change the SWITCHBOARD RJ45 port of any device after the debugger has been launched, since the exactness of the script commands cannot be guaranteed if this is not respected.

Warning: during script execution, the M-SWITCH™ direction of rotation is forced at “The shortest”.

You must use the script only after the preheating procedure of the MFCS™ ended when launching the Maesflo™.

If you didn’t install the Script Module at “c:\Program files\autoit3\” the first time you load an “.au3” extension file you will have to allocate a default program for it. Right click on the “.au3” file you want to use, and select SciTE as a default running program for this extension. The default icon may as well not be associated. For these reasons we recommend our customers to install the software in the recommended path.

This version of the Script Module doesn’t provide disconnection of connected products. If the ESS™ or the MFCS™ have a connection problem when a script is running you would have to stop the script or hard kill it, close and restart all the software you were communicating with during the script.

You can do copy/paste from older script and to repeat sequences directly inside the working area of the script module.

Hard-kill: if the script doesn’t answer click Stop Executing inside the toolbar tab “Tools”, this will hard kill the running process. This must be used with caution and only if Exit shortcuts doesn’t work. You must restart all your software (Script Module, MaesfloTM and ESSTM Control), in order to reinitialize all parameters before running a new script.

When a script is running and if you press “Zero pressure” on the MaesfloTM main Panel, all pressures will be set to zero but the script will not stop.

As we need AutoIt to be installed for syntax error check, you cannot compile your script .au3 into a standalone executable.

4.5 Script support

Admin issue

Issue: You need to launch all the files .exe as Admin. If you do not, the communication between MaesfloTM and the script will not be possible.

Solution:

1. Be sure to install MaesfloTM and AutoIt3 with admin rights.

Page - 20

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


2. Define the privilege level for AutoIt3.exe and SciTE.exe. : Go to dans C:\Program Files (x86)\AutoIt3 et C:\Program Files (x86)\AutoIt3\SciTe then, right click ‘Properties’ > Compatibility> Tick ‘Run as Admin’

3. Launch AutoIt3.exe, AutoIt3_x64.exe, SciTE.exe and MaesfloTM with ‘Run as Administrator’.

Read/Write rights

You need to have the Read and Write rights for the file ‘C:\Program Files (x86)\AutoIt3’. If not, go to ‘C:\Program Files (x86)\AutoIt3’, right click and go to ‘Properties’ then untick ‘Read only’.

Syntax report issue Issue: Error observed during the compilation step. Solution:

1. Go to ‘C:\Program Files (x86)\AutoIt3\SciTe’ 2. Open ‘Syntax report.au3’ with Write rights. 3. Delete all which is written into the file and save it. 4. Close the file. 5. Do the same into the ‘Syntax report.au3’ in ‘C:\Fluigent\SciTe’

Unicode language

Issue: Write symbols unusual.

Solution: Your Unicode language has to changed to “English US”.

1. Open Region and Language by clicking the Start button , clicking Control Panel, clicking Clock,

Language, and Region, and then clicking Region and Language.

2. Click the Administrative tab, and then, under Language for non-Unicode programs, click Change

system locale. If you're prompted for an administrator password or confirmation, type the

password or provide confirmation.

3. Select the language, and then click OK.

To restart your computer, click Restart now.

Page - 21

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


5 Script example

5.1 Script

#include <Group.au3> Init() ;================================================== ======================== ; The Script must start with #include <Group.au3> ; directly followed by Init() sequence ; Do not change this initialization ; Do not change the file Group.au3 ; The user scripts start after this commentary s equence ; Case insensitive ;================================================== ======================== Pressure(); Set all pressures to zero because all values are missing wait(10); Wait 10 seconds Pressure(10,20,30,40); Set pressure to the 4 channels. MFCS 4C: Ch1=10,Ch2=20,Ch3=30,Ch4=40. Missing values are equ al to 0. Wait(0.1); wait 0.1s NOTE: you cannot ask the script to wait less than 0.1s P(4,12.2) ;Set the pressure channel 4 to the pressure 12.2 mb ar for $j=1 to 5; Repeat from 1 to 5 the sequence you've written be tween [for and next] and increment the loop value $j by 1. ;Also you can set the increment: Ex: For $i = 1 to 5 step 2 Pressure(10.1,0,20.5); Set ch1=10.1 mbar,ch2=0 mbar ch3=20.5 mbar and ot her channels, if you have more than a 3 channel MFCS, m issing values are equal to 0. ;Note: Pressure(15.6,10,45.8,0) = Pressure(15.6,10, 45.8). Do not let empty value between others like this: pressure(10,,20) or Pressure(,10,20). Wait(2) ; This will make the script wait 2 seconds before t he next step order P(4,12.2); Set the Pressure channel 4 to the pressure 12.2 m bar wait(1); Wait 1 second Next incrP(3,1000); Add 1000 mbar to the channel 3 decrP(4,1000) ; Subtract 1000 mbar to the channel 4 for $h=1 to 3 ;We repeat 3 times the sequence between [for and Ne xt] incrxP(10,20,5,12); Add 10 mbar to pressure channel 1 (Pch1), add 20 to Pch2 ... || Note: Missing value(s) = add 0 wait(0.1); Wait 0.1 second Next ;================================================== ======================== ;Next loop repeats 5 times the decrement ;Between each decrement we wait 1 second ;Note: You cannot go under zero pressure even if th e number should ;================================================== ======================== for $h=1 to 5 decrxP(10,800); Subtract 10 mbar to pressure channel 1 (Pch1), su btract 800 mbar to Pch2 || Note: Missing value(s) = subtract 0

Page - 22

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


wait(1); Wait 1 second Next Volume(1,2.5,5) ; wait until the first volume(µl) through flow-mete rs is reached. Note: This command can only be used with F low-Rate Platform. PAY ATTENTION OF THE SIGN!!! V(1,1.5);wait until 1.5µl of liquid has flown through flow channel 1. Note: This command can only be used with Flow-Rate Platfo rm. PAY ATTENTION OF THE SIGN!!! ;================================================== ======================== ;The section below only concerns the customers with the Flow-rate Control Panel Module. ;You will not be able to use these commands if you don't have the corresponding dongle. ;Pay attention to the number of flow-meters you hav e connected. ;================================================== ======================== Load("MF_FRCM_0344359733774") ;This function loads an identification file that mu st exist. Note: You must start with a load function before using any other ;Flow-rate command wait(5); Due to the asynchronous aspect of Load function, we recommend to add a Wait function with 5 seconds. Depending of yo ur system the amount of time to wait can be longer or shorter. Flowrate(10,20,7); Set flow-rate channel 1 to 10 µl/min, flow-rate c hannel 2 to 20 µl/min, etc. || Note: Missing value(s) = 0 . wait(2);wait 2sec Q(1,20);Set the flow-rate channel 1 to 20 µl/min. wait(2);wait 2sec incrQ(2,10);Add to the flow-rate channel 2, 10 µl/min. wait(2);wait 2sec decrQ(1,15);Subtract to the flow-rate channel 1, 15 µl/min. wait(2);wait 2sec incrxQ(10,5);Add 10 µl/min to the flow-rate channel 1, 5µl/mint o flow-rate channel 2 || Note: Missing value(s) = add 0. wait(2);wait 2sec decrxQ(20,0,5);Subtract 20 µl/min to the flow-rate channel 1, 0µl /min to flow-rate channel 2, etc. || Note: Missing value(s ) = sub 0. ;================================================== ======================== ;The section below only concerns the customers with the ESS Control Module. ;You will bot be able to use these commands if you don't have the corresponding dongle. ;================================================== ======================== TwoSwX(1,1,2);Set the first three 2-SWITCH TM connected to the S WITCHBOARD to a specific position (1 or 2). This command takes 200 ms to run. Wait(2) MSwX(5);Set the first three M-SWITCH TM connected to the S WITCHBOARD to a specific position (1 to 10). This command takes 150 0 ms to run because M-SWITCH TM needs time to change position. Wait(10)

Page - 23

FLUIGENT


Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com


TwoSw(7,1);Set the 2-SWITCH TM connected to the port n°7 to t he position 1. Note: You cannot use this command for a port withou t 2-SWITCH TM connected. Wait(5) MSw("A",8);Set the M-SWITCH TM connected to the port letter " A" of the SWITCHBOARD to the position 8. Note: You cannot use this command for a port without M-SWITCH TM connected. LSw("B",2);Set the L-SWITCH TM connected to the port letter " B" of the SWITCHBOARD to the position 2. Note: You cannot use this command for a port without L-SWITCH TM connected. Wait(2) ESS(sw(1),ROTSwX(1,8),TwoSwX(1,2));Control the M-SWITCH TM, L-SWITCH TM and the 2-SWITCH TM at the same time for the SWITCHBOAR D (SW) no.1. This command takes 1.5sec to run but all orders are set at the same time. ;The 'sw' command must have the 1 as a value. (Only one SWITCHBOARD connected) ;The command 'ROTSwX' inside the 'ESS' command work s exactly the same way than the usual 'MSwX' or 'LSwX' commands depending on SWITCH model. ;The command 'TwoSwX' inside the 'ESS' command work s exactly the same way than the usual 'TwoSwX' command. End() ;You MUST end the script with this order!

5.2 Product requirements for the script example

1*MFCS™ 4C. 1*SWITCHBOARD. 1*L-SWITCH™. 1*M-SWITCH™. 3*2-SWITCH™. 1*FLOWBOARD and 3 FLOW UNITS. Maesflo™ and ESS™ Control software.

Siège social : Bio

SA à Directoire et Conseil de Surveillance au capital de

1 mail du

FLUIGENT

Biopark – 1 mail du Professeur Georges Mathé – 94800 Villejuif – France

Tel : +331 77 01 82 68 – Fax : +331 77 01 82 70

www.fluigent.com

apital de 141 284.95 € - Siret : 487 636 409 00038 – N°TVA UE/EU VAT Number : FR

FLUIGENT SA

BIOPARK

1 mail du Professeur Georges Mathé

94800 VILLEJUIF

FRANCE

www.fluigent.com

+33 1 77 01 82 68

Technical support:

[email protected]

+33 1 77 01 82 65

General information:

[email protected]

Page - 24

: FR 53 487 636 409

Script Modu Module v1.5 ule v1 - Fluigent€¦ · Module v1.5 User manual Page - 1 : FR 53 487 636...

Documents

Transcript of Script Modu Module v1.5 ule v1 - Fluigent€¦ · Module v1.5 User manual Page - 1 : FR 53 487 636...