top bar

ScopeLED

Summary: This adapter supports two ScopeLED illuminators: ScopeLED-MSB/MSP for the microscope illuminator, and ScopeLED-FMI for the fluorescence illuminator.

Both devices are implemented as shutters, and both devices communicate via USB.

Author: Ryan Clark <rclark AT diconlighting DOT com>
License: LGPL
Platforms: Windows 2000 and higher.
Micro-Manager v1.4.10 and higher.
Requires DiCon USB Communication Adapter version 2.0.0.0 or newer (see Dependencies section, below).
Dependencies: This device adapter requires a USB Communication Adapter, which is available for free at http://www.scopeled.com/resources/downloads.php.


Properties Documentation

(This documentation is also available here.)

All ScopeLED Illuminators

Property VendorID
Type Numeric value from 0 to 65535. The DiCon USB Vendor ID is 9410 (0x24C2).
Function Sets the USB Vendor ID used to identify the target device. This property must be set before the device is instantiated.

Property ProductID
Type Numeric value from 0 to 65535.
Function Sets the USB Product ID used to identify the target device. This property must be set before the device is instantiated.

Property InitSerialNumber
Type String value
Function

Prior to initialization, this property indicates the Serial Number string to be used to identify the target device. It is optional to set this property.

Use this value to identify a specific device in a system where more than one device is present.

If this value is not set prior to initialization, Micro-Manager will open the first available device with the matching VendorID and ProductID.


Property SerialNumber
Type String value
Function

During initialization, this property is set to the Serial Number string of the device.

Micro-Manager makes no use of this property. It is for information purposes only. Changing the value will not make any changes to the device.


Property Version
Type Numeric
Function Read-only value indicating the firmware version of the device.

The version is a four-byte value. Each byte represents one portion of the version number. The most significant byte contains the most significant version number. For example, a Version value of 0x02030100 (note the hexadecimal notation) indicates a version of 2.3.1.0.


Property LastError
Type Numeric
Function Read-only value indicating the last USB communication error. See Appendix A for a description of the error codes.

Property LastDeviceResult
Type Numeric
Function Read-only value indicating the last device error. See your device documentation for a description of the error codes.

ScopeLED-G
ScopeLED Fiber Guide Illuminators

Note
The ProductID for G-Series illuminators is 4867 (0x1303).
Property Channel1Brightness, Channel2Brightness, Channel3Brightness, Channel4Brightness
Type Floating-point value from 0 to 100, representing the percentage.
Function Gets or sets the brightness level of the indicated channel. This property changes the cached value. The new value will not take effect until the shutter is next opened.

ScopeLED-B
ScopeLED Brightfield Microscope Illuminators

Note
The ProductID for B-Series illuminators is 4874 (0x130A).
Property ActivePresetMode
Type Integer value from 0 to 6, representing the active Preset Mode.
Function Gets or sets the active Preset Mode.The brightness of the illuminator will be controlled according to the setting of the corresponding preset mode. Preset Mode 0 activates brightness control for the individual channels via the properties Channel1Brightness, Channel2Brightness, Channel3Brightness, and Channel4Brightness.

Property Channel1Brightness, Channel2Brightness, Channel3Brightness, Channel4Brightness
Type Floating-point value from 0 to 100, representing the percentage.
Function Gets or sets the brightness level of the indicated channel. The intensities set by these properties are only active when ActivePresetMode is set to 0.

Property PresetMode1Brightness, PresetMode2Brightness, PresetMode3Brightness, PresetMode4Brightness, PresetMode5Brightness, PresetMode6Brightness
Type Floating-point value from 0 to 100, representing the percentage.
Function Gets or sets the brightness level of the indicated Preset Mode. The intensities set by these properties are only active when ActivePresetMode is set to the corresponding Preset Mode. For example, in order to make active PresetMode4Brightness, ActivePresetMode must be 4.

ScopeLED-F
ScopeLED Fluorescence Microscope Illuminators

Note
The ProductID for F-Series illuminators is 4869 (0x1305).
Property LEDGroup
Type Integer from 1 to 9.
Function Gets or sets the active LED group.

Property Channel1Brightness, Channel2Brightness, Channel3Brightness, Channel4Brightness
Type Floating-point value from 0 to 100, representing the percentage.
Function Gets or sets the brightness level of the indicated channel. This property sends a command to the device, so if the shutter is open, the brightness is affected immediately.

Property Channel1Wavelength, Channel2Wavelength, Channel3Wavelength, Channel4Wavelength
Type Integer value indicating the wavelength in nanometers
Function Gets the wavelength of the indicated channel in nanometers.

Property LEDGroup1Channels, LEDGroup2Channels, LEDGroup3Channels, LEDGroup4Channels, LEDGroup5Channels, LEDGroup6Channels, LEDGroup7Channels, LEDGroup8Channels, LEDGroup9Channels
Type Integer value representing a bit-map of the active channels
Function Read-only bit-map that indicates which channels are available for the indicated LED group.

Property ActiveChannels
Type String
Function Gets a comma-separated list of active channels for the current active LED group. The channel is in the format “ChX” where X is the channel number.

Property ActiveWavelengths
Type String
Function Gets a comma separated list of active wavelengths for the current active LED group.

Property OptimalStagePosition
Type String
Function Gets the X and Y stage coordinates that are optimal for the current active LED group.


Appendix A: USB Error Codes

The following table lists the error values returned by the LastError property.

Error Value Description
0 No error.
1 A parameter is invalid.
2 Device not found.

Make sure that the device is properly connected to your computer and powered on.

Make sure that the VendorID, ProductID and SerialNumber (optional) properties match your device.

3 Failed memory allocation.
4 Failed HID enumeration.
5 Failed to initialize the device.
6 Operation aborted. The communication operation was aborted by the user.
7 Device is not connected.
8 Invalid device state.
9 The buffer is too small.
10 An HID API function failed.
11 Queue error.
© Micro-Manager : Vale Lab, UCSF 2006-2011 | All Rights Reserved | Contact