top bar

Difference between revisions of "AndorLaserCombiner"

(Warn about Prolific driver for Windows 7)
(Installation instructions for different scenarios)
Line 1: Line 1:
 
<table><tr><td  valign=top >
 
<table><tr><td  valign=top >
 
'''Summary:'''</td><td>Interfaces with Andor laser combiner</td></tr>
 
'''Summary:'''</td><td>Interfaces with Andor laser combiner</td></tr>
<tr><td valign=top>'''Author:'''</td><td>Karl Hoover, UCSF - µManager device adapter<br>Pariksheet Nanda, Andor Support - this documentation and code maintainer</td></tr>
+
<tr><td valign=top>'''Author:'''</td><td>Karl Hoover, UCSF - µManager device adapter<br>Pariksheet Nanda, Andor Support - this documentation and µManager device adapter code maintainer</td></tr>
 
<tr><td  valign=top >'''License:'''</td><td>BSD</td></tr>  
 
<tr><td  valign=top >'''License:'''</td><td>BSD</td></tr>  
 
<tr><td  valign=top >'''Platforms:'''</td><td>Windows XP 32-bit, 7 32-bit, 7 64-bit (No Mac or Linux driver available)</td></tr>
 
<tr><td  valign=top >'''Platforms:'''</td><td>Windows XP 32-bit, 7 32-bit, 7 64-bit (No Mac or Linux driver available)</td></tr>
Line 22: Line 22:
 
*# External laser control via PCUV-101
 
*# External laser control via PCUV-101
 
*#* Use the [[AOTF|NEOS]] driver instead.
 
*#* Use the [[AOTF|NEOS]] driver instead.
* You need to download a copy of the Andor Laser Combiner SDK.  It is not publicly available.  [[#Laser Combiner questions|Request Andor support]] to gain access to it, stating in the support request form you need the drivers for µManager. The current ALC SDK release version as of Feb 17, 2011 is 0.9
+
* You need to download a copy of the Andor Laser Combiner SDK (ALC_SDK).  It is not publicly available.  [[#Laser Combiner questions|Request Andor support]] to gain access to it, stating in the support request form you need the drivers for µManager.
* This guide assumes you have a computer preconfigured with drivers, such as the computer Andor sells.  If you have a non-Andor computer which doesn't have the necessary drivers see the [[#Installing Andor Drivers (only required for non-Andor computers)|appendix]] to install them and setup COM ports.
+
* '''ALC_SDK 2.0 is the current version as of July 29, 2011'''
 +
* This guide assumes you have a computer preconfigured with drivers, such as the computer Andor sells.  If, instead, you have a non-Andor computer please read the [[#Appendix|appendix]] to install the drivers and map the COM ports.
  
  
  
== Installing the Device Adapter ==
+
== Installing the ALC_SDK for the Device Adapter ==
 
* The Andor Laser Combiner SDK is packaged in a zip file.  Decompress to a folder on your C: drive.  Copy the location of the `Libraries' folder (e.g. C:\Andor\0.9\ALC_REV_SDK\Libraries).
 
* The Andor Laser Combiner SDK is packaged in a zip file.  Decompress to a folder on your C: drive.  Copy the location of the `Libraries' folder (e.g. C:\Andor\0.9\ALC_REV_SDK\Libraries).
 
[[Image:01- Decompress Andor SDK for Laser combiner.png|frame|center||Decompress the Andor Laser Combiner SDK from the zip file]]
 
[[Image:01- Decompress Andor SDK for Laser combiner.png|frame|center||Decompress the Andor Laser Combiner SDK from the zip file]]
Line 39: Line 40:
 
[[Image:03- HW cfg part 1.png|frame|center||Add the Andor Laser Combiner to the Hardware Configuration]]
 
[[Image:03- HW cfg part 1.png|frame|center||Add the Andor Laser Combiner to the Hardware Configuration]]
 
[[Image:04- HW cfg part 2.png|frame|center||Finalize configuration settings]]
 
[[Image:04- HW cfg part 2.png|frame|center||Finalize configuration settings]]
 
  
  
Line 45: Line 45:
 
=== Laser Combiner questions ===
 
=== Laser Combiner questions ===
 
For contacting Andor product support regarding any questions, use this [http://www.andor.com/contact_us/support_request/documentation/default.aspx?product=Revolution%C2%AE%20XD Andor Product Support link]
 
For contacting Andor product support regarding any questions, use this [http://www.andor.com/contact_us/support_request/documentation/default.aspx?product=Revolution%C2%AE%20XD Andor Product Support link]
 
  
  
 
=== Development support ===
 
=== Development support ===
 
This driver is not actively maintained by the Andor software team.
 
This driver is not actively maintained by the Andor software team.
For feature requests or bug reports, please liaison with µManager developers on [[Micro-Manager_Community|the mailing list]].  
+
For feature requests or bug reports, please liaison with µManager developers on [[Micro-Manager_Community|the mailing list]] and Pariksheet Nanda.  
  
  
  
 +
== Appendix ==
 +
=== Setting Micro-Manager but not iQ ===
 +
If you want to run Andor's iQ software as well on this computer, skip to the [[#Setting Micro-Manager alongside Andor iQ|the next section]]
  
 +
Specific driver versions are required.  Do not rely on the manufacturer websites for these drivers.  The ALC_SDK version 2 now bundles all the drivers you need to install to get the ALC running.  Install the drivers bundled with the ALC SDK zip file for your flavor of Windows:
  
== Appendix ==
+
      .\ALC_REV_SDK\Drivers\
=== Installing Andor Drivers (only required for non-Andor computers) ===
+
  
NOTE: Andor completes the steps described in this section in their factory.
+
=== Setting Micro-Manager alongside Andor iQ ===
If you are setting up an Andor laser combiner on a new computer, only then do you need to follow this document.
+
Andor completes the steps described in this section in their factory.
 
+
If you are setting up an Andor laser combiner on a new computer, only then do you need to follow this section.
Specific driver versions are required.
+
Since the manufacturer websites offer later versions of these drivers, please instead use your Andor iQ CD-ROM and install only in the following order.
+
  
 
When you start Windows, ignore the Found New Hardware Wizard.
 
When you start Windows, ignore the Found New Hardware Wizard.
Line 84: Line 84:
 
# Start Menu > Andor Bioimaging > ConfigurationManager
 
# Start Menu > Andor Bioimaging > ConfigurationManager
 
#* Create a new configuration with a Kinetic Dummy Camera and the Andor laser combiner
 
#* Create a new configuration with a Kinetic Dummy Camera and the Andor laser combiner
 +
 +
=== Mapping COM ports ===
 
# Remap the USB-to-Serial COM ports in your Device Manager to 201-204
 
# Remap the USB-to-Serial COM ports in your Device Manager to 201-204
 
#* iQ reserves these specific port numbers for the combiner
 
#* iQ reserves these specific port numbers for the combiner
 
#* (Right-click) on My Computer > Manage to invoke the Device Manager
 
#* (Right-click) on My Computer > Manage to invoke the Device Manager
 
#* See screenshots below to change COM ports.  By unplugging the USB cable from the front of the Andor combiner we know that Windows has enumerated the COM ports for the lasers from COM 7 to COM 10 (since these port numbers disappear from the Device manager when we unplug the combiner and reappear when we plug it back in) [[Image:AB-1-com-ports.png|frame|center||Step 1:  After restarting Windows with drivers freshly installed, the device manager can list the COM ports of the laser combiner out of order i.e. it orders alphabetically instead of numerically. In this case COM10 should not be made 201, but COM7 would be 201]] [[Image:AB-2-reassign-com-port.png|frame|center||Step 2:  Process of reassigning the COM port from COM 7 to COM 201.  (Right-click) on the port > Properties > Port Settings (tab) > Advanced > change the COM port number]] [[Image:AB-3-reassigned-scan.png|frame|center||Step 3:  After 201-204 have been resassigned, click on scan for hardware changes to refresh the window]] [[Image:AB-4-new-ports.png|frame|center||Step 4:  Result of COM port changes]]
 
#* See screenshots below to change COM ports.  By unplugging the USB cable from the front of the Andor combiner we know that Windows has enumerated the COM ports for the lasers from COM 7 to COM 10 (since these port numbers disappear from the Device manager when we unplug the combiner and reappear when we plug it back in) [[Image:AB-1-com-ports.png|frame|center||Step 1:  After restarting Windows with drivers freshly installed, the device manager can list the COM ports of the laser combiner out of order i.e. it orders alphabetically instead of numerically. In this case COM10 should not be made 201, but COM7 would be 201]] [[Image:AB-2-reassign-com-port.png|frame|center||Step 2:  Process of reassigning the COM port from COM 7 to COM 201.  (Right-click) on the port > Properties > Port Settings (tab) > Advanced > change the COM port number]] [[Image:AB-3-reassigned-scan.png|frame|center||Step 3:  After 201-204 have been resassigned, click on scan for hardware changes to refresh the window]] [[Image:AB-4-new-ports.png|frame|center||Step 4:  Result of COM port changes]]
 +
 +
=== Testing ===
 
# (Optional for testing) Now start iQ with your new laser combiner configuration and test.  The ALC_SDK also includes a test program which turns lasers on sequentially and then off:
 
# (Optional for testing) Now start iQ with your new laser combiner configuration and test.  The ALC_SDK also includes a test program which turns lasers on sequentially and then off:
  
Line 95: Line 99:
  
  
[[User:P.nanda|P.nanda]]
+
[[User:P.nanda|P.nanda]] 14:33, 29 July 2011 (PDT)

Revision as of 14:33, 29 July 2011

Summary:Interfaces with Andor laser combiner
Author:Karl Hoover, UCSF - µManager device adapter
Pariksheet Nanda, Andor Support - this documentation and µManager device adapter code maintainer
License:BSD
Platforms:Windows XP 32-bit, 7 32-bit, 7 64-bit (No Mac or Linux driver available)
Devices:Andor laser combiners: ALC-401, ALC-501, ALC-601


Getting Started

  • The Andor Laser Combiner SDK, and consequently µManager which depends on it, can control the following models:
    1. LC-401
    2. LC-501
    3. LC-601
  • These models are not currently supported:
    1. LC-103
      • Use the AA AOTF driver instead. There is a an RS-232 connection on the front of the Andor PCU to interface to the AOTF controller. However, switching lasers wavelengths and power using this method is much slower than using the analog interface.
      • If you want proper analog control supported for fastest operation, i.e. using Andor's choice of DAC card, please request Andor
    2. External laser control via PCUV-101
      • Use the NEOS driver instead.
  • You need to download a copy of the Andor Laser Combiner SDK (ALC_SDK). It is not publicly available. Request Andor support to gain access to it, stating in the support request form you need the drivers for µManager.
  • ALC_SDK 2.0 is the current version as of July 29, 2011
  • This guide assumes you have a computer preconfigured with drivers, such as the computer Andor sells. If, instead, you have a non-Andor computer please read the appendix to install the drivers and map the COM ports.


Installing the ALC_SDK for the Device Adapter

  • The Andor Laser Combiner SDK is packaged in a zip file. Decompress to a folder on your C: drive. Copy the location of the `Libraries' folder (e.g. C:\Andor\0.9\ALC_REV_SDK\Libraries).
Decompress the Andor Laser Combiner SDK from the zip file
  • Right-click the My Computer icon on the desktop or start menu, click properties and on the advanced tab choose Environment variables. On the system variables list, find "Path" or "PATH" and click edit. DO NOT DELETE ANYTHING. Just add ;C:\YOURFOLDER on the end of the line on the edit window. Of course, remember to change the folder to where you unzipped the SDK. Also, remember to include the semi-colon (;) or you might break something on your windows installation. Now, reboot your computer.
Add the Andor Laser Combiner SDK `Libraries' folder to the Windows PATH so that MicroManager can find the DLLs
  • Get the latest nightly build to run the Andor laser combiner in uManager.
  • When configuring your hardware setup, remember to add the AndorLaserCombiner and AndorLaserCombiner Piezostage (if you have a piezostage). Also, the configuration wizard will ask if you have a multiport unit present. If you have a FRAPPA unit or TIRF setup, you do and should set it to "1" (true). Other than those cases you probably don't have it, set it to "0" (false).
Add the Andor Laser Combiner to the Hardware Configuration
Finalize configuration settings


Resources

Laser Combiner questions

For contacting Andor product support regarding any questions, use this Andor Product Support link


Development support

This driver is not actively maintained by the Andor software team. For feature requests or bug reports, please liaison with µManager developers on the mailing list and Pariksheet Nanda.


Appendix

Setting Micro-Manager but not iQ

If you want to run Andor's iQ software as well on this computer, skip to the the next section

Specific driver versions are required. Do not rely on the manufacturer websites for these drivers. The ALC_SDK version 2 now bundles all the drivers you need to install to get the ALC running. Install the drivers bundled with the ALC SDK zip file for your flavor of Windows:

     .\ALC_REV_SDK\Drivers\

Setting Micro-Manager alongside Andor iQ

Andor completes the steps described in this section in their factory. If you are setting up an Andor laser combiner on a new computer, only then do you need to follow this section.

When you start Windows, ignore the Found New Hardware Wizard. Also when installing, ignore the driver requests to restart your computer.

  1. (Optional for testing) Dongle Driver
  2. Andor iQ
    • Necessary because iQ installs the driver to recognize the DeVaSys microcontroller in the combiner
    • (Optional for testing) iQ would also serve to test that communication and control of the combiner is possible
  3. Instacal for the Measurement Computing DAC card driver
    • Recognizes the Andor Precision Control Unit (PCU) box which controls the laser combiner Acousto-Optic Tunable Filter (AOTF)
  4. Prolific PL-2303 USB to RS232 driver. For Windows 7 do not use Prolific's public driver. It will lock up Windows. Use the version bundled with the ALC SDK instead.
  5. Restart your PC
  6. Let Windows Found New Hardware wizard finish for all hardware
  7. Start menu > Measurement Computing > InstalCal, to register the PCU DAC card
    • Running InstaCal creates a new configuration file which is used by iQ
    • Simply running the program once and closing it creates the file
    • Do not delete the DEMO board.
    • Two boards should exist, the DEMO board #0 and your installed board #1
  8. Start Menu > Andor Bioimaging > ConfigurationManager
    • Create a new configuration with a Kinetic Dummy Camera and the Andor laser combiner

Mapping COM ports

  1. Remap the USB-to-Serial COM ports in your Device Manager to 201-204
    • iQ reserves these specific port numbers for the combiner
    • (Right-click) on My Computer > Manage to invoke the Device Manager
    • See screenshots below to change COM ports. By unplugging the USB cable from the front of the Andor combiner we know that Windows has enumerated the COM ports for the lasers from COM 7 to COM 10 (since these port numbers disappear from the Device manager when we unplug the combiner and reappear when we plug it back in)
      Step 1: After restarting Windows with drivers freshly installed, the device manager can list the COM ports of the laser combiner out of order i.e. it orders alphabetically instead of numerically. In this case COM10 should not be made 201, but COM7 would be 201
      Step 2: Process of reassigning the COM port from COM 7 to COM 201. (Right-click) on the port > Properties > Port Settings (tab) > Advanced > change the COM port number
      Step 3: After 201-204 have been resassigned, click on scan for hardware changes to refresh the window
      Step 4: Result of COM port changes

Testing

  1. (Optional for testing) Now start iQ with your new laser combiner configuration and test. The ALC_SDK also includes a test program which turns lasers on sequentially and then off:
     .\ALC_REV_SDK\Libraries\ALC_REVTest.exe
     .\ALC_REV_SDK\Libraries\ALC_REVTest64.exe


P.nanda 14:33, 29 July 2011 (PDT)

© Micro-Manager : Vale Lab, UCSF 2006-2011 | All Rights Reserved | Contact