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 21:33] – Updated ramp commands for center + sweep added new event controlling functions. 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 77: | Line 79: | ||
| < | < | ||
| - | Writes the sweep range (in volts) for the ramp. Range is from -10V to +10V. Returns the output from the command **RampSwp? | + | Writes the sweep range (in volts) for the ramp. Range is from -0V to +10V. Returns the output from the command **RampSwp? |
| \\ | \\ | ||
| //Note: RampSwp value is rounded and truncated to match range of the servo offset. // | //Note: RampSwp value is rounded and truncated to match range of the servo offset. // | ||
| Line 90: | Line 92: | ||
| < | < | ||
| - | Sets the number of data points to be acquired during the ramp. Number of data points is also the number of steps for the ramp. Number of data points to calculated by the following formula: | + | Sets the number of data points to be acquired during the ramp. Number of data points is also the number of steps for the ramp. |
| < | < | ||
| < | < | ||
| - | Begins ramping the servo output and taking data according to the values set for **RampInc**, **RampBeg**, | + | Begins ramping the servo output and taking data according to the values set for **RampSwp** and **SvOffst** as described above. The Ramp begins at SvOffst - RampSwp/2 and ends of SvOffst + RampSwp/2. When the ramp is completed, the servo output is returned to its starting value of SvOffst. Data can be retrieved with the **ReadBlk** command. Board will not respond to any new commands while taking data. Returns status of execution of the ramp, either Busy or Finished. Returns fault if ramp is misconfigured. See **RampNum? |
| < | < | ||
| - | < | + | < |
| - | Returns | + | Returns |
| < | < | ||
| < | < | ||
| - | Sets the integrator and differential pole positions. INTEGRATOR is a value from 4-7. DIFFERENTIAL is a value from 4-7 with 0 disabling differential. | + | 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, 1 is 10 kHz and 4 is 300 kHz. See **Poles?** for full list of all pole values. |
| < | < | ||
| Line 123: | Line 126: | ||
| < | < | ||
| - | < | + | < |
| - | 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: | + | <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: | 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 145: | Line 163: | ||
| ^ 14 | 64 | On | Off | | ^ 14 | 64 | On | Off | | ||
| ^ 15 | 64 | On | On | | ^ 15 | 64 | On | On | | ||
| - | |||
| - | |||
| - | **FREQUENCY REFERENCE** is the value of the internal frequency reference. | ||
| The command returns SUCCESS if the data is successfully enter, FAIL if not. Data loaded is saved to memory with the **SAVE** command. | The command returns SUCCESS if the data is successfully enter, FAIL if not. Data loaded is saved to memory with the **SAVE** command. | ||
| - | |||
| < | < | ||
| Line 161: | Line 175: | ||
| < | < | ||
| + | < | ||
| + | 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