ice:commands:opls
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| ice:commands:opls [2014/03/17 16:41] – Fixed intfreq to be in MHz jtshugrue | ice:commands:opls [2023/11/30 21:32] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| 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: |
| + | |||
| + | < | ||
| Returns the value of the N divider. | Returns the value of the N divider. | ||
| - | < | ||
| - | < | + | < |
| Set the value of the N divider. Valid settings are 8,16,32 and 64. Returns output from **N?** command. | Set the value of the N divider. Valid settings are 8,16,32 and 64. Returns output from **N?** command. | ||
| - | < | ||
| - | < | + | < |
| Returns whether the error signal is being inverted or not. | Returns whether the error signal is being inverted or not. | ||
| - | < | ||
| - | < | + | < |
| Turns on or off inverting the error signal. Effectively changes the gain sign of the loop and whether the slave laser will be to the red or blue of the master laser. Returns output of **Invert?** Command. | Turns on or off inverting the error signal. Effectively changes the gain sign of the loop and whether the slave laser will be to the red or blue of the master laser. Returns output of **Invert?** Command. | ||
| - | < | ||
| - | < | + | < |
| Returns if the internal reference oscillator is active (as opposed to using an external reference). | Returns if the internal reference oscillator is active (as opposed to using an external reference). | ||
| - | < | ||
| - | < | + | < |
| Enables or disables using the internal reference (instead of external reference). Returns output of **IntRef?** command. | Enables or disables using the internal reference (instead of external reference). Returns output of **IntRef?** command. | ||
| - | < | ||
| - | < | + | < |
| Returns the internal reference’s oscillator’s frequency in MHz. | 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 MHz. 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? | ||
| - | < | ||
| - | < | + | < |
| Returns the status of the laser servo (on or off). | Returns the status of the laser servo (on or off). | ||
| - | < | ||
| - | < | + | < |
| Turns on the laser servo (engages the integrator). Returns the output of the command **Servo?**. | Turns on the laser servo (engages the integrator). Returns the output of the command **Servo?**. | ||
| - | < | ||
| - | < | + | < |
| Returns Servo Gain. Range is from 0-64 in steps of 2 dB. 0 is a special gain setting where there is no gain (error signal does not go to integrator). | Returns Servo Gain. Range is from 0-64 in steps of 2 dB. 0 is a special gain setting where there is no gain (error signal does not go to integrator). | ||
| - | < | ||
| - | < | + | < |
| Sets the Servo Gain. Range is from 0-28 in steps of 2 dB. 0 is a special gain setting where there is no gain (error signal does not go to integrator). Returns the output of the command **GetGain? | Sets the Servo Gain. Range is from 0-28 in steps of 2 dB. 0 is a special gain setting where there is no gain (error signal does not go to integrator). Returns the output of the command **GetGain? | ||
| - | < | ||
| - | < | + | < |
| Returns Servo Offset voltage (in volts). When the servo is engaged, this voltage is the starting voltage that the servo integrates from. | Returns Servo Offset voltage (in volts). When the servo is engaged, this voltage is the starting voltage that the servo integrates from. | ||
| - | < | ||
| - | < | + | < |
| Sets the Servo Offset voltage (in volts) to OUTPUT when the servo is turned off. When the servo is engaged, this voltage is the starting voltage that the servo integrates from. Returns the output of the command **SvOffst? | Sets the Servo Offset voltage (in volts) to OUTPUT when the servo is turned off. When the servo is engaged, this voltage is the starting voltage that the servo integrates from. Returns the output of the command **SvOffst? | ||
| - | < | ||
| - | < | + | < |
| 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 70: | Line 58: | ||
| - Ground | - Ground | ||
| - | < | ||
| - | < | + | < |
| - | 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 | + | |
| - | \\ | + | |
| - | //Note: RampEnd value is rounded up to be consistent with the **RampInc** value.// | + | |
| - | < | + | |
| - | < | + | < |
| - | Reads the increment step size of the ramp. Multiply | + | Sets the number |
| - | < | + | |
| - | < | + | < |
| - | Sets the increment step size of the ramp. Multiply | + | Begins ramping |
| - | < | + | |
| - | < | + | < |
| - | Returns | + | Returns |
| - | $$ \frac{RampEnd-RampBeg}{3.05\cdot 10^{-4} \times RampStep} $$ | + | < |
| + | 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, | ||
| - | Note that the amount | + | < |
| + | 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 | ||
| + | |||
| + | 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 | ||
| + | |||
| + | < | ||
| + | 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. | ||
| - | 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. | ||
| - | < | ||
| - | < | ||
| - | Begins ramping the servo output and taking data according to the values set for **RampInc**, | ||
| - | < | ||
ice/commands/opls.1395074517.txt.gz · Last modified: 2021/08/26 14:26 (external edit)