NIS-Elements: Incubator Interface This document specifies the set up details of the Incubator Module, # 97173. This documentation assumes some familiarity with Nikon NIS-Elements software as well as general knowledge of PC Windows environment.

Note number: 0001 Creation Date: 5/2011 Date Modified: Software Version: 3.22.11 NIS-Elements Build: 728 Package: AR or Br + 4D + API

The Incubator module is an NIS-Elements plug-in that controls several OKO incubator devices [H201, H310, CO2 Controller, O2 Controller]. The main functions for this module are controlling incubator hardware and automatically record incubator information during an ND Experiment with in the ND2 file itself. Installation Installation: There are two separate installations: an installation for 32-bit Windows 7 Operating Systems and an installation for 64-bit Windows 7 Operating System.

To install the macro module, select the appropriate installer, 64 bit or 32 bit, depending on the operating system. Each zip file contains an installer (.msi file) and a setup.exe. Double click and run the file „setup.exe‟ from the corresponding folder. The installation will display a sequence of dialogs. Click the „Close‟ button on the last dialog to complete the installation. To verify the installation has been completed successfully, open the Windows Control Panel->Programs and Features. The macro module will be listed under „Currently installed programs:‟ as shown below:

1

-1-

NIS-Elements Configuration It is required to have the OKO software, which is delivered via the installation to C:\Program Files\Nikon\Shared\Drivers\OKO, installed and configured prior to running the Incubator Module in NIS-Elements. Installing and Configuring OKO Software The installation of the Incubator Module it is necessary to install and configure the OKO software. At this time the user will provide the serial number and license code provided by OKO to unlock hardware communication. The hardware devices should be Off and connected via serial port to the controlling PC prior to configuring the OK software. 1. Go to C:\Program Files\Nikon\Shared\Drivers\OKO and run setup.exe as administrator.

2. The installation will display a sequence of dialogs.

3. Ensure that the OKO software installs in its default location. (C:\Program Files (x86)\OKOlab\OKO-Control 2010 for 64-bit, for 32-bit C:\Program Files\OKOlab\OKO-Control 2010)

4. Ensure that “Launch OKO-Control 2010” checkbox is enabled. Turn the hardware devices On. Press „Finish‟ button.

5. The OKO software will then prompt the user for the serial number and activation. Enter the values that are provided by the manufacturer. Press „OK‟ button when complete.

6. The OKO will prompt the user that there is “No valid configuration. Please configure OKO-Control.” Press „OK‟ button.

7. The user will be automatically brought to the OKO Configuration Dialog.

8. Select the hardware that will be connected and configured.

9. Select the Serial Port number that the device is connected to.

10. Press „Connect‟ button.

11. Repeat Steps 8 – 10 until all hardware devices are connected and configured.

12. Press „Save‟ Button

13. Close OKO software. Opening and Running Incubator Module in NIS-Elements To launch the Incubator macro for the first time, load the Incubator.mac by opening the Macro Menu  and select the „Run Macro From File…‟ option. Next browse for the Incubator.mac located in “C:\Program Files\Nikon\Shared\Macros” directory, and then press the „Open‟ button.

Once the Incubator Module is loaded, it can be view at anytime by right clicking and selecting Acquisition->Incubator.

Overview of Incubator Module One of the key functions of the Incubator Module, in addition to controlling the hardware, is to automatically record incubator reading during an ND time lapse experiment within the ND2 file itself. There are several options that allow for the user to specify valid conditions of the incubator for the ND Experiment. The enforcement of these conditions allows the Incubator Module to control the ND Experiment. The Incubator Module is designed to be flexible. It can control several different Incubator related hardware devices and record their readings simultaneously. Terminology: Here are the terms used in this document and the macro dialog: Sprite o A visual representation of temperature sensor or gauge

Icon image o The shape of visual representation that corresponds to either a temperature sensor or a gauge.

Present Value o The current reading of the temperature sensor or gauge o Present value is always white and appears to the left of the image icon.

Set Value o The value that the device is aiming to achieve. o Set Value is always orange and appears to the left of the icon image.

Maximum Range Value o The defined acceptable upper limit o The value is determined by Set Value + Deviation Range. o Maximum Range Value is always red and appears to the right of the image icon. o Only visible in Use in Experiment Mode

Minimum Range Value o The defined acceptable lower limit o The value is determined by Set Value - Deviation Range. o Minimum Range Value is always blue and appears to the right of the image icon. o Only visible when Use in Experiment radio button is selected

Incubation Interface Explained : Manual Mode Manual Mode gives control of the incubator to the user in real time. When a value is entered and then the Set button is pressed, the incubator will start the process to meet the new Set Value. There are several visual indicators built into the Incubator Interface. These visual indicators are designed to quickly convey the current state of the incubator to the user. The color of sprite conveys information. 1. Gray – Currently there is no Set Value. ** In this state the incubator will be attempting to achieve the last Set value. 2. Red – the Present Value is higher than the Maximum Range Value. 3. Green – the Present Value is within the Minimum Range Value and the Maximum Range Value. 4. Blue – the Present Value is lower than Minimum Range Value.

No action is taken when the sprite changes color. A user can decide to not control a particular temperature sensor or gauge. To disable control, make sure the check box with the name of the sprite is not checked. When control is disabled, it will appear an inverted gray (the light on bottom and darkest on top) and the Set Value Text box and button will be disabled.

Disabling control will not turn the temperature sensor or gauge off. It will still attempt to drive to the last Set Value. Disabling control merely prevents the incubator from receiving new Set Values.

Incubation Interface Explained : Use in Experiment Mode The use in experiment mode gives the tools that allow the conditions for the incubator to be set for the ND experiment. Values entered will only apply to the selected phase of an ND experiment and will not effect what the current Set Value is. (Setting a value will not change the “Live” Set Value.)

Phase – The ND time-lapse phase number that the Use in Experiment incubator conditions will be applied to during the ND Acquisition. Phase can be either a specific Phase number or All. Apply to ND Button – Tells the incubator module to insert its control into the ND Experiment. This is the last step after all desired conditions have been set and before the „Run Now‟ button in ND Experiment is pressed. Ready for ND Experiment Indicator – This indicator will appear green when the incubator has inserted its control into the ND Experiment. *

* This indicator will remain green even after the user has changed parameters. It is the user‟s responsibility to press Apply to ND to update the incubator settings prior to running the ND Experiment. Save Settings Button – Saves all the current Use in Experiment conditions to an XML for later use. Load Settings Button – Loads Use in Experiment settings previously saved XML settings file. Incubation Interface Explained : Use in Experiment Mode : Advanced The „Advanced Enabled.

5. Select Tools->Server->Remote Mode

The OKO server will automatically minimize. 6. Restart NIS-Elements 7. Restart Incubator Module.

Behavior: All the hardware has been successfully configured with the OKO software and has been successfully controlled in the past, but every time the Incubator Module is initially started, not all the hardware shows up in the Main Incubator GUI. 1. Confirm that the USB to Serial connectors are the ones provided by the manufacture. The USB to Serial connectors provided by the manufacturer are FTDI compliant. Non FTDI compliant USB to Serial connections cause an initial time out, which causes the module to believe that the device is not connected. Follow the trouble shooting tip list above for a temporary solution or use the manufacturer provided USB to Serial connectors.