User Tools

Site Tools


ice:commands:peaklock

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
ice:commands:peaklock [2014/02/08 18:38] Ben Lueyice:commands:peaklock [2023/11/30 21:32] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Peak Lock and Current Controller Command Set ====== ====== Peak Lock and Current Controller Command Set ======
  
-List of commands for the ICE Quad Temperate Controller. Please see [[ice:commands:lasercurrent|Common Laser Controller Command Set]] for commands relating to the laser controller.+List of commands for the ICE Peak Lock Servo. Please see [[ice:commands:lasercurrent|Common Laser Controller Command Set]] for commands relating to the laser controller.
  
-<function=ICEfunc|0=Phase?&2=58&3=32>+<function=ICEfunc?0=Phase&2=58&3=32>
 Returns the phase shift (in degrees) on the dither signal modulating the laser current.<html></div></html> Returns the phase shift (in degrees) on the dither signal modulating the laser current.<html></div></html>
  
-<function=ICEfunc|0=Phase&1=F:PHASE:23;&2=22.5&3=33>+<function=ICEfunc?0=Phase&1=F:PHASE:23;&2=22.5&3=33>
 Sets the phase shift to PHASE (in degrees) on the dither signal modulating the laser current. Returns the output of the command **Phase?** Sets the phase shift to PHASE (in degrees) on the dither signal modulating the laser current. Returns the output of the command **Phase?**
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=DitherA?&2=32&3=34>+<function=ICEfunc?0=DitherA?&2=32&3=34>
 Returns the amplitude of the dither on the laser current. Output is integer from 0-255. Returns the amplitude of the dither on the laser current. Output is integer from 0-255.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=DitherA&1=I:AMP:35;&2=35&3=35>+<function=ICEfunc?0=DitherA&1=I:AMP:35;&2=35&3=35>
 Sets the amplitude of the current modulation to AMP.  AMP is an integer ranging from 0 – 255. Command returns the output of the command **DitherA?** Sets the amplitude of the current modulation to AMP.  AMP is an integer ranging from 0 – 255. Command returns the output of the command **DitherA?**
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=Dither?&2=On&3=36>+<function=ICEfunc?0=Dither?&2=On&3=36>
 Returns the status of the dither on the laser current (on or off). Returns the status of the dither on the laser current (on or off).
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=Dither&1=A:On/Off:On;&2=On&3=37>+<function=ICEfunc?0=Dither&1=A:On/Off:On;&2=On&3=37>
 Enables or disables the dither on the laser current. Valid arguments are On or Off.  Returns the output of the command **Dither?**. Enables or disables the dither on the laser current. Valid arguments are On or Off.  Returns the output of the command **Dither?**.
 <html></div></html> <html></div></html>
  
  
-<function=ICEfunc|0=ReadVolt&1=I:CHANNEL:4&2=4.234&3=38>+<function=ICEfunc?0=ReadVolt&1=I:CHANNEL:4&2=4.234&3=38>
 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 40: Line 40:
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=Servo?&2=On&3=39>+<function=ICEfunc?0=Servo?&2=On&3=39>
 Returns the status of the laser servo (on or off). Returns the status of the laser servo (on or off).
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=Servo&1=A:On/Off:On;&2=Off&3=40>+<function=ICEfunc?0=Servo&1=A:On/Off:On;&2=Off&3=40>
 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?**.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=DCOffst?&2=-2.345&3=41>+<function=ICEfunc?0=DCOffst?&2=-2.345&3=41>
 Returns DC offset (in volts) applied to the error signal.  Returns DC offset (in volts) applied to the error signal. 
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=DCOffst&1=F:OFFSET:2.340;&2=2.342&3=42>+<function=ICEfunc?0=DCOffst&1=F:OFFSET:2.340;&2=2.342&3=42>
 Sets the DC offset (in volts) applied to the error signal to OFFSET. Returns the output of the command **DCOffst?**. Sets the DC offset (in volts) applied to the error signal to OFFSET. Returns the output of the command **DCOffst?**.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=Gain?&2=25&3=43>+<function=ICEfunc?0=Gain?&2=25&3=43>
 Returns 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 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). 
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=Gain&1=I:GAIN:24;&2=24&3=44>+<function=ICEfunc?0=Gain&1=I:GAIN:24;&2=24&3=44>
 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?**
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=OpOffst?&2=129&3=45>+<function=ICEfunc?0=OpOffst?&2=129&3=45>
 Returns Integrator Op-Amp’s Offset Voltage adjustment value. Range is 0-255. Returns Integrator Op-Amp’s Offset Voltage adjustment value. Range is 0-255.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=OpOffst&1=I:OFFSET:142;&2=142&3=46> +<function=ICEfunc?0=OpOffst&1=I:OFFSET:142;&2=142&3=46> 
-Sets the Integrator Op-Amp’s Offset Voltage adjustment value. This should be factory set, but it controls the DC Error Input voltage that the servo locks to (should be 0V) OFFSET is an integer from 0-255. Returns the output of the command **OpOffst?**.+Sets the Integrator Op-Amp’s Offset Voltage adjustment value. This should be factory set and typically should be set to 128, but it controls the DC Error Input voltage that the servo locks to (should be 0V) OFFSET is an integer from 0-255. Returns the output of the command **OpOffst?**.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=SvOffst?&2=2.341&3=47>+<function=ICEfunc?0=SvOffst?&2=2.341&3=47>
 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.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=SvOffst&1=F:OFFSET:-1.232;&2=-1.23&3=48>+<function=ICEfunc?0=SvOffst&1=F:OFFSET:-1.232;&2=-1.23&3=48>
 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?**.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=DataChn?&2=2&3=49>+<function=ICEfunc?0=DataChn?&2=2&3=49>
 Read Data Channel Mode. There are 3 modes for the Data Channel: Read Data Channel Mode. There are 3 modes for the Data Channel:
      Mode 1: Record DC Error      Mode 1: Record DC Error
Line 89: Line 89:
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=DataChn&1=I:CHN_MODE:3&2=3&3=50>+<function=ICEfunc?0=DataChn&1=I:CHN_MODE:3&2=3&3=50>
 Sets the Data Channel Mode. See **DataChn?** for more details Returns the output of the command **DataChn?**. Sets the Data Channel Mode. See **DataChn?** for more details Returns the output of the command **DataChn?**.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampBeg?&2=2.34&3=51> +<function=ICEfunc?0=RampSwp?&2=5.72&3=51> 
-Reads the starting voltage for the ramp. +Reads the sweep range (in volts) for the ramp. 
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampBeg&1=F:VOLTAGE:-2.64&2=-2.65&3=52> +<function=ICEfunc?0=RampSwp&1=F:VOLTAGE:2.64&2=2.65&3=52> 
-Writes the starting voltage for the ramp.  Range is from -10V to +10V. Returns the output from the command **RampBeg?**.+Writes the sweep range (in volts) for the ramp.  Range is from 0V to +10V. Returns the output from the command **RampSwp?**. The ramp will step from SvOffst - RampSwp/2 to SvOffst + RampSwp/2 by increments determined by RampSwp and RampNum and then return to SvOffst every time a RampRun command is initiated.\\  
 +\\ 
 +//Note: RampSwp value is rounded and truncated to match range of the servo offset. //
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampEnd?&2=5.72&3=53> +<function=ICEfunc?0=RampNum?&2=100&3=53> 
-Reads the ending voltage for the ramp. +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.  
 + 
 +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.  
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampEnd&1=F:VOLTAGE:2.64&2=2.65&3=54> +<function=ICEfunc?0=RampNum&1=I:NUMBER:100&2=100&3=54> 
-Writes the ending voltage for the ramp.  Range is from -10V to +10V. Returns the output from the command **RampEnd?**.\\  +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.  
-\\ +
-//Note: RampEnd value is rounded up to be consistent with the **RampInc** value.//+
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampInc?&2=3&3=55> +<function=ICEfunc?0=RampRun&2=Busy&3=55> 
-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  +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 SvOffstData 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.
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampInc&1=I:STEPSIZE:3&2=3&3=56> +<function=ICEfunc?0=Poles?&2=3 0&3=56> 
-Sets the increment step size of the rampMultiply the RampInc value by 3.05e-4 V to get the ramp step size in voltsRampInc cannot be set to 0.+Returns two columns of dataFirst column is a number 1-5 representing the integrator pole value. Values are kHz, 10 kHz, 30 kHz, 100 kHz and 300 kHz1 is the slowest integrator (3 kHz) and 5 is fastest integrator (300 kHz)The second column is a when the differential pole is off and a 1 when it is on. When differential is on, the pole is ~3 times the integrator pole. So if PI pole is 30 kHz, the differential pole is 100 kHz
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampNum?&2=100&3=57> +<function=ICEfunc?0=Poles&1=I:INTEGRATOR:3;I:DIFFERENTIAL:1&2=3 1&3=57> 
-Returns the number of data points to be acquired during the rampNumber of data points is also the number of steps for the ramp. Number of data points to calculated by the following formula: +Sets the integrator and differential pole positionsINTEGRATOR is a value from 1-5DIFFERENTIAL is either on (1or off (0)See **Poles?** for more details
- +<html></div></html>
-$$ \frac{RampEnd-RampBeg}{3.05e-4 \times RampStep} $$ +
- +
-Note that the amount of bytes stored by the ramp is 2*RampNum when **DataChn** is in Mode 1 or 2; when **DataChn** in in Mode 3, the amount of data stored is 4*RampNumThe 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.+
  
 +<function=ICEfunc?0=EvtLOff?&2=4&3=58>
 +Reads the event address for turning the laser off. Address range is 0-7 where address 0 is no event. 
 <html></div></html> <html></div></html>
  
-<function=ICEfunc|0=RampRun&2=Busy&3=58+<function=ICEfunc?0=EvtLOff&1=I:ADDRESS:2&2=2&3=59
-Begins ramping the servo output and taking data according to the values set for RampNum, RampBeg, RampEnd and DataChn as described above. Data can be retrieved with the **ReadBlk** commandBoard will not respond to any new commands while taking data. Returns status of execution of the ramp, either Busy or Finished.+Sets the event address for turning the laser offAddress range is 0-7 where address 0 is no event
 <html></div></html> <html></div></html>
 +
  
  
ice/commands/peaklock.1391884686.txt.gz · Last modified: 2021/08/26 14:26 (external edit)