top bar

Difference between revisions of "AndorLaserCombiner"

m (Fix typo.)
(Link to new windows PATH editing section. Also some minor cleanup.)
Line 178: Line 178:
 
|}
 
|}
  
* Unzip the <code>ALC_SDK Libraries</code> to a new folder (you may need to download [http://www.7-zip.org/ 7-zip]):
+
* Unzip the <code>ALC_SDK Libraries</code> to a new folder and [[Personal computer setup#Add_device_libraries_to_Windows_PATH|add it to the Windows PATH]]:
 
           C:\ProgramData\Andor_ALC_library\
 
           C:\ProgramData\Andor_ALC_library\
<!-- Setting up the PATH is not super easy and should be moved to its own page or template for consistency -->
+
* If you already have control of your ALC in another software, your ALC_SDK installation is complete because all the Windows device drivers would be installed.  Otherwise continue on to [[#configure ALC_SDK dependencies]].
* Add the above folder to your Windows <code>PATH</code> variable, namely:
+
** Right-click the My Computer icon on the desktop or start menu
+
** Click <code>Properties</code> and on the <code>Advanced</code> tab choose <code>Environment</code> variables.
+
** On the <code>System Variables</code> list, find "Path" or "PATH" and click edit.  DO NOT DELETE ANYTHING.  Just add <code>;C:\ProgramData\Andor_ALC_library\</code> on the end of the line on the edit window. The leading semi-colon (;) is necessary or you might break something on your windows installation.
+
** If your OS is older than Windows 7, restart your computer for the new <code>PATH</code> to take effect.
+
* If you already have control of your ALC in another software, your ALC_SDK installation is complete.  Otherwise continue on to [[#Configure ALC_SDK dependencies|Configure ALC_SDK dependencies]]
+
  
 
=== Configure ALC_SDK dependencies ===
 
=== Configure ALC_SDK dependencies ===

Revision as of 16:25, 27 June 2014

Summary: Interfaces with Andor laser combiner
Author: Karl Hoover, UCSF - µManager device adapter
Maintainer: Pariksheet Nanda, Andor - this documentation and µManager device adapter
Contributors: Ed Simmons, ES Imaging - patch for GUI TTL outputs
Pedro Almada, documentation fixes
License: BSD
Platforms: Windows XP 32bit
Windows 7 32bit and 64bit
(No Mac or Linux driver available)
Devices: LC-401, LC-501, LC-601 (only 4 laser LC-601 systems supported; 5 and 6 line support coming soon)
Since version 1.3.47


Installation

µManager 1.4.16 onward bundles all required libraries. For versions than 1.4.16_20131025 follow the library installation in the appendix.

If you're setting up a brand new computer, continue on to Configure ALC_SDK dependencies

Hardware Configuration

Description of devices available in the Hardware Configuration Wizard:

Available Devices Description
AndorLaserCombiner Main device required for your hardware configuration.
Piezostage Enable Andor's analog BNC control for your Piezo Z device. Generally, confocal systems have this configuration since it moves the Piezo faster than RS-232 serial control. If you are unsure about this, look at the front of your Andor Precision Control Unit (PCU)- if you see a BNC cable connected from A5 of the PCU to your Piezo Z controller, you should enable this option. If you see the A5 BNC sealed off, you have a 6 laser system that therefore does not have this feature.
Initialization Properties Description
MultiPortUnitPresent Leave as the default "0" (false) if you only see a single fiber optic connected horizontally to the front of the laser combiner. Otherwise select "1" (true) if you see the multi fiber optic switcher attachment.

For Auto-Shutter setting in Step 3 of 6, set the Default Shutter to the AndorLaserCombiner and in Step 4 of 6 use the default Delay [ms] of 0.0 since a fast AOTF gates the laser output.

Device Properties

Property Description
Enable Logical shutter to allow selection of laser line. It can also set the laser to TTL mode, if the laser supports it. TTL mode requires firmware 2. When creating laser imaging channels, you should add the Enable properties for each laser wavelength to turn on only the wavelength(s) you need.
SaveLifetime Allows lasers to be put in standby mode to preserve lifetime hours. Changes to this property are saved onto the device memory, so the setting is persistently between Micro-Manager sessions. Since going into and coming out of standby can take a few seconds, best practice is leave this property "global" by not including it in channels. Instead, one could add these properties to the System Startup preset, or just create shortcuts by creating groups with only the SaveLifetime setting(s).
IsLinear Reads whether linear correction algorithm is being applied to AOTF by PowerSetpoint, otherwise AOTF laser power output is sigmoid.
PowerSetpoint AOTF intensity setting. Actual power output may or may not be linear depending on the value of IsLinear.
PowerReadback Current laser head power output. Output of 0, could be due to laser being put in Standby using SaveLifetime, or a fault with the laser head. If power is more than a few percent lower than MaximumLaserPower, it also indicates a faulty laser head, but some lasers can take up to 5 minutes to warm up (most warm up in 2 minutes).
MaximumLaserPower Laser rated operating power in milli-Watts.
Hours Indicates laser expired life to plan warranty contracts. (Unfortunately this always shows a value of "0" because the feature is not yet implemented by the Andor ALC SDK)
WaveLength Wavelength of laser line.
LaserState Laser state: "0" indicates off, "1" warm up (if SaveLifetime is set to "PowerOn") or standby (if SaveLifetime is set to "Standby"), and "2" is stable output.
NLasers Number of lasers available.
LaserPort Multi fiber port unit control.
DOUT Digital 8-bit output from Precision Control Unit. The lowest 2 bits are not accessible if a multi fiber port unit is present.
DIN Digital 8-bit input from Precision Control Unit. Reads TTL input signal state.

Troubleshooting (known issues and fixes)

No laser, but laser emission LEDs are illuminated

Description The hardware appears to be operating correctly, but there is no laser output. The camera is running live, feeding the Active Blanking signal.
Cause DEMO-BOARD device listed in InstaCal
Workaround Delete the DEMO-BOARD device by opening InstaCal from Start Menu > Programs > Measurement Computing

Microsoft Visual C++ error(s) opening HCW

Description Opening the Hardware Configuration Wizard shows one or more of the following error windows, and closing the window immediately crashes µManager:
Figure: Error due to incorrect internal laser power setting
Cause Bug in ALC_SDK (Laser power setting exceeding rated value)
Workaround Request Andor support to remotely connect to each laser head and adjust the "set power" (using the p= serial command) to the rated value of the laser head.

Hang during acquisition

Description Micro-Manager hangs during acquisition
Cause 1 Windows USB power saving is enabled
Workaround 1 Disable Windows USB power saving
Cause 2 Buggy Prolific driver (version 3) bundled by Windows 7
Workaround 2 Install Prolific driver version 2.0.13.130 and delete newer versions from the Device Manager.

Resources

Laser Combiner questions

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

Click here to search for Andor on the Micro-Manager mailing list archive.

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

Library installation for MM 1.4.15 and earlier

  • In older versions of Micro-Manager, the ALC_SDK library files were not included in the main Micro-Manager directory. For convience the files have been uploaded (with permission) to this wiki:
ALC Driver Pack Visual C++ 2008 redist
(Only for MM 1.4.14 and earlier)
32-bit ALC_SDK Libraries 2.0 (32-bit) vcredist_x86.exe
64-bit ALC_SDK Libraries 2.0 (64-bit) vcredist_x64.exe
         C:\ProgramData\Andor_ALC_library\
  • If you already have control of your ALC in another software, your ALC_SDK installation is complete because all the Windows device drivers would be installed. Otherwise continue on to #configure ALC_SDK dependencies.

Configure ALC_SDK dependencies

  • Install your OS dependencies, located under the unzipped ALC_SDK's Drivers directory. Under each OS folder there are folders for the 3 dependency drivers:
    • DeVaSys (for front USB control to enable interlocks)
    • Prolific PL-2303 USB (for laser serial communication)
    • Measurement Computing (for PCI DAC card)
  • The devices will be detected in the Device Manager as:
     DAS Component
        PCIM-DDA06/16
     DeVaSys USB Interfaces
        USB-I2C/IO Board
     ...
     Ports (COM & LPT)
        ...
        Prolific USB-to-Serial Comm Port
        ...
  • Run Instacal from Windows Start Button > All Programs > Measurement Computing. You will see the "Plug and Play Board Detection" window finding your PCIM-DDA06/16 card. Click OK and Exit Instacal. This has now written your DAC card configuration file.
  • Open the Device Manager to check the COM port numbers for the USB-to-Serial COM ports built into the ALC. Andor's library reserves specific port numbers for the combiner and expects them to be COM201-206. Change the port numbers as follows:
    • Unplug the blue USB cable from the front of the ALC and check if any such ports remain, to confirm if you have other Prolific USB-to-Serial devices attached. If see some still left, make a note of their COM numbers so that you don't change them. Plug the ALC back in and note the new COM numbers.
    • For each of your reappeared COM ports, check the port physical location by (Right-click) > Properties. On Windows 7, the "Port" is immediately visible under Location in the General tab. Search the Properties of all the Prolific USB-to-Serial devices until you see Port_#0001. That port will need to be changed to COM 201. Note the corresponding Hub_# number of that port.
    • Reassign your COM ports number by (Right-click) > Properties > Port Settings (tab) > Advanced > change the COM port number to 201
    • With your Hub number of COM 201 noted above, reassign the remaining Port_#0002, Port_#0003, Port_#0004 for that Hub as COM 202, 203, 204 as above.
    • If your sled has 5 or 6 lasers you will be left with two more Prolific USB-to-Serial ports. You will need to reassign Port_#0002, Port_#0003 as COM 205 and 206, respectively
  • Restart the computer to apply the COM port changes
© Micro-Manager : Vale Lab, UCSF 2006-2011 | All Rights Reserved | Contact