This is an old revision of the document!
Table of Contents
FFC-100 API
Links
* Quick-Start Guides
* Electronics
* Websites
* Downloads
Implementation Instructions
Listed below is the command set for the Application Programming Interface (API) for the FFC-100. Most operations that can be performed via the touchscreen can be also be performed via the API.
Computer communication to the FFC-100 occurs by first establishing a Serial COM port via the USB 2.0 physical interface. Computer communication should be platform independent, though appropriate USB drivers may have to be installed. The following table shows the serial port settings:
Baud Rate | 9600 |
---|---|
Data Bits | 8 |
Parity | None |
Stop Bits | 1 |
Flow Control | None |
To perform an operation, an ASCII-based text message is first constructed from a command and its arguments, and then the message is transmitted to the FFC-100 through the COM port. The following rules apply:
- Syntax is insensitive to case.
- A message is an ASCII string composed of a command followed by zero or more arguments.
- A command and its arguments are delimited by spaces.
- Messages are terminated by a carriage return (“\r”).
- All valid messages return an ASCII string value.
- [Int] refers to an integer argument that has no decimal point.
- [Float] refers to a floating point argument that has a decimal point in its value.
- Changes effected by issuing a serial command from this API are not permanently stored in non-volatile memory until you issue a SAVE command. Configuration changes without the SAVE command will be lost with power cycling. The Save command stores the entire configuration and so several configuration changes can be implemented and then a single SAVE command could be issued.
For most complete version of API, download the FFC-Serial API PDF from the downloads section.
New Table
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Returns firmware version of master board where arguments are used as follows: No Argument = System Controller firmware version is returned 1 = Oscillator board firmware version is returned 2 = Amplifier board firmware version is returned 3 = Cavity board firmware version is returned
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Saves the device’s current settings into EEPROM. Unsaved changes will be lost when the board is powered off. Returns SUCCESS or FAIL.
Arguments:
No Arguments Taken
Example:
#SCBKLT
I2C Command Number:
Description
Returns the touch screen backlight setting
['[INT]', 'level',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
, '(0', '–', '20)']
[INT]
, '(0', '–', '20)']
[INT]
No Arguments Taken
Description
Sets the touch screen backlight setting to the level given as an argument
—-
No Arguments Taken
#SCVOL
Description
Returns the touch screen and rotary knob audio feedback volume
—-
['[INT]', 'level',
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the touch screen and rotary knob audio feedback volume
Arguments:
No Arguments Taken
Example:
Vescent Photonics,FFC,[serial#],S-[version],FL-[version],LD-[version],LD-[version]
I2C Command Number:
Description
Returns the Manufacturer, Model, Serial Number, Board Firmware Versions of the device
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Restarts the device (power cycle)New Table
Arguments:
No Arguments Taken
Example:
MSTRCTL
I2C Command Number:
Description
Returns the enumerated operating mode of the FFC Where: 0 = OFF 1 = STANDBY 2 = LASER ON['[Int]', 'MODE'] [Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Returns the enumerated operating mode of the FFC Where: 0 = OFF 1 = STANDBY 2 = LASER ON Returns MSTRCTL? Note: The transition to Lasers On can only be made from Standby after temperatures are stabilized.
Arguments:
No Arguments Taken
Example:
CATCTRL
I2C Command Number:
Description
Returns the operating status of the Cavity Temperature Control Where: 0 = Manual Mode OFF (Not Recommended for Normal Use) 1 = Temperature Control Mode OFF 2 = Manual Mode ON (Not Recommended for Normal Use) 3 = Temperature Control Mode ON['[Int]', 'State'] [Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the operating status of the Cavity Temperature Control Where: 0 = Manual Mode OFF (Not Recommended for Normal Use) 1 = Temperature Control Mode OFF 2 = Manual Mode ON (Not Recommended for Normal Use) 3 = Temperature Control Mode ON Returns CATCTRL?
Arguments:
No Arguments Taken
Example:
OSTCTRL
I2C Command Number:
Description
Returns the operating status of the Oscillator Temperature Control Where: 0 = Manual Mode OFF (Not Recommended for Normal Use) 1 = Temperature Control Mode OFF 2 = Manual Mode ON (Not Recommended for Normal Use) 3 = Temperature Control Mode ON['[Int]', 'State'] [Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the operating status of the Oscillator Temperature Control Where: 0 = Manual Mode OFF (Not Recommended for Normal Use) 1 = Temperature Control Mode OFF 2 = Manual Mode ON (Not Recommended for Normal Use) 3 = Temperature Control Mode ON Returns OSTCTRL? Note: Disabling Oscillator Temperature Control will also disable Oscillator Laser Current.
Arguments:
No Arguments Taken
Example:
AMTCTRL
I2C Command Number:
Description
Returns the operating status of the Amplifier Temperature Control Where: 0 = Manual Mode OFF (Not Recommended for Normal Use) 1 = Temperature Control Mode OFF 2 = Manual Mode ON (Not Recommended for Normal Use) 3 = Temperature Control Mode ON['[Int]', 'State'] [Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the operating status of the Amplifier Temperature Control Where: 0 = Manual Mode OFF (Not Recommended for Normal Use) 1 = Temperature Control Mode OFF 2 = Manual Mode ON (Not Recommended for Normal Use) 3 = Temperature Control Mode ON Returns AMTCTRL? Note: Disabling Amplifier Temperature Control will also disable Amplifier Laser Current.
Arguments:
No Arguments Taken
Example:
INTERLK
I2C Command Number:
Description
Reads the status of the Interlock system Where: Closed = Interlock Circuit Closed. Lasers Available Open = Interlock Circuit Open. Lasers DisabledNew Table
Arguments:
No Arguments Taken
Example:
CATSETP
I2C Command Number:
Description
Returns the temperature setpoint for the Cavity Temperature Control['[Float]', 'Temperature']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the temperature setpoint for the Cavity Temperature Control Returns CATSETP?
Arguments:
No Arguments Taken
Example:
OSTSETP
I2C Command Number:
Description
Returns the temperature setpoint for the Oscillator Temperature Control
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the temperature setpoint for the Oscillator Temperature Control Returns OSTSETP?
Arguments:
No Arguments Taken
Example:
AMTSETP
I2C Command Number:
Description
Returns the temperature setpoint for the Amplifier Temperature Control['[Float]', 'Temperature']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the temperature setpoint for the Amplifier Temperature Control Returns AMTSETP?
Arguments:
No Arguments Taken
Example:
CAVTEMP
I2C Command Number:
Description
Reads the measured Cavity Temperature [C]
Arguments:
No Arguments Taken
Example:
OSCTEMP
I2C Command Number:
Description
Reads the measured Oscillator Temperature [C]
Arguments:
No Arguments Taken
Example:
AMPTEMP
I2C Command Number:
Description
Reads the measured Amplifier Temperature [C]
Arguments:
No Arguments Taken
Example:
CAVTERR
I2C Command Number:
Description
Reads the measured Cavity Temperature Error [mK]
Arguments:
No Arguments Taken
Example:
OSCTERR
I2C Command Number:
Description
Reads the measured Oscillator Temperature Error [mK]
Arguments:
No Arguments Taken
Example:
AMPTERR
I2C Command Number:
Description
Reads the measured Amplifier Temperature Error [mK]
Arguments:
No Arguments Taken
Example:
OSCTECI
I2C Command Number:
Description
Reads the measured Oscillator Temperature Control Current [A]
Arguments:
No Arguments Taken
Example:
AMPTECI
I2C Command Number:
Description
Reads the measured Amplifier Temperature Control Current [A]
Arguments:
No Arguments Taken
Example:
CAVBETA
I2C Command Number:
Description
Reads the Thermistor Beta Coefficient for Cavity Temperature Control['[Float]', 'Coefficient']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Beta Coefficient for Cavity Temperature Control Returns CAVBETA?
Arguments:
No Arguments Taken
Example:
OSCBETA
I2C Command Number:
Description
Reads the Thermistor Beta Coefficient for Oscillator Temperature Control['[Float]', 'Coefficient']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Beta Coefficient for Oscillator Temperature Control Returns OSCBETA?
Arguments:
No Arguments Taken
Example:
AMPBETA
I2C Command Number:
Description
Reads the Thermistor Beta Coefficient for Amplifier Temperature Control['[Float]', 'Coefficient']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Beta Coefficient for Amplifier Temperature Control Returns AMPBETA?
Arguments:
No Arguments Taken
Example:
CAVREFT
I2C Command Number:
Description
Reads the Thermistor Reference Temperature for Cavity Temperature Control['[Float]', 'Temperature']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Reference Temperature for Cavity Temperature Control Returns CAVREFT?
Arguments:
No Arguments Taken
Example:
OSCREFT
I2C Command Number:
Description
Reads the Thermistor Reference Temperature for Oscillator Temperature Control['[Float]', 'Temperature']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Reference Temperature for Oscillator Temperature Control Returns OSCREFT?
Arguments:
No Arguments Taken
Example:
AMPREFT
I2C Command Number:
Description
Reads the Thermistor Reference Temperature for Amplifier Temperature Control['[Float]', 'Temperature']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Reference Temperature for Amplifier Temperature Control Returns AMPREFT?
Arguments:
No Arguments Taken
Example:
CAVREFR
I2C Command Number:
Description
Reads the Thermistor Reference Resistor for Cavity Temperature Control['[Float]', 'Resistance']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Reference Resistor for Cavity Temperature Control Returns CAVREFR?
Arguments:
No Arguments Taken
Example:
OSCREFR
I2C Command Number:
Description
Reads the Thermistor Reference Resistor for Oscillator Temperature Control['[Float]', 'Resistance']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Reference Resistor for Oscillator Temperature Control Returns OSCREFR?
Arguments:
No Arguments Taken
Example:
AMPREFR
I2C Command Number:
Description
Reads the Thermistor Reference Resistor for Amplifier Temperature Control['[Float]', 'Resistance']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Thermistor Reference Resistor for Amplifier Temperature Control Returns AMPREFR?
Arguments:
No Arguments Taken
Example:
CAVCOFA
I2C Command Number:
Description
Reads the Steinhart-Hart A Thermistor coefficient for Cavity Temperature Control['[Float]', 'Coefficient', 'A']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart A Thermistor coefficient for Cavity Temperature Control Returns CAVCOFA?
Arguments:
No Arguments Taken
Example:
CAVCOFB
I2C Command Number:
Description
Reads the Steinhart-Hart B Thermistor coefficient for Cavity Temperature Control
['[Float]', ,
, 'Coefficient', 'B']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart B Thermistor coefficient for Cavity Temperature Control Returns CAVCOFB?
Arguments:
No Arguments Taken
Example:
CAVCOFC
I2C Command Number:
Description
Reads the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control
['[Float]', ,
, 'Coefficient', 'C']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control Returns CAVCOFC?
Arguments:
No Arguments Taken
Example:
OSCCOFA
I2C Command Number:
Description
Reads the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control
['[Float]', ,
, 'Coefficient', 'A']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control Returns OSCCOFA?
Arguments:
No Arguments Taken
Example:
OSCCOFB
I2C Command Number:
Description
Reads the Steinhart-Hart B Thermistor coefficient for Oscillator Temperature Control
['[Float]', ,
, 'Coefficient', 'B']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart B Thermistor coefficient for Oscillator Temperature Control Returns OSCCOFB?
Arguments:
No Arguments Taken
Example:
OSCCOFC
I2C Command Number:
Description
Reads the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control
['[Float]', ,
, 'Coefficient', 'C']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control Returns OSCCOFC?
Arguments:
No Arguments Taken
Example:
AMPCOFA
I2C Command Number:
Description
Reads the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control
['[Float]', ,
, 'Coefficient', 'A']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control Returns AMPCOFA?
Arguments:
No Arguments Taken
Example:
AMPCOFB
I2C Command Number:
Description
Reads the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control
['[Float]', ,
, 'Coefficient', 'B']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control Returns AMPCOFB?
Arguments:
No Arguments Taken
Example:
AMPCOFC
I2C Command Number:
Description
Reads the Steinhart-Hart C Thermistor coefficient for Amplifier Temperature Control
['[Float]', ,
, 'Coefficient', 'C']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Steinhart-Hart C Thermistor coefficient for Amplifier Temperature Control Returns AMPCOFC?
Arguments:
No Arguments Taken
Example:
CAVPROP
I2C Command Number:
Description
Reads the Proportional gain for Cavity Temperature Control
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, 'Proportional', , 'Gain']
, No Arguments Taken
Description
Sets the Proportional gain for Cavity Temperature Control
Returns CAVPROP?
—-
No Arguments Taken
CAVINT
Description
Reads the Integral gain for Cavity Temperature Control
—-
['[Float]', , 'Integral',
, 'Gain']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Integral gain for Cavity Temperature Control Returns CAVINT?
Arguments:
No Arguments Taken
Example:
CAVDERV
I2C Command Number:
Description
Reads the Derivative term for Cavity Temperature Control
['[Float]', ,
, 'Derivative']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Derivative term for Cavity Temperature Control Returns CAVDERV?
Arguments:
No Arguments Taken
Example:
OSCPROP
I2C Command Number:
Description
Reads the Proportional gain for Oscillator Temperature Control
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, 'Proportional', , 'Gain']
, No Arguments Taken
Description
Sets the Proportional gain for Oscillator Temperature Control
Returns OSCPROP?
—-
No Arguments Taken
OSCINT
Description
Reads the Integral gain for Oscillator Temperature Control
—-
['[Float]', , 'Integral',
, 'Gain']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Integral gain for Oscillator Temperature Control Returns OSCINT?
Arguments:
No Arguments Taken
Example:
OSCDERV
I2C Command Number:
Description
Reads the Derivative term for Oscillator Temperature Control
['[Float]', ,
, 'Derivative']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Derivative term for Oscillator Temperature Control Returns OSCDERV?
Arguments:
No Arguments Taken
Example:
AMPPROP
I2C Command Number:
Description
Reads the Proportional gain for Amplifier Temperature Control
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, 'Proportional', , 'Gain']
, No Arguments Taken
Description
Sets the Proportional gain for Amplifier Temperature Control
Returns AMPPROP?
—-
No Arguments Taken
AMPINT
Description
Reads the Integral gain for Amplifier Temperature Control
—-
['[Float]', , 'Integral',
, 'Gain']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Integral gain for Amplifier Temperature Control Returns AMPINT?
Arguments:
No Arguments Taken
Example:
AMPDERV
I2C Command Number:
Description
Reads the Derivative term for Amplifier Temperature Control
['[Float]', ,
, 'Derivative']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Derivative term for Amplifier Temperature Control Returns AMPDERV?
Arguments:
No Arguments Taken
Example:
CAPROEN
I2C Command Number:
Description
Reads the enabled status of Proportional Gain for Cavity Temperature Control
['[Int]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, '0', '=', 'OFF', , '1', '=', 'ON']
[Int]
, No Arguments Taken
Description
Sets the enabled status of Proportional Gain for Cavity Temperature Control
Returns CAPROEN?
—-
No Arguments Taken
OSPROEN
Description
Reads the enabled status of Proportional Gain for Oscillator Temperature Control
—-
['[Int]', , '0', '=', 'OFF',
, '1', '=', 'ON']
[Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the enabled status of Proportional Gain for Oscillator Temperature Control Returns OSPROEN?
Arguments:
No Arguments Taken
Example:
AMPROEN
I2C Command Number:
Description
Reads the enabled status of Proportional Gain for Amplifier Temperature Control
['[Int]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, '0', '=', 'OFF', , '1', '=', 'ON']
[Int]
, 'Slew', 'Rate']
No Arguments Taken
Description
Sets the enabled status of Proportional Gain for Amplifier Temperature Control
Returns AMPROEN?
—-
No Arguments Taken
CAVSLEW
Description
Reads the Slew Rate of the Cavity Temperature Control [°C/min]
—-
['[Float]',
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Slew Rate of the Cavity Temperature Control [°C/min] Returns: CAVSLEW?
Arguments:
No Arguments Taken
Example:
OSCSLEW
I2C Command Number:
Description
Reads the Slew Rate of the Oscillator Temperature Control [°C/min]
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
, 'Slew', 'Rate']
, 'Slew', 'Rate']
No Arguments Taken
Description
Sets the Slew Rate of the Oscillator Temperature Control [°C/min]
Returns: OSCSLEW?
—-
No Arguments Taken
AMPSLEW
Description
Reads the Slew Rate of the Amplifier Temperature Control [°C/min]
—-
['[Float]',
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Slew Rate of the Amplifier Temperature Control [°C/min] Returns: AMPSLEW?
Arguments:
No Arguments Taken
Example:
CASLWEN
I2C Command Number:
Description
Reads the Slew Rate Enabled state of the Cavity Temperature Control
['[Int]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, '0', '=', 'OFF', , '1', '=', 'ON']
[Int]
, No Arguments Taken
Description
Sets the Slew Rate Enabled state of the Cavity Temperature Control
Returns: CASLWEN?
—-
No Arguments Taken
OSSLWEN
Description
Reads the Slew Rate Enabled state of the Oscillator Temperature Control
—-
['[Int]', , '0', '=', 'OFF',
, '1', '=', 'ON']
[Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Slew Rate Enabled state of the Oscillator Temperature Control Returns: OSSLWEN?
Arguments:
No Arguments Taken
Example:
AMSLWEN
I2C Command Number:
Description
Reads the Slew Rate Enabled state of the Amplifier Temperature Control
['[Int]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, '0', '=', 'OFF', , '1', '=', 'ON']
[Int]
, No Arguments Taken
Description
Sets the Slew Rate Enabled state of the Amplifier Temperature Control
Returns: AMSLWEN?
—-
No Arguments Taken
CATILIM
Description
Reads the Cavity Temperature Control Current Limit [A]
—-
['[Float]', , 'Current', 'Limit']
, No Arguments Taken
Description
Sets the Cavity Temperature Control Current Limit [A]
Returns: CATILIM?
—-
No Arguments Taken
OSTILIM
Description
Reads the Oscillator Temperature Control Current Limit [A]
—-
['[Float]', , 'Current', 'Limit']
, No Arguments Taken
Description
Sets the Oscillator Temperature Control Current Limit [A]
Returns: OSTILIM?
—-
No Arguments Taken
AMTILIM
Description
Reads the Amplifier Temperature Control Current Limit [A]
—-
['[Float]', , 'Current', 'Limit']
, No Arguments Taken
Description
Sets the Amplifier Temperature Control Current Limit [A]
Returns: AMTILIM?
—-
No Arguments Taken
CATPLIM
Description
Reads the Cavity Temperature Control Power Limit [W]
—-
['[Float]', , 'Power', 'Limit']
, No Arguments Taken
Description
Sets the Cavity Temperature Control Power Limit [W]
Returns: CATPLIM?
—-
No Arguments Taken
OSTPLIM
Description
Reads the Oscillator Temperature Control Power Limit [W]
—-
['[Float]', , 'Power', 'Limit']
, No Arguments Taken
Description
Sets the Oscillator Temperature Control Power Limit [W]
Returns: OSTPLIM?
—-
No Arguments Taken
AMTPLIM
Description
Reads the Amplifier Temperature Control Power Limit [W]
—-
['[Float]', , 'Power', 'Limit']
, 'Warning', No Arguments Taken
Description
Sets the Amplifier Temperature Control Power Limit [W]
Returns: AMTPLIM?
—-
No Arguments Taken
CATWARN
Description
Reads the Temperature Error Warning Threshold of the Cavity Temperature Control [mK]
—-
['[Float]', ,
, ,
, , 'Threshold']
, 'Warning', No Arguments Taken
Description
the Temperature Error Warning Threshold of the Cavity Temperature Control [mK]
Returns: CATWARN?
—-
No Arguments Taken
OSTWARN
Description
Reads the Temperature Error Warning Threshold of the Oscillator Temperature Control [mK]
—-
['[Float]', ,
, 'Threshold']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
the Temperature Error Warning Threshold of the Oscillator Temperature Control [mK] Returns: OSTWARN?
Arguments:
No Arguments Taken
Example:
AMTWARN
I2C Command Number:
Description
Reads the Temperature Error Warning Threshold of the Amplifier Temperature Control [mK]
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
, 'Warning',
, , 'Threshold']
, 'Maximum', No Arguments Taken
Description
the Temperature Error Warning Threshold of the Amplifier Temperature Control [mK]
Returns: AMTWARN?
—-
No Arguments Taken
CATMAX
Description
Reads the Maximum Temperature Limit of the Cavity Temperature Control [C]
—-
['[Float]', ,
, ,
, , 'Temperature']
, 'Maximum', No Arguments Taken
Description
Sets the Maximum Temperature Limit of the Cavity Temperature Control [C]
Returns: CATMAX?
—-
No Arguments Taken
OSTMAX
Description
Reads the Maximum Temperature Limit of the Oscillator Temperature Control [C]
—-
['[Float]', ,
, 'Temperature']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Maximum Temperature Limit of the Oscillator Temperature Control [C] Returns: OSTMAX?
Arguments:
No Arguments Taken
Example:
AMTMAX
I2C Command Number:
Description
Reads the Maximum Temperature Limit of the Amplifier Temperature Control [C]
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
, 'Maximum',
, , 'Temperature']
, 'Minimum', No Arguments Taken
Description
Sets the Maximum Temperature Limit of the Amplifier Temperature Control [C]
Returns: AMTMAX?
—-
No Arguments Taken
CATMIN
Description
Reads the Minimum Temperature Limit of the Cavity Temperature Control [C]
—-
['[Float]', ,
, ,
, , 'Temperature']
, 'Minimum', No Arguments Taken
Description
Sets the Minimum Temperature Limit of the Cavity Temperature Control [C]
Returns: CATMIN?
—-
No Arguments Taken
OSTMIN
Description
Reads the Minimum Temperature Limit of the Oscillator Temperature Control [C]
—-
['[Float]', ,
, ,
, , 'Temperature']
, 'Minimum', No Arguments Taken
Description
Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C]
Returns: OSTMIN?
—-
No Arguments Taken
AMTMIN
Description
Reads the Minimum Temperature Limit of the Amplifier Temperature Control [C]
—-
['[Float]', ,
, ,
, , 'Temperature']
, No Arguments Taken
Description
Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C]
Returns: AMTMIN?
—-
No Arguments Taken
CASDTIM
Description
Reads the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Cavity Temperature Control
—-
['[Float]', 'Seconds']
No Arguments Taken
Description
Sets the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Cavity Temperature Control
Returns: CASDTIM?
—-
No Arguments Taken
OSSDTIM
Description
Reads the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Oscillator Temperature Control
—-
['[Float]', 'Seconds']
No Arguments Taken
Description
Sets the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Oscillator Temperature Control
Returns: OSSDTIM?
—-
No Arguments Taken
AMSDTIM
Description
Reads the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Amplifier Temperature Control
—-
['[Float]', 'Seconds']
No Arguments Taken
Description
Sets the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Amplifier Temperature Control
Returns: AMSDTIM?
—-
=====New Table=====
No Arguments Taken
OSISETP
Description
Reads the Current Setpoint for the Oscillator Laser [mA]
—-
['[Float]', , 'Laser',
, , 'Current',
, ,
, 'Setpoint']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Current Setpoint for the Oscillator Laser [mA] Returns: OSISETP?
Arguments:
No Arguments Taken
Example:
AMISETP
I2C Command Number:
Description
Reads the Current Setpoint for the Amplifier Laser [mA]
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, 'Laser', ,
, 'Current', ,
, , 'Setpoint']
, No Arguments Taken
Description
Sets the Current Setpoint for the Amplifier Laser [mA]
Returns: AMISETP?
—-
No Arguments Taken
OSCCURR
Description
Reads the Laser Current Output for the Oscillator [mA]
—-
No Arguments Taken
AMPCURR
Description
Reads the Laser Current Output for the Amplifier [mA]
—-
No Arguments Taken
OSCILIM
Description
Reads the Laser Current Limit for the Oscillator [mA]
—-
['[Float]', , 'Current', 'Limit']
, No Arguments Taken
Description
Sets the Laser Current Limit for Oscillator [mA]
Returns: OSCILIM?
—-
No Arguments Taken
AMCILIM
Description
Reads the Laser Current Limit for the Amplifier [mA]
—-
['[Float]', , 'Current', 'Limit']
, No Arguments Taken
Description
Sets the Laser Current Limit for Amplifier [mA]
Returns: AMCILIM?
—-
No Arguments Taken
OSCPLIM
Description
Reads the Laser Power Limit for the Oscillator [W]
—-
['[Float]', , 'Power', 'Limit']
, No Arguments Taken
Description
Sets the Laser Power Limit for Oscillator [W]
Returns: OSCPLIM?
—-
No Arguments Taken
AMCPLIM
Description
Reads the Laser Power Limit for the Amplifier [W]
—-
['[Float]', , 'Power', 'Limit']
, No Arguments Taken
Description
Sets the Laser Power Limit for Amplifier [W]
Returns: AMCPLIM?
—-
No Arguments Taken
_OSCTLIMMAX
Description
Reads the Oscillator Laser Temperature Upper Limit [°C]
(Laser is shut down if exceeded)
—-
['[Float]', , 'Laser',
, , 'Temperature',
, ,
, 'Upper', 'Limit']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Oscillator Laser Temperature Upper Limit [°C] (Laser is shut down if exceeded) Returns: _OSCTLIMMAX?
Arguments:
No Arguments Taken
Example:
_AMPTLIMMAX
I2C Command Number:
Description
Reads the Amplifier Laser Temperature Upper Limit [°C] (Laser is shut down if exceeded)
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, 'Laser', ,
, 'Temperature', ,
, , 'Upper', 'Limit']
, No Arguments Taken
Description
Sets the Amplifier Laser Temperature Upper Limit [°C]
(Laser is shut down if exceeded)
Returns: _ AMPTLIMMAX?
—-
No Arguments Taken
_OSCTLIMMIN
Description
Reads the Oscillator Laser Temperature Lower Limit [°C]
(Laser is shut down if exceeded)
—-
['[Float]', , 'Laser',
, , 'Temperature',
, ,
, 'Lower', 'Limit']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Oscillator Laser Temperature Lower Limit [°C] (Laser is shut down if exceeded) Returns: _OSCTLIMMIN?
Arguments:
No Arguments Taken
Example:
_AMPTLIMMIN
I2C Command Number:
Description
Reads the Amplifier Laser Temperature Lower Limit [°C] (Laser is shut down if exceeded)
['[Float]',
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
Arguments:
Example:
I2C Command Number:
,
, 'Laser', ,
, 'Temperature', ,
, , 'Lower', 'Limit']
, No Arguments Taken
Description
Sets the Amplifier Laser Temperature Lower Limit [°C]
(Laser is shut down if exceeded)
Returns: _ AMPTLIMMIN?
—-
=====New Table=====
No Arguments Taken
CADCBSP
Description
Reads the DC Bias Setpoint for the Cavity [V]
—-
['[Float]', , 'Voltage']
, 'Voltage']
No Arguments Taken
Description
Sets the DC Bias Setpoint for the Cavity [V]
Returns: CADCBSP?
—-
No Arguments Taken
CADCBV
Description
Reads the PZT Voltage Output for the Cavity [V]
—-
No Arguments Taken
VLIM
Description
Reads the DC Bias Setpoint Limit for the Cavity [V]
—-
['[Float]',
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the DC Bias Setpoint Limit for the Cavity [V] Returns: VLIM?New Table
Arguments:
No Arguments Taken
Example:
MLDCTRH
I2C Command Number:
Description
Reads the Mode Lock DC Threshold Parameter [mV]['[Float]', 'Voltage']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Mode Lock DC Threshold Parameter [mV] Returns: MLDCTHR?
Arguments:
No Arguments Taken
Example:
MLRMTHR
I2C Command Number:
Description
Reads the Mode Lock RMS Threshold Parameter [mV]['[Float]', 'Voltage']
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Mode Lock RMS Threshold Parameter [mV] Returns: MLRMTHR?
Arguments:
No Arguments Taken
Example:
MLSMPLM
I2C Command Number:
Description
Reads the Mode Lock Sample Limit['[Int]', 'Limit'] [Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number:
Description
Sets the Mode Lock Sample Limit Returns: MLSMPLM?
Arguments:
No Arguments Taken
Example:
MODELOK
I2C Command Number:
Description
Reads the Mode Lock Status [Off/On]['[Int]', 'State'] [Int]
Arguments:
No Arguments Taken
Example:
I2C Command Number: