ice:commands:opls
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
| ice:commands:opls [2014/06/20 17:47] – Clean up Event Jump Data command to use lookup table instead of math for user. Ben Luey | ice:commands:opls [2017/10/26 22:16] – Michael Radunsky | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| List of commands for the ICE Offst PHase Lock and Current Controller. Please see [[ice: | List of commands for the ICE Offst PHase Lock and Current Controller. Please see [[ice: | ||
| + | |||
| + | The theory, usage, and performance of the ICE-CP1 can be [[ice: | ||
| < | < | ||
| Line 72: | Line 74: | ||
| < | < | ||
| - | < | + | < |
| - | Reads the starting voltage | + | Reads the sweep range (in volts) |
| < | < | ||
| - | < | + | < |
| - | Writes the starting voltage | + | Writes the sweep range (in volts) |
| + | \\ | ||
| + | //Note: RampSwp | ||
| < | < | ||
| - | < | + | < |
| - | Reads the ending voltage | + | Returns |
| + | |||
| + | Note that the amount of bytes stored by the ramp is 2*RampNum. The amount of bytes stored set how much data needs to be read back via the **ReadBlk** command. | ||
| < | < | ||
| - | < | + | < |
| - | Writes | + | Sets the number of data points to be acquired during |
| - | \\ | + | |
| - | //Note: RampEnd value is rounded up to be consistent with the **RampInc** value.// | + | |
| < | < | ||
| - | < | + | < |
| - | Reads the increment step size of the ramp. Multiply | + | Begins ramping |
| < | < | ||
| - | < | + | < |
| - | Sets the increment step size of the ramp. Multiply | + | Returns two columns |
| < | < | ||
| - | < | + | < |
| - | Returns | + | Sets the integrator and differential pole positions. INTEGRATOR is a value from 1-5 corresponding |
| + | < | ||
| - | $$ \frac{RampEnd-RampBeg}{3.05\cdot 10^{-4} \times RampStep} $$ | + | < |
| + | Reads the event address for jumping the offset phase lock frequency. Address range is 0-7 where address 0 is no event. | ||
| + | < | ||
| - | Note that the amount of bytes stored by the ramp is 2*RampNum. The amount of bytes stored set how much data needs to be read back via the **ReadBlk** command. | + | < |
| + | Sets the event address for jumping | ||
| + | < | ||
| - | RampNum returns 0 if there is a configuration error (ramp increment larger than ramp range) or if number of data points exceeds storage capacity on device, which is 3072 bytes. | ||
| + | < | ||
| + | Reads the event address for turning the laser off. Address range is 0-7 where address 0 is no event. | ||
| < | < | ||
| - | < | + | < |
| - | Begins ramping | + | Sets the event address |
| < | < | ||
| + | < | ||
| + | <WRAP center round important 100%> | ||
| + | This function only works as described with firmware 2.3 and higher. If using an older firmware, please upgrade to the latest firmware before using this function. | ||
| + | </ | ||
| + | |||
| + | Loads data into the event system for jumping the offset phase lock frequency when a jump frequency event is received. The **ROW** sets when this frequency jump will be engaged; **ROW**=1 means the first event will trigger this jump value. **ROW**=3 will run on the 3rd event. Events loop back based on the number of event points (set by the EVTNUM command), so if there are 5 event points, then the **ROW** that is jumped will be sequentially: | ||
| + | |||
| + | The **COLUMN** sets the column of data to be written. Column 0 sets the **MODE** (see below for explanation). Column 1 sets the reference frequency. Column 2 sets the amount of feedforward to jump the servo output to help the servo quickly acquire lock at the new offset frequency. | ||
| + | |||
| + | The data table for storing the settings looks like the following: | ||
| + | |||
| + | ^ ^ Columnn 0 (Mode) | ||
| + | ^ Row 1 | ||
| + | ^ Row 2 | 5 | 88.43 | -0.23 | | ||
| + | ^ Row 3 | 9 | 105.28 | ||
| - | < | ||
| - | Loads data into the event system for jumping the offset phase lock frequency when a jump frequency event is received. The **ELEMENT NUMBER** sets when this frequency jump will be engaged; **ELEMENT NUMBER**=1 means the first event will trigger this jump value. **ELEMENT NUMBER**=3 will run on the 3rd event. Events loop back based on the number of event points (set by the EVTNUM command), so if there are 5 event points, then the **ELEMENT NUMBER** that is jumped will be sequentially: | ||
| The **MODE** sets the whether to invert the error signal, whether to use the internal or external frequency reference and the N value. Below is a table showing the different modes: | The **MODE** sets the whether to invert the error signal, whether to use the internal or external frequency reference and the N value. Below is a table showing the different modes: | ||
| + | |||
| ^ Mode ^ N ^ Invert | ^ Mode ^ N ^ Invert | ||
| Line 137: | Line 164: | ||
| ^ 15 | 64 | On | On | | ^ 15 | 64 | On | On | | ||
| + | The command returns SUCCESS if the data is successfully enter, FAIL if not. Data loaded is saved to memory with the **SAVE** command. | ||
| + | < | ||
| - | **FREQUENCY REFERENCE** is the value of the internal frequency reference. | + | < |
| + | Reads the number of offset phase lock values to loop through via the offset phase lock jump event system. Range from 2 - 8. If set to 4, then the sequence of offset phase lock values will be 1, | ||
| + | < | ||
| - | The command returns SUCCESS if the data is successfully enter, FAIL if not. Data loaded is saved to memory with the **SAVE** command. | + | < |
| + | Sets the number of offset phase lock values to loop through via the offset phase lock jump event system. Range from 2 - 8. If set to 4, then the sequence of offset phase lock values will be 1, | ||
| + | < | ||
| + | < | ||
| + | Return the next row that the will be read from the Event Jump Table when the device gets an event matching the event set with the **EvtJUMP** command. | ||
| < | < | ||
| + | |||
| + | < | ||
| + | Reads back the data in the Jump Table, using the ROW and COLUMN to set what datapoint to read back. See **EvtData** for more details. | ||
| + | < | ||
| + | |||
| + | |||
ice/commands/opls.txt · Last modified: 2023/11/30 21:32 by 127.0.0.1