User Tools

Site Tools


compact_ice:manual

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
compact_ice:manual [2022/08/08 22:04] – external edit 127.0.0.1compact_ice:manual [2022/08/08 22:47] – external edit 127.0.0.1
Line 140: Line 140:
  
 ====Connecting to the GUI==== ====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> <imgcaption gui|The Compact ICE GUI home screen before connecting to a device.>{{ :compact_ice:connect_gui.png?400 |}}</imgcaption>
Line 146: Line 146:
 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. 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==== ====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. 
 +
 +<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>
 ====General Commands/Navigation==== ====General Commands/Navigation====
 Compact ICE comes with 5 separate boards each with their own set of commands, and a master board which handles general commands and navigation between the boards. When Compact ICE initially boots, it is necessary to first switch to the board you wish to send commands to. This can be done with the ''#slave <#>'' command, where '<#>' should be replaced with the number of the board you wish to communicate with. Compact ICE comes with 5 separate boards each with their own set of commands, and a master board which handles general commands and navigation between the boards. When Compact ICE initially boots, it is necessary to first switch to the board you wish to send commands to. This can be done with the ''#slave <#>'' command, where '<#>' should be replaced with the number of the board you wish to communicate with.
Line 183: Line 185:
 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.  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 & 23 & 43 & 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 bar on the right.
  
 ====Enabling Lasers==== ====Enabling Lasers====
compact_ice/manual.txt · Last modified: 2022/08/26 23:43 by 127.0.0.1