HoribaLabViewSDK

DeviceManager.lvlib:DevicesList

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:DiscoverDevices

DeviceManager.lvlib:OpenConnectionWithDevice.vi
DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Get Module Execution Status

DeviceManager.lvlib:Obtain Broadcast Events for Registration.vi
DeviceManager.lvlib:Start Module.vi

DeviceManager.lvlib:Hide Panel

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:ICLshutdown

DeviceManager.lvlib:CloseConnectionWithDevice.vi
DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:ICLstartNotification

DeviceManager.lvlib:OpenWebSocketCommunication

DeviceManager.lvlib:OpenConnectionWithDevice.vi
DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:SendJSONandAskForReply

DeviceManager.lvlib:Test DeviceManager API.vi
GenericDevice.lvclass:Send Receive Parse.vi

DeviceManager.lvlib:Show Diagram

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Show Panel

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:StartICL

DeviceManager.lvlib:OpenConnectionWithDevice.vi
DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Error Reported

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Module Did Init

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Module Did Stop

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Status Updated

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:Update Module Execution Status

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:devicesDiscovered

DeviceManager.lvlib:Test DeviceManager API.vi

DeviceManager.lvlib:iclExeIsRunning

DeviceManager.lvlib:websocketConnectionOpened

DeviceManager.lvlib:Test DeviceManager API.vi

 — 

 — 

DeviceManager.lvlib

Error Reported.vi
Module Did Init.vi
Module Did Stop.vi
Status Updated.vi
Update Module Execution Status.vi
devicesDiscovered.vi
iclIsRunning.vi
websocketConnectionOpened.vi

Start Module

Launches the module Main VI. After calling this VI, you can optionally register for broadcast events from the module by wiring the broadcast events output of this VI to a Register For Events function.

After the optional Register For Events function call, you should always call the Synchronize Module Events.vi for this module with the 'Wait for Event Sync?' output of this VI to the corresponding input of the Synchronize Module Events.vi.

To see an example of the proper wiring pattern, see the "Start Module: Value Change" event frame in the API Tester VI for this module.

Stop Module

Send the Stop request to the Module’s Main.vi.

If Wait for Module to Stop? is TRUE, this VI will wait until the module main VI stops, and will timeout at the Timeout to Wait for Stop value. This value defaults to "-1", which means the VI will not timeout, and will always wait until the module main VI stops before completing execution.

Note: The Timeout to Wait for Stop value is ignored if 'Wait for Module to Stop?' is set to FALSE.

Show Panel

Send the Show Panel request to the Module’s Main.vi.

Hide Panel

Send the Hide Panel request to the Module’s Main.vi.

Get Module Execution Status

Fire the Get Module Execution Status request.

Show Diagram

This VI tells the Module to show its block diagram to facilitate troubleshooting (add probes, breakpoints, highlight execution, etc).

SendJSONandAskForReply

This request asks in a synchronous manner to send a JSON string to the ICL, waits the specified time in [ms] and querries the websocket for a reply.

StartICL

This command starts the ICL.exe and its monitoring

OpenWebSocketCommunication

This event opens the websocket communcation from the DeviceManager to the ICL.exe

ICLshutdown

This request sends the command to shutdown the ICL.exe via websocket communication.

DiscoverDevices

Requests from the ICL to discover monochromators, cameras and single channel detectors.

DevicesList

This event calls mono_list, ccd_list, and scd_list.

Module Did Init

Send the Module Did Init event to any VI registered to listen to this module’s broadcast events.

Status Updated

Send the Status Updated event to any VI registered to listen to events from the owning module.

Error Reported

Send the Error Reported event to any VI registered to listen to events from the owning module.

Module Did Stop

Send the Module Did Stop event to any VI registered to listen to this module’s broadcast events.

Update Module Execution Status

Broadcast event to specify whether or not the module is running.

iclExeIsRunning

This broadcast is sent when the ICL has been launched or a already running ICL has been detected.

websocketConnectionOpened

This broadcast is fired when the websocket connection is opened.

devicesDiscovered

This broadcast is being fired when devices where trying to be discovered. It returns a list of found Monos, CCDs and SCDs.

ICLstartNotification

This private event is used to tell the ICLcommunication loop that the ICL is running and a communcation via websocket can be established

Start Module

DeviceManager.lvlib:OpenConnectionWithDevice.vi
DeviceManager.lvlib:Test DeviceManager API.vi

Stop Module

DeviceManager.lvlib:Handle Exit.vi
DeviceManager.lvlib:CloseConnectionWithDevice.vi
DeviceManager.lvlib:Test DeviceManager API.vi

ICLcommunication

Custom

Timeout

DeviceManager Request Events.Stop Module

DeviceManager Request Events.StartICL

DeviceManager Request Events.OpenWebSocketCommunication

DeviceManager Request Events.ICLshutdown

DeviceManager Request Events.SendJSONandAskForReply

DeviceManager Request Events.DiscoverDevices

DeviceManager Request Events.DevicesList

Module Not Running

0

Error information not found in the code

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

Module Not Synced

403683

%s Module was unable to synchronize events.

Request and Wait for Reply Timeout

403686

Module Name—​constant.vi

String

DeviceManager

Module Timeout—​constant.vi

I32

5000

LiveLogger.lvlib:Get Module Execution Status

LiveLogger.lvlib:Obtain Broadcast Events for Registration.vi
LiveLogger.lvlib:Start Module.vi

LiveLogger.lvlib:Hide Panel

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Show Diagram

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Show Panel

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Error Reported

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Module Did Init

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Module Did Stop

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Status Updated

LiveLogger.lvlib:Test LiveLogger API.vi

LiveLogger.lvlib:Update Module Execution Status

LiveLogger.lvlib:Test LiveLogger API.vi

horiba.lvlib

LiveLogger.lvlib:Stop Module.vi

LiveLogger.lvlib

Error Reported.vi
Module Did Init.vi
Module Did Stop.vi
Status Updated.vi
Update Module Execution Status.vi

Start Module

Launches the module Main VI. After calling this VI, you can optionally register for broadcast events from the module by wiring the broadcast events output of this VI to a Register For Events function.

After the optional Register For Events function call, you should always call the Synchronize Module Events.vi for this module with the 'Wait for Event Sync?' output of this VI to the corresponding input of the Synchronize Module Events.vi.

To see an example of the proper wiring pattern, see the "Start Module: Value Change" event frame in the API Tester VI for this module.

Stop Module

Send the Stop request to the Module’s Main.vi.

If Wait for Module to Stop? is TRUE, this VI will wait until the module main VI stops, and will timeout at the Timeout to Wait for Stop value. This value defaults to "-1", which means the VI will not timeout, and will always wait until the module main VI stops before completing execution.

Note: The Timeout to Wait for Stop value is ignored if 'Wait for Module to Stop?' is set to FALSE.

Show Panel

Send the Show Panel request to the Module’s Main.vi.

Hide Panel

Send the Hide Panel request to the Module’s Main.vi.

Get Module Execution Status

Fire the Get Module Execution Status request.

Show Diagram

This VI tells the Module to show its block diagram to facilitate troubleshooting (add probes, breakpoints, highlight execution, etc).

Module Did Init

Send the Module Did Init event to any VI registered to listen to this module’s broadcast events.

Status Updated

Send the Status Updated event to any VI registered to listen to events from the owning module.

Error Reported

Send the Error Reported event to any VI registered to listen to events from the owning module.

Module Did Stop

Send the Module Did Stop event to any VI registered to listen to this module’s broadcast events.

Update Module Execution Status

Broadcast event to specify whether or not the module is running.

Start Module

LiveLogger.lvlib:Test LiveLogger API.vi

Stop Module

LiveLogger.lvlib:Main.vi
LiveLogger.lvlib:Handle Exit.vi
LiveLogger.lvlib:Test LiveLogger API.vi

Module Not Running

0

Error information not found in the code

Module Not Stopped

403682

The Stop Module VI for the %s module timed out while waiting for the module main VI to stop. The module main VI may still be running.

Module Not Synced

403683

%s Module was unable to synchronize events.

Request and Wait for Reply Timeout

403686

Module Name—​constant.vi

String

LiveLogger

Module Timeout—​constant.vi

I32

5000

Setup Example CCD

Setup of devices for example code execution.

Teardown Example

teardown of devices for example code execution.

CCD Acquire Image

Example for a CCD spectrum acquisition.

CCD Acquire Spectrum and Abort Acquisition

Example for a CCD spectrum acquisition.

CCD Acquire Spectrum vs Pixels

Example for a CCD spectrum acquisition.

CCD Acquire Spectrum vs Wavelength

Example for a CCD spectrum acquisition.

CCD Acquire Spectrum vs Wavenumbers

Example for a CCD spectrum acquisition.

CCD Acquire Spectrum with Darkcount Subtract

Example for a CCD spectrum acquisition: Run the acquisition once with shutter open, once with shutter closed

CCD Exposure Time Control

Example on how to use the timer resolution to to achieve a exposure time in mili seconds.

CCD Get Config

Retrieve the configuration of a CCD.

Mono Filter Wheel

This example shows how to get and set the filter wheel position of the mono.

Note: this example will return an error if no internal filter is available.

Mono Get Config

This example shows how to retrieve the condifugration of the mono.

Mono Grating

This example shows how to get and set the grating position of the mono.

Mono Init

"Mono init" tells the mono to start the homing procedure. This calls completes immediately but only kicks off the homing procedure. It is necessary to query the mono afterwards to check when the homing has completed.

Mono Mirror

This example shows how to get and set the mirror position of the mono.

Mono Position

This example shows how to get and set the mirror position of the mono.

Mono Shutter

This example shows how to get and set the shutter position of the mono.

Note: this example will return an error if no internal shutter is available.

Mono Slit

This example shows how to get and set the slit width of the mono.

Setup Example Mono

Setup for the mono examples.

Teardown Examples Mono

Teardown of devices for example code execution.

Mono Full Example

Overview of the full capabilites of the monochromator.

Setup Example All Devices

Setup of devices for example code execution.

CCD Acquire Spectrum vs Wavelength Range Mode

Example for a CCD spectrum acquisition.

SCD Range Mode

Example for a SCD spectrum acquisition.

Setup Example SCD

Setup for the mono examples.

Teardown Examples SCD

Closes the connection to all connected devices and closes the ICL.

SCD Acquisition

Basic SCD acquisition example.

SCD Get Infos

Retrieve all information from the SCD.

BasicUsage

Basic Usage Example of the SCD.

CreateLogger

Example VI to create an HSE logger.

getSpeedAndGainSettings

Wrapper around the getSpeed and getGain VIs for convenience.

parse1dOr2dArray

Parse json arrays into LV arrays.

parseCcdData

Helper VI to parse the ccd data to a LV 2D image array.

parseConfigData

Helper VI to parse the configuration string to a LV cluster.

parseRangeMode

Parse center wavelengths from json array into LV array.

stitchingModeAverage

Perfroms stitching of spectra on the basis of averaging the values. Is identical to previous SDK.

stitchingModeSimple

Stitches spectra based on simple cut-off modus.

acquisitionAbort

Stops the current acquisition.

acquisitionStart

Starts an acquisition that has been set up according to the previously defined acquisition parameters.

Note: To specify the acquisition parameters please see ccd_setROI and ccd_setXAxisConversionType. If there are no acquisition parameters specified at the time of acquisition it may result in no data being generated.

calculateRangeModePositions

Finds the center wavelength positions based on the input range and pixel overlap. The following commands are prerequisites and should be called prior to using this command: ccd_setXAxisConversionType, ccd_setAcqFormat, and ccd_setRoi.

index Integer. Used to identify which CCD to target. See ccd_list command monoIndex Integer. Used to identify which mono to target for the current grating density. See mono_list command start Float. Start wavelength. end Float. End wavelength. overlap Float. Pixel overlap.

convertWavelengthToRamanShift

Convert a wavelength array to raman shift in cm-1.

DeviceClose

Closes the connection to the CCD device.

DeviceIsOpen

Checks if connection to the device is open or not.

DeviceOpen

Opens the connection to the CCD device.

getAcqCount

Gets the number of acquisition measurements to be perform sequentially by the hardware.

Return Results:

results description count Integer. The number of acquisition measurements to be performed.

getAcquisitionBusy

Gets the current busy-state of an acquisition.

getAcquisitionData

The acquisition description string consists of the following information:

acqIndex: Acquisition number roiIndex: Region of Interest number xOrigin: ROI’s X Origin yOrigin: ROI’s Y Origin xSize: ROI’s X Size ySize: ROI’s Y Size xBinning: ROI’s X Bin yBinning: ROI’s Y Bin Timestamp: This is a timestamp that relates to the time when the all the programmed acquisitions have completed. The data from all programmed acquisitions are retrieved from the CCD after all acquisitions have completed, therefore the same timestamp is used for all acquisitions. Command Parameters:

Return Results:

results description acquisition String. Acquisition data. Example command:

Example response:

{ "command": "ccd_getAcquisitionData", "errors": [], "id": 1234, "results": { "acquisition": [ { "acqIndex": 1, "roi": [ { "roiIndex": 1, "xBinning": 1, "xOrigin": 1, "xSize": 8, "xyData": [ [ 885.6389770507812, 976 ], [w 885.2899780273438, 975 ], [ 884.9409790039062, 979 ], [ 884.593017578125, 976 ], }

getAcquisitionReady

Queries the CCD for readiness for acquisition.

getChipSize

Returns the chip sensor’s pixel width and height size.

Return Results:

results description x Integer. Chip sensor’s x size in pixels (width) y Integer. Chip sensor’s y size in pixels (height)

getChipTemperature

Returns the temperature of the chip sensor in degrees C.

Return Results:

temperature Float. Chip sensor temperature in degrees C.

getCleanCount

Gets the number of cleans to be performed prior to measurement.

results description count Integer. Number of cleans. mode Integer. Specifies how the cleans will be performed. 0 = Never 1 = First Only 2 = Between Only 3 = Each

getConfig

Returns the CCD device configuration.

results description configuration JSON. CCD device configuration.

xample response:

{ "command": "ccd_getConfig", "errors": [], "id": 1234, "results": { "configuration": { "chipHSpacing": "140", "chipHeight": "70", "chipName": "S10420", "chipSerialNumber": "FAH23 098", "chipVSpacing": "140", "chipWidth": "2048", "deviceType": "HORIBA Scientific Syncerity", "fitParameters": [ 0, 1, 0, 0, 0 ], "gains": [ { "info": "Best Dynamic Range", "token": 1 }, { "info": "High Sensitivity", "token": 2 }, { "info": "High Light", "token": 0 } ], "hardwareAvgAvailable": false, "lineScan": false, "parallelSpeeds": [ { "info": "9.6 µSec", "token": 1 }, { "info": "4.9 µSec", "token": 2 }, { "info": "19 µSec", "token": 0 } ], "productId": "13", "serialNumber": "Camera SN: 5128", "signals": [ { "events": [ { "name": "Ready For Trigger", "token": 1, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] }, { "name": "Not Readout", "token": 2, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] }, { "name": "Shutter Open", "token": 3, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] }, { "name": "Start Experiment", "token": 0, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] } ], "name": "Signal Output", "token": 0 } ], "speeds": [ { "info": "500 kHz ", "token": 1 }, { "info": "500 kHz Ultra", "token": 2 }, { "info": "500 kHz Wrap", "token": 127 }, { "info": " 45 kHz ", "token": 0 } ], "supportedFeatures": { "cf_3PositionSlit": false, "cf_CMOSOffsetCorrection": false, "cf_Cleaning": true, "cf_DSP": false, "cf_DSPBin2X": false, "cf_DelayAfterTrigger": false, "cf_Delays": false, "cf_EMCCD": false, "cf_EShutter": false, "cf_HDR": false, "cf_Image": true, "cf_MemorySlots": true, "cf_Metadata": false, "cf_MultipleExposeTimes": false, "cf_MultipleSensors": false, "cf_PulseSummation": false, "cf_ROIs": true, "cf_Signals": true, "cf_Spectra": true, "cf_TriggerQualifier": false, "cf_Triggers": true" }, "triggers": [ { "events": [ { "name": "Each - For Each Acq", "token": 1, "types": [ { "name": "TTL Rising Edge", "token": 1 }, { "name": "TTL Falling Edge", "token": 0 } ] }, { "name": "Once - Start All", "token": 0, "types": [ { "name": "TTL Rising Edge", "token": 1 }, { "name": "TTL Falling Edge", "token": 0 } ] } ], "name": "Trigger Input", "token": 0 } ], "version": "Syncerity Ver 1.002.9" } } }

getDataSize

Gets the number of pixels to be returned based on the current settings.

results description size Integer. Byte data size for all ROIs and acquisitions.

getExposureTime

Gets the exposure time (expressed in Timer Resolution units).

Note: To check the current Timer Resolution value see ccd_getTimerResolution. Alternatively the Timer Resolution value can be set using ccd_setTimerResolution.

Example: If Exposure Time is set to 50, and the Timer Resolution value is 1000, the CCD exposure time (integration time) = 50 milliseconds.

If Exposure Time is set to 50, and the Timer Resolution value is 1, the CCD exposure time (integration time) = 50 microseconds.

getFitParams

Gets the FIT parameters contained in the CCD configuration for the conversion of pixel to wavelength if done via the settings contained in the CCD.

getGain

Gets the current gain token and the associated description information for the gain token. Gain tokens and their descriptions are part of the CCD configuration information. See ccd_getConfig command. For example:

"gains": [ { "info": "Best Dynamic Range", "token": 1 }, { "info": "High Sensitivity", "token": 2 }, { "info": "High Light", "token": 0 } ]

getParallelSpeed

Gets the current parallel speed token and token description. Parallel speed tokens and their descriptions are contained in the CCD configuration information. See ccd_getConfig command.

Note: The Parallel Speed value may also be referred to as the Vertical Shift Rate. These terms are interchangeable.

For example:

"parallelSpeeds": [ { "info": "9.6 µSec", "token": 1 }, { "info": "4.9 µSec", "token": 2 }, { "info": "19 µSec", "token": 0 } ],

getSignalOut

ccd_getSignalOut This command is used to get the current setting of the signal output. The address, event, and signalType parameters are used to define the signal based on the supported options of that particular CCD. The supported signal options are retrieved using the ccd_getConfig command, and begin with the "Signals" string contained in the configuration. For example:

"signals": [ { "events": [ { "name": "Shutter Open", "token": 3, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] }, { "name": "Start Experiment", "token": 0, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] } ], "name": "Signal Output", "token": 0 } ]

getSpeed

ccd_getSpeed Gets the current speed token and the associated description information for the speed token. Speed tokens and their descriptions are part of the CCD configuration information. See ccd_getConfig command. For example:

"speeds": [ { "info": "500 kHz ", "token": 1 }, { "info": "500 kHz Ultra", "token": 2 }, { "info": "500 kHz Wrap", "token": 127 }, { "info": " 45 kHz ", "token": 0 } ]

getTimerResolution

Gets the current timer resolution token.

results description resolutionToken Integer. Timer resolution token. 0 - Timer resolution is set to 1000 microseconds 1 - Timer resolution is set to 1 microsecond

getTriggerIn

This command is used to get the current setting of the input trigger. The address, event, and signalType parameters are used to define the input trigger based on the supported options of that particular CCD. The supported trigger options are retrieved using the ccd_getConfig command, and begin with the "Triggers" string contained in the configuration. For example:

"triggers": [ { "events": [ { "name": "Each - For Each Acq", "token": 1, "types": [ { "name": "TTL Rising Edge", "token": 1 }, { "name": "TTL Falling Edge", "token": 0 } ] }, { "name": "Once - Start All", "token": 0, "types": [ { "name": "TTL Rising Edge", "token": 1 }, { "name": "TTL Falling Edge", "token": 0 } ] } ], "name": "Trigger Input", "token": 0 } ]

getXAxisConversionType

Gets the X axis pixel conversion type to be used when retrieving the acquisition data with the ccd_getAcquisitionData command.

results description type Integer. The X-axis pixel conversion type to be used. 0 = None (default) 1 = CCD FIT parameters contained in the CCD firmware 2 = Mono Wavelength parameters contained in the icl_settings.ini file

restart

Performs a restart on the CCD.

setAcqCount

Sets the number of acquisition measurements to be performed sequentially by the hardware. A count > 1 is commonly referred to as "MultiAcq".

setAcqFormat

Sets the acquisition format and the number of ROIs (Regions of Interest) or areas. This command will remove all previously defined ROIs. After using this command, the ccd_setRoi command should be used to define each ROI.

parameter description numberOfRois Integer. Number of ROIs (Regions of Interest / areas) format Integer. The acquisition format. 0 = Spectra 1 = Image 2 = Crop* 3 = Fast Kinetics* * Note: The Crop (2) and Fast Kinetics (3) acquisition formats are not supported by every CCD.

setCenterWavelength

This command sets the center wavelength value and other parameters to be used in the pixel to wavelength conversion.

Note: This command should be called before ccd_setXAxisConversionType and ccd_AcquisitionStart and is only useful uf the xAxisConversion type is set to Fitparams.

setCleanCount

Sets the number of cleans to be performed according to the specified mode setting.

parameter description index Integer. Used to identify which CCD to target. See ccd_list command count Integer. Number of cleans. mode Integer. Specifies how the cleans will be performed. 0 = Never 1 = First Only 2 = Between Only 3 = Each

setExposureTime

Sets the exposure time (expressed in Timer Resolution units).

Note: To check the current Timer Resolution value see ccd_getTimerResolution. Alternatively the Timer Resolution value can be set using ccd_setTimerResolution.

Example: If Exposure Time is set to 50, and the Timer Resolution value is 1000, the CCD exposure time (integration time) = 50 milliseconds.

If Exposure Time is set to 50, and the Timer Resolution value is 1, the CCD exposure time (integration time) = 50 microseconds.

setGain

Sets the CCD gain token. A list of supported gain tokens can be found in the CCD configuration. See ccd_getConfig command. For example:

"gains": [ { "info": "Best Dynamic Range", "token": 1 }, { "info": "High Sensitivity", "token": 2 }, { "info": "High Light", "token": 0 } ]

setParallelSpeed

Sets the CCD parallel speed token. A list of supported parallel speed tokens can be found in the CCD configuration. See ccd_getConfig command.

Note: The Parallel Speed value may also be referred to as the Vertical Shift Rate. These terms are interchangeable.

For example:

"parallelSpeeds": [ { "info": "9.6 µSec", "token": 1 }, { "info": "4.9 µSec", "token": 2 }, { "info": "19 µSec", "token": 0 } ],

setRoi

Sets a single (roiIndex) ROI (Region of Interest) or area as defined by the X and Y origin, size, and bin parameters. The number of ROIs may be set using the ccd_setAcqFormat command. For Spectral acquisition format set yBin = ySize.

Note: All values must fall within the x and y limits of the chip sensor, see ccd_getChipSize. If the ROI is not valid, the device will not be properly setup for acquisition.

Command Parameters:

parameter description roiIndex Integer. The region of interest’s index (one-based) xOrigin Integer. The starting pixel in the x direction (zero-based) yOrigin Integer. The starting pixel in the y direction (zero-based) xSize Integer. The number of pixels in the x direction (one-based) ySize Integer. The number of pixels in the y direction (one-based) xBin Integer. The number of pixels to “bin” (x pixels summed to 1 value) yBin Integer. The number of pixels to “bin” (y pixels summed to 1 value)

setSignalOut

This command is used to enable or disable the signal output. When enabling the signal output, the address, event, and signalType parameters are used to define the signal based on the supported options of that particular CCD. The supported signal options are retrieved using the ccd_getConfig command, and begin with the "Signals" string contained in the configuration. For example:

"signals": [ { "events": [ { "name": "Shutter Open", "token": 3, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] }, { "name": "Start Experiment", "token": 0, "types": [ { "name": "TTL Active Low", "token": 1 }, { "name": "TTL Active High", "token": 0 } ] } ], "name": "Signal Output", "token": 0 } ]

parameter description index Integer. Used to identify which CCD to target. See ccd_list command enable Boolean. Enables or disables the signal. true = enable false = disable

Note: When disabling the signal output, the address, event, and signalType parameters are ignored. address Integer. Token used to specify where the signal is located. (e.g. 0 = Signal Output)

Note: Signal name and token can be found in the CCD config, see ccd_getConfig event Integer. Token used to specify when the signal event should occur. (e.g. 3 = Shutter Open)

Note: Event name and token can be found in the CCD config, see ccd_getConfig signalType Integer. Token used to specify how the signal will cause the event. (e.g. 0 = TTL Active High)

Note: Signal type and token can be found in the CCD config, see ccd_getConfig

setSpeed

Sets the CCD speed token. A list of supported speed tokens can be found in the CCD configuration. See ccd_getConfig command. For example:

"speeds": [ { "info": "500 kHz ", "token": 1 }, { "info": "500 kHz Ultra", "token": 2 }, { "info": "500 kHz Wrap", "token": 127 }, { "info": " 45 kHz ", "token": 0 } ]

setTimerResolution

Sets the current timer resolution token.

resolutionToken Integer. Timer resolution token. 0 - Sets the timer resolution to 1000 microseconds 1 - Sets the timer resolution to 1 microsecond

setTriggerIn

This command is used to enable or disable the trigger input. When enabling the trigger input, the address, event, and signalType parameters are used to define the input trigger based on the supported options of that particular CCD. The supported trigger options are retrieved using the ccd_getConfig command, and begin with the "Triggers" string contained in the configuration. For example:

"triggers": [ { "events": [ { "name": "Each - For Each Acq", "token": 1, "types": [ { "name": "TTL Rising Edge", "token": 1 }, { "name": "TTL Falling Edge", "token": 0 } ] }, { "name": "Once - Start All", "token": 0, "types": [ { "name": "TTL Rising Edge", "token": 1 }, { "name": "TTL Falling Edge", "token": 0 } ] } ], "name": "Trigger Input", "token": 0 } ]

setXAxisConversionType

Sets the X-axis pixel conversion type to be used when retrieving the acquisition data with the ccd_getAcquisitionData command.

Note: To use the parameters contained in the icl_settings.ini file, the ccd_setCenterWavelength command must be called first.

type Integer. The X-axis pixel conversion type to be used. 0 = None (default) 1 = CCD FIT parameters contained in the CCD firmware 2 = Mono Wavelength parameters contained in the icl_settings.ini file

Read DeviceTerm

After initialization of the device this property gives back the device term which is "ccd" for the device type CCD. This is used for prefixing all commands to the ICL.

Write DeviceTerm

Sets the device term after init.

Read DeviceType

Returns the device type of the device saved in the device firmware.

Write DeviceType

Sets the device type after init

Read Index

Returns the index of the device in the ICL layer.

Write Index

Sets the device id after init

Read productId

Returns the productID of the device saved in the device firmware.

Write productId

Sets the device productID after init

Read serialNumber

Returns the serial of the device saved in the device firmware.

Write serialNumber

Sets the device serial after init

OpenConnection

Opens a connection to the ICL via werbsocket.

CloseConnection

Closes the websocket connection.

SendAndAskForReply

Wrapper around send and receive for the websocket communication.

JSON Parse Command

Parses the original command.

JSON Parse Errors

Parses the returned error into an LV error.

JSON Parse ID

Parses the message ID to follow communication.

JSON Parse Info

Wrapper around all other VIs that parse an answer from the ICL.

JSON Parse Results

Parses the results from the ICL.

Overwrite ID

Overwrites the message ID if a custom ID is to be used for messaging to the ICL.

ReceiveJson

Receives the reply from the synchronous communication to the ICL.

SendJson

Sends the request for a synchronous communication to the ICL.

DeviceClose

Closes communications with the CCD indicated by the index.

DeviceOpen

This command initializes the CCD and gets it’s the CCD configuration from the device. The device is also connected to the API. Since a CCD hardware initialization occurs, all CCD parameters, including any previously set parameters, will be reset to their default values.

DeviceIsOpen

Returns true if selected CCD is open.

Send Receive Parse

Wrapper around the send and receive calls.

ReadDeviceJSONList

Parses the returned devies into a string array.

DecodeDeviceJSONList

Decodes the answer from the ICL into a device.

ReadDeviceTypeAsString

Return the device class name as string.

Read isOpen

Accessor VI for this class property.

Write isOpen

Accessor VI for this class property.

Read DeviceTerm

Accessor VI for this class property.

Write DeviceTerm

Accessor VI for this class property.

Read DeviceType

Accessor VI for this class property.

Write DeviceType

Accessor VI for this class property.

Read Index

Accessor VI for this class property.

Write Index

Accessor VI for this class property.

Read productId

Accesor to the product ID.s

Write productId

Accessor to the product ID.

Read SerialNumber

Accessor VI for this class property.

Write SerialNumber

Accessor VI for this class property.

setPosition

!!! Attention: this VI can potentially uncalibrate your Mono !!! !!! Only use after reading the description !!! !!! Use moveToPosition to move the mono to a different wavelength !!!

This command sets the wavelength value of the current grating position of the monochromator. This could potentially un-calibrate the monochromator and report an incorrect wavelength compared to the actual output wavelength.

wavelength Float. Set the wavelength of the mono at the current position.

getFilterWheelPosition

Returns the current filter wheel position.

parameter description index Integer. Used to identify which mono to control. See mono_list command locationId Integer. Specifies the filter wheel location. 0 = Filter wheel 1 (Internal) 1 = Filter wheel 2 (External)

moveFilterWheel

Move the filter wheel to a position.

locationId Integer. Specifies which filter wheel to move. 0 = Filter wheel 1 (Internal) 1 = Filter wheel 2 (External) position Integer. Position to move the filter wheel.

getGratingPosition

Returns the current grating turret position.

Note: Prior to the initialization of the grating turret, this value may not reflect the actual position of the turret. To read the current position of the grating turret, please run mono_init prior to running this command.

moveGrating

Moves the grating turret to the specified position.

Note: The turret sensor does not re-read the position each time it is moved, therefore the position may not be accurate prior to initialization. See note for mono_getGratingPosition.

getMirrorPosition

Returns the position of the specified mirror.

parameter description index Integer. Used to identify which mono to control. See mono_list command locationId Integer. Identifies which mirror to get the position from. 0 = Mirror 1 (Entrance) 1 = Mirror 2 (Exit)

moveMirror

Moves the specified mirror to a position.

locationId Integer. Identifies which mirror to move (zero-based). 0 = Mirror 1 (Entrance) 1 = Mirror 2 (Exit) position Integer. Position to move to. 0 = Axial 1 = Lateral

getPosition

Returns the wavelength value, in nm, of the monochromator’s current position.

moveToPosition

This command starts the monochromator moving to the requested wavelength in nm. This is an asynchronous command. Use the mono_isBusy command to know when the move has completed.

getShutterStatus

Returns the status of the currently selected shutter.

Note: To view the status of the shutter solenoid the device must be configured for internal shutter mode.

locationId Integer. Identifies the currently selected shutter. 0 = Shutter 1 (Front shutter) 1 = Shutter 2 (Side shutter) position Integer. Shutter position status. 0 = Closed 1 = Open

shutterClose

Deactivates the currently selected shutter solenoid.

Note: The device must be configured for internal shutter mode. The shutter solenoid will not respond in External (Bypass) mode.

shutterOpen

Activates the currently selected shutter solenoid.

Note: The device must be configured for internal shutter mode. The shutter solenoid will not respond in External (Bypass) mode.

getSlitPositionInMM

Returns the position of the specified slit in millimeters. The location id of each configured slit can be found under the ports section of the mono configuration. See mono_getConfig for additional information.

For example:

"ports": [ { "locationId": 1, "slitType": 1 }, { "locationId": 2, "slitType": 1 }, { "locationId": 4, "slitType": 1 } ] Note: The "locationId" parameter is 1-based.

moveSlitMM

Moves the specified slit to the position in millimeters. The location id of each configured slit can be found under the ports section of the mono configuration. See mono_getConfig for additional information.

locationId Integer. Used to identify the slit location. 1 = Front entrance (axial) 2 = Side entrance (lateral) 3 = Front exit (axial) 4 = Side exit (lateral) For example:

"ports": [ { "locationId": 1, "slitType": 1 }, { "locationId": 2, "slitType": 1 }, { "locationId": 4, "slitType": 1 } ] Note: The "locationId" parameter is 1-based.

locationId Integer. Slit location (one-based) position Float. Position in millimeters

DeviceClose

Closes communications with the monochromator indicated by the index.

DeviceIsOpen

Returns true if selected monochromator is open.

DeviceOpen

Opens communications with the monochromator indicated by the index command parameter.

getConfig

This command returns the monochromator configuration. Port Descriptions:

locationId Integer. Used to identify the slit location. 1 = Front entrance (axial) 2 = Side entrance (lateral) 3 = Front exit (axial) 4 = Side exit (lateral) slitType Integer. Used to identify the slit size. 1 = 2mm slit 2 = 7mm slit

Init

Starts the monochromator initialization process (homing…​). This is a "long-running" asynchronous command. Use the mono_isBusy command to know when initialization has completed.

force Boolean. Force starts the initialization process.

isBusy

Returns true if selected monochromator is busy.

isInitialized

This command returns true when the mono is initialized. Otherwise it returns false.

Note: This command may also return false when the mono is busy with another command.

Read DeviceTerm

Accessor VI for this class property.

Write DeviceTerm

Accessor VI for this class property.

Read DeviceType

Accessor VI for this class property.

Write DeviceType

Accessor VI for this class property.

Read Index

Accessor VI for this class property.

Write Index

Accessor VI for this class property.

Read productId

Accessor VI for this class property.

Write productId

Accessor VI for this class property.

Read serialNumber

Accessor VI for this class property.

Write serialNumber

Accessor VI for this class property.

AcqStart

Define acquisition sets before starting an acquisition. Ensure acquisition preparation is completed successfully. Starting an acquisition will return an error if:

An acquisition is already running, or Acquisition preparation has not been completed. In the event of errors in the defined parameters, the result will include an error_count field indicating the number of errors detected. use saq3_getErrorLog to get the detailed error.

Trigger Modes:

Mode description 1 - 1st data started on Start command, all subsequent data acquired based on interval time 2 - 1st data started by Trigger after start Command, all subsequent data acquired based on interval time 3 - Each data acquisition waits for Trigger

AcqStop

Stops the current acquisition. The current data point is discarded. The acquisition process must be checked and restarted if needed.

AcqPause

Pause active Acquisition. Current point is completed. Can be continued. Needs to be Stopped to start a new Acquisition. An error will be returned if a pause is received while an acquisition is not running.

AcqContinue

Restart a paused acquisition. An error will be returned if continue is received when not paused.

ForceTrigger

Software Trigger, treated the same as Hardware Trigger (IN). If no acquisition is in progress, the trigger will be ignored.

DeviceClose

Closes communications with the CCD indicated by the index.

DeviceOpen

Opens communications with the SpectrAcq3 indicated by the index command parameter.

DeviceIsOpen

Returns true if selected SpectrAcq3 is open.

IsDeviceBusy

Checks whether the instrument is busy (e.g., performing initialization or data acquisition).

GetFirmwareVersion

Get the firmware version of the device for the given index.

GetFpgaVersion

Get the FPGA version of the device for the given index.

GetBoardRevision

Get the Board revision of the device for the given index.

GetSerialNumber

Get the serial number of the device for the given index.

SetHvBiasVoltage

Set the High bias voltage in Volts. If not set then default value will be used.

GetHvBiasVoltage

Gets the integration time that was previously set. If no integration time has been explicitly set, the default value is returned. The integration time is returned in seconds.

GetMaxHVVoltageAllowed

Gets the integration time that was previously set. If no integration time has been explicitly set, the default value is returned. The integration time is returned in seconds.

GetAcqSet

Get the acquisition set parameters. scan_count Number of acquisition to perform time_step Interval between successive scans for time based scan in seconds. If 0/not defined, the scans take place as fast as possible (limited by integration time and monochromator move if applicable) integration_time Integration time in seconds external_param User defined value

SetAcqSet

Defines and sends the parameters for the acquisition set to perform the acquisition. If the acquisition set is not defined, a single-point scan with default settings is performed. Parameters that are not explicitly defined are set to their default values. Parameters to define for the acquisition

Scan Count : Number of acquisitions to perform Time Steps : Time interval in seconds between acquisitions Integration time: Time in Seconds External user defined parameter Returns an error if an acquisition is already in progress.

IsDataAvailable

Check whether the acquired data is available.

GetAvailableData

Check whether the acquired data is available.

SetInTriggerMode

Tell the device how Hardware Trigger pin is used. Returns Error if Acquisition is in Progress.

mode: Mode of hardware trigger pin. 0: TTL input 1: Event marker input 2: Hardware trigger input

GetTriggerMode

Gets the integration time that was previously set. If no integration time has been explicitly set, the default value is returned. The integration time is returned in seconds.

GetLastError

Gets the integration time that was previously set. If no integration time has been explicitly set, the default value is returned. The integration time is returned in seconds.

GetErrorLog

Gets the integration time that was previously set. If no integration time has been explicitly set, the default value is returned. The integration time is returned in seconds.

Read DeviceTerm

Accessor VI for this class property.

Write DeviceTerm

Accessor VI for this class property.

Read DeviceType

Accessor VI for this class property.

Write DeviceType

Accessor VI for this class property.

Read Index

Accessor VI for this class property.

Write Index

Accessor VI for this class property.

Read productId

Accessor VI for this class property.

Write productId

Accessor VI for this class property.

Read serialNumber

Accessor VI for this class property.

Write serialNumber

Accessor VI for this class property.