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/01/13 22:16] – 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 27: | Line 29: | ||
< | < | ||
- | < | + | < |
- | Returns the internal reference’s oscillator’s frequency in Hz. | + | Returns the internal reference’s oscillator’s frequency in MHz. |
< | < | ||
- | < | + | < |
- | Sets the internal reference oscillator’s frequency to FREQ, where FREQ is a the frequency in Hz. Returns the output of the **IntFreq? | + | Sets the internal reference oscillator’s frequency to FREQ, where FREQ is a the frequency in MHz. Returns the output of the **IntFreq? |
< | < | ||
Line 59: | Line 61: | ||
< | < | ||
- | < | + | < |
Returns the voltage measured on channel CHANNEL (in volts). The channels refer to: | Returns the voltage measured on channel CHANNEL (in volts). The channels refer to: | ||
- Servo Out | - Servo Out | ||
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 value is rounded and truncated to match range of the servo offset. // | ||
< | < | ||
- | < | + | < |
- | 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 to keep step size constant despite quantization of the servo output.// | + | |
< | < | ||
- | < | + | < |
- | Reads the number of data points | + | Begins ramping |
< | < | ||
+ | |||
+ | < | ||
+ | Returns two columns of data. First column is a number 1-5 representing the integrator pole value. Values are 3 kHz, 10 kHz, 30 kHz, 100 kHz and 300 kHz. 1 is the slowest integrator (3 kHz), and 5 is the fastest (300 kHz). The second column is a number 0 - 4 representing differential pole value. Values are Off, 10 kHz, 30 kHz, 100 kHz and 300 kHz. 0 is is no differential pole (Off), 1 is the slowest pole setting (10 kHz) and 4 is the fastest pole setting (300 kHz). | ||
+ | |||
+ | < | ||
+ | |||
+ | < | ||
+ | Sets the integrator and differential pole positions. INTEGRATOR is a value from 1-5 corresponding to 3 kHz (1) up to 300 kHz (5). DIFFERENTIAL is a value from 0-4 with 0 disabling differential, | ||
+ | < | ||
+ | |||
+ | < | ||
+ | Reads the event address for jumping the offset phase lock frequency. Address range is 0-7 where address 0 is no event. | ||
+ | < | ||
+ | |||
+ | < | ||
+ | Sets the event address for jumping the offset phase lock frequency. Address range is 0-7 where address 0 is no event. | ||
+ | < | ||
+ | |||
+ | |||
+ | < | ||
+ | Reads the event address for turning the laser off. Address range is 0-7 where address 0 is no event. | ||
+ | < | ||
+ | |||
+ | < | ||
+ | Sets the event address for turning the laser off. Address range is 0-7 where address 0 is no event. | ||
+ | < | ||
+ | |||
+ | < | ||
+ | <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 | ||
+ | |||
+ | |||
+ | 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 | ||
+ | ^ 0 | 8 | Off | Off | | ||
+ | ^ 1 | 8 | Off | On | | ||
+ | ^ 2 | 8 | On | Off | | ||
+ | ^ 3 | 8 | On | On | | ||
+ | ^ 4 | 16 | Off | Off | | ||
+ | ^ 5 | 16 | Off | On | | ||
+ | ^ 6 | 16 | On | Off | | ||
+ | ^ 7 | 16 | On | On | | ||
+ | ^ 8 | 32 | Off | Off | | ||
+ | ^ 9 | 32 | Off | On | | ||
+ | ^ 10 | 32 | On | Off | | ||
+ | ^ 11 | 32 | On | On | | ||
+ | ^ 12 | 64 | Off | Off | | ||
+ | ^ 13 | 64 | Off | On | | ||
+ | ^ 14 | 64 | On | Off | | ||
+ | ^ 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. | ||
+ | < | ||
+ | |||
+ | < | ||
+ | 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, | ||
+ | < | ||
+ | |||
+ | < | ||
+ | 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