This is an old revision of the document!
Offset Phase Lock and Current Controller Command Set
List of commands for the ICE Offst PHase Lock and Current Controller. Please see Common Laser Controller Command Set for commands relating to the laser controller and Common Commands to all ICE Slave Boards for generic slave board commands.
Arguments:
No Arguments Taken
Example:
8
I2C Command Number: 32
Description
Returns the value of the N divider. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Set the value of the N divider. Valid settings are 8,16,32 and 64. Returns output from N? command. <html></div></html>
Arguments:
No Arguments Taken
Example:
On
I2C Command Number: 34
Description
Returns whether the error signal is being inverted or not. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
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. <html></div></html>
Arguments:
No Arguments Taken
Example:
Off
I2C Command Number: 36
Description
Returns if the internal reference oscillator is active (as opposed to using an external reference). <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Enables or disables using the internal reference (instead of external reference). Returns output of IntRef? command. <html></div></html>
Arguments:
No Arguments Taken
Example:
162.875345
I2C Command Number: 38
Description
Returns the internal reference’s oscillator’s frequency in MHz. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the internal reference oscillator’s frequency to FREQ, where FREQ is a the frequency in MHz. Returns the output of the IntFreq? command. <html></div></html>
Arguments:
No Arguments Taken
Example:
On
I2C Command Number: 40
Description
Returns the status of the laser servo (on or off). <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Turns on the laser servo (engages the integrator). Returns the output of the command Servo?. <html></div></html>
Arguments:
No Arguments Taken
Example:
25
I2C Command Number: 42
Description
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). <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
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? <html></div></html>
Arguments:
No Arguments Taken
Example:
2.341
I2C Command Number: 44
Description
Returns Servo Offset voltage (in volts). When the servo is engaged, this voltage is the starting voltage that the servo integrates from. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
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?. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Returns the voltage measured on channel CHANNEL (in volts). The channels refer to:- Servo Out
- Error Signal
- NA
- NA
- Laser Current (1V = 1A)
- +2.5V Ref
- NA
- Ground
<html></div></html>
Arguments:
No Arguments Taken
Example:
2.34
I2C Command Number: 47
Description
Reads the starting voltage for the ramp. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Writes the starting voltage for the ramp. Range is from -10V to +10V. Returns the output from the command RampBeg?. Sets the SvOffset to the ramp begin voltage. This way, laser starts at RampBeg value before ramp is initialized, enabling a smooth ramp. <html></div></html>
Arguments:
No Arguments Taken
Example:
5.72
I2C Command Number: 49
Description
Reads the ending voltage for the ramp. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Writes the ending voltage for the ramp. Range is from -10V to +10V. Returns the output from the command RampEnd?.Note: RampEnd value is rounded up to be consistent with the RampInc value. <html></div></html>
Arguments:
No Arguments Taken
Example:
3
I2C Command Number: 51
Description
Reads the increment step size of the ramp. Multiply the RampInc value by 3.05e-4 V to get the ramp step size in volts. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the increment step size of the ramp. Multiply the RampInc value by 3.05e-4 V to get the ramp step size in volts. RampInc cannot be set to 0. <html></div></html>
Arguments:
No Arguments Taken
Example:
100
I2C Command Number: 53
Description
Returns 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:$$ \frac{RampEnd-RampBeg}{3.05\cdot 10^{-4} \times RampStep} $$
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.
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.
<html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Begins ramping the servo output and taking data according to the values set for RampInc, RampBeg, and RampEnd as described above. 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? for details. Returns fail if laser is off. At end of ramp, servo output is set to RampBeg value. <html></div></html>
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
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 teh 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, so if there are 5 event points, then the ELEMENT NUMBER that is jumped will be sequentially: 1,2,3,4,5,1,2,3,4,5,1….The MODE sets the whether to invert the error signal, N value and whether to use the internal or external frequency reference. When invert is on, it has a value of 1, otherwise 0. When using the interval reference, it has a value of 2, otherwise 0. The value of MODE is the sum of the invert state, the internal reference state and the desired N setting. Some Examples:
MODE=16 is N=16, Invert off, External Reference.
MODE=18 is N=16, Invert off, Internal Reference.
MODE=19 is N=16, Invert on, Internal Reference.
MODE=35 is N=32, Invert on, Internal Reference.
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.
<html></div></html>