Differences

This shows you the differences between two versions of the page.

--- compact_ice:manual [2022/08/08 22:09] – external edit 127.0.0.1
+++ compact_ice:manual [2022/08/26 23:43] (current) – external edit 127.0.0.1
@@ Line 12: / Line 12: @@
 Click here for the [[compact_ice:API|Compact ICE API]].\\
 Click here for the [[https://vescent.com/us/heterodyne-agile-laser-hal.html|Compact ICE/HAL Webpage]].\\
+Click here for the [[https://vescent-my.sharepoint.com/personal/kknabe_vescent_com/_layouts/15/onedrive.aspx?id=%2Fpersonal%2Fkknabe%5Fvescent%5Fcom%2FDocuments%2FSoftware%2F20220826%20Compact%20ICE%20GUI&ga=1|Unsupported Compact ICE GUI]]
 =====Description=====
 <imgcaption compact_ice_prod_shot|The Compact ICE and HAL modules>{{ :compact_ice:compact_ice.png?200|}}</imgcaption>
@@ Line 78: / Line 78: @@
 <imgcaption physical_connections|Diagram of the Compact ICE showing connections>
-{{ :compact_ice:connections.png?400 |}}</imgcaption>
+{{ :compact_ice:connections.png?600 |}}</imgcaption>
 The baseplate comes with four size #6/M3.5 through-hole connectors for bolting down the Compact ICE. There is one optical fiber (PM FC/APC) output for the light from the follower laser.
+<imgcaption mechanicals|Mechanical Dimensions of Compact ICE/HAL.>{{ :compact_ice:mechanicals.png?600 |}}</imgcaption>
-<imgcaption mechanicals|Mechanical Dimensions of Compact ICE/HAL.>{{ :compact_ice:mechanicals.png?400 |}}</imgcaption>
@@ Line 106: / Line 105: @@
 <WRAP center round box 60%><tabcaption TEC_pinout |SOA TEC Pinout>
+| **Connector\\ Pin Number**  | **Function**  |
+| 1                           | TEC (+)   |
+| 2                           | TEC (-)   |
+| 3                           | RTH (+)   |
+| 4                           | RTH (-)   |
+</tabcaption></WRAP>
+------
+<imgcaption TEC|Molex TEC Connector>{{ :compact_ice:pinout_for_molex_connector.png?200 |}}</imgcaption>
+<WRAP center round box 60%><tabcaption TEC_pinout |Molex TEC Pinout>
 | **Connector\\ Pin Number**  | **Function**  |
 | 1                           | TEC (+)   |
@@ Line 140: / Line 152: @@
 ====Connecting to the GUI====
-While use of the GUI is not recommended, it can be a helpful tool in operation of Compact ICE. To connect to the GUI, launch the application from the ICE Control folder on your desktop. A terminal window will open, and it may take a few minutes for the GUI to open. Once the GUI is open, select the appropriate COM port from the dropdown menu at the top, and press "Connect". You will know you are connected if the numbers on the side bar corresponding to the installed cards light up.
+While use of the GUI is not recommended for data acquisition or critical operations, it can be a helpful tool for familiarizing oneself with the system and for experimental set up. To connect to the GUI, launch the application from the ICE Control folder on your desktop. A terminal window will open, and it may take a few minutes for the GUI to open. Once the GUI is open, select the appropriate COM port from the dropdown menu at the top, and press "Connect". You will know you are connected if the numbers on the side bar corresponding to the installed cards light up.
 <imgcaption gui|The Compact ICE GUI home screen before connecting to a device.>{{ :compact_ice:connect_gui.png?400 |}}</imgcaption>
@@ Line 146: / Line 158: @@
 API commands can also be sent through the field on the bottom of the GUI which reads "Enter Command". If entering commands in this way, it may be necessary to refresh the GUI page by navigating to a different tab, and then back to see updates.
 ====Powering On Compact ICE====
-After connecting the power supply to Compact ICE and turning it on, the "power" LED next to the connector will either turn, or begin flashing green. If a solid green light is present, this indicates that Compact ICE is powered on and ready to receive commands. If the light is flashing, Compact ICE is receiving power, but is not yet powered on and must be activated using the ''#PowerOn'' API command. The setting which controls whether Compact ICE boots immediately (Auto Turn On) can be configured via the ''#AutoPower True/False'' serial command. ''#AutoPower True'' will cause Compact ICE to boot immediately after receiving power from the power supply, giving the solid green light upon activation.
+After connecting the power supply to Compact ICE and turning it on, the "power" LED next to the connector will either turn, or begin flashing green. If a solid green light is present, this indicates that Compact ICE is powered on and ready to receive commands. If the light is flashing, Compact ICE is receiving power, but is not yet powered on and must be activated using the ''#PowerOn'' API command. The setting which controls whether Compact ICE boots immediately (Auto Turn On) can be configured via the ''#AutoPower <True/False>'' serial command, where <> denotes an argument and should not be included in the actual command . ''#AutoPower True'' will cause Compact ICE to boot immediately after receiving power from the power supply, giving the solid green light upon activation.
-If using the GUI, it is necessary to turn Compact ICE on with the "Turn Power On" button that appears next to the "Connect" button after connecting.
+If using the GUI, it is necessary to turn Compact ICE on with the "Turn Power On" button that appears next to the "Connect" button after connecting. This particular API command cannot be sent through the GUI to turn Compact ICE on.
 <imgcaption turn_power_on|The "Turn Power On" button is located next to the "Connect" button on the GUI.>{{ :compact_ice:turn_power_on.jpg?400 |}}</imgcaption>
@@ Line 166: / Line 178: @@
 ====Temperature Control====
-After powering up Compact ICE and setting up the terminal for sending commands, the first thing to do is temperature control all components of the system. Temp controls are found on board 4, and there are 4 channels which can be controlled. Channel 2 controls the temperature of the HAL package (the case), Channel 3 controls the temperature of the Master Laser, Channel 4 controls the temperature of the Follower Laser, and Channel 5 controls the temperature of the Vapor Cell with the atomic reference. Channel 1 is left open for control of an external SOA through the SOA TEC connector.
+After powering up Compact ICE and setting up the either the terminal or the GUI for sending commands, the first thing to do is temperature control all components of the system. Temperature controls are found on board 4, and there are 5 channels which can be controlled. Channel 2 controls the temperature of the HAL package (the case), Channel 3 controls the temperature of the Master Laser, Channel 4 controls the temperature of the Follower Laser, and Channel 5 controls the temperature of the Vapor Cell with the atomic reference. Channel 1 is left open for control of an external SOA through the SOA TEC connector.
@@ Line 179: / Line 191: @@
 </tabcaption></WRAP>
-The temperatures of all components are preset on shipment. In case the temperature drifts, it is possible to set the temperature of each channel with the ''TEMPSET <ch> <temp>'' command, where "<ch>" is the channel you wish to set the temperature of, and <temp> is a floating point temperature. To check the temperature of a channel, use the ''TEMPSET? <ch>'' command. Always check the temperature setpoint of a channel before turning it on. To enable the temperature servo on a channel, send the ''SERVO <ch> <ON/OFF>'' command. Do this for all channels after checking their setpoint temperature. It is imperative that the temperature servos be enabled before current is sent to the lasers. The ''TERROR? <ch>'' command can be used to monitor the progress of the temperature servo. It will display the difference between the setpoint temperature and the measured actual temperature of the channel in mK. This value reaches a maximum at 0.264mK and a minimum at -0.261
+The temperatures of all components are preset on shipment. In case the temperature drifts, it is possible to set the temperature of each channel with the ''TEMPSET <ch> <temp>'' command, where "<ch>" is the channel you wish to set the temperature of, and <temp> is a floating point temperature. To check the temperature of a channel, use the ''TEMPSET? <ch>'' command. Always check the temperature setpoint of a channel before turning it on. To enable the temperature servo on a channel, send the ''SERVO <ch> <ON/OFF>'' command. Do this for all channels after checking their setpoint temperature. It is imperative that the temperature servos be enabled before current is sent to the lasers. The ''TERROR? <ch>'' command can be used to monitor the progress of the temperature servo. It will display the difference between the setpoint temperature and the measured actual temperature of the channel in mK. This value reaches a maximum at 0.264mK and a minimum at -0.261. Outside of this range, it will only display the appropriate maximum or minimum value.
 <imgcaption temp_controls|A GUI representation of the Temperature Control Board with a plot of TERROR showing Ch 2 temperature stabilized and Ch 1 off.>{{ :compact_ice:temperature_control.png?400 |}}</imgcaption>
@@ Line 185: / Line 197: @@
 The temperature of the lasers should always be between 15°C and 30°C. Damage to the lasers may occur if their temperature is set outside of this range.
-To temperature control Compact ICE through the GUI, navigate to slot 4 by clicking on it in the menu bar on the left-hand side of the screen. The temperature channel can be selected with the buttons at the top of the screen labeled "CH" (1 & 2 | 3 & 4 | 3 & 5), and values can be entered directly into any field with white text. To Enable the servo, press the "Servo On/Off" button. Minimum temperature, maximum temperature, and gain can be adjusted through the vertical bar on the right.
+To temperature control Compact ICE through the GUI, navigate to slot 4 by clicking on it in the menu bar on the left-hand side of the screen. The temperature channel can be selected with the buttons at the top of the screen labeled "CH" (1 & 2 | 3 & 4 | 3 & 5), and values can be entered directly into any field with white text. To Enable the servo, press the "Servo On/Off" button. Minimum temperature, maximum temperature, and gain can be adjusted through the vertical "Options" bar on the right.
 ====Enabling Lasers====
@@ Line 193: / Line 205: @@
-These actions can also be performed through the GUI. The current limit can be typed directly into the field below "Current Limit (mA)", and the current supplied to the laser can either be selected by dragging the orange bar around the dial, or by typing a value directly into the field in the center. Note that, when dragging the bar, the value does not update until the bar is released. These values may be slightly changed by the digitization scheme when entered.
+These actions can also be performed through the GUI. As with the Temperature Control board, any field with white text can have values entered directly. The current limit can be set through the field below "Current Limit (mA)", and the current supplied to the laser can either be selected by dragging the orange bar around the dial, or by typing a value directly into the field in the center. Note that, when dragging the bar, the value does not update until the bar has been released. These values may be slightly changed by the digitization scheme when entered.
 ====Locking to the Atomic Reference====
 Navigate to the Peak Lock Board in slot 1. If the master laser has not yet been enabled, do so now by checking the current limit and current setpoint of the laser using ''CURRLIM?'' and ''CURRSET?'' respectively. Then enable the laser with the ''LASER ON'' command. Once the laser is enabled, turn on the ramp with the ''RAMPRUN ON'' command and look for spectroscopy. If your ramp sweep range is too low, it can be changed with ''RAMPSWP <V>'' where the ramp will sweep from -"<V>" to +"<V>". To find the transition, change either the temperature of the laser, the current being delivered to the laser, or the servo offset. Temperature will give you the largest range of control and is best used for locating the transition. Servo offset gives the finest control, and is best used for lining up the particular transition you wish to lock to. Once the transition is lined up, the servo can be enabled using ''SERVO ON''. On the GUI, the servo will lock to whichever transition is centered on the vertical line in the middle of the plot.
@@ Line 199: / Line 211: @@
 <imgcaption servo|A GUI representation of the Peak Lock Board.>{{ :compact_ice:line_up_spectroscopy.png?400 |}}</imgcaption>
-If the servo doesn't lock, it might be because of your gain settings. To change those, use the ''GAIN <#>'' command. For more information on locking Compact ICE through the GUI, follow [[ice:ice_quickstart_guide  #Locking_a_Laser_to_Spectroscopy|this guide]] for ICE.
+If the servo doesn't lock, it might be because of your gain settings. To change those, use the ''GAIN <#>'' command. For more information on locking Compact ICE through the GUI, follow [[ice:ice_quickstart_guide  #Locking_a_Laser_to_Spectroscopy|this guide]] which was written for ICE, but is the same for Compact ICE.
 ====Offset Phase Locking====