User Tools

Site Tools


ffc:100:api

FFC-100 API

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:

  1. Syntax is insensitive to case.
  2. A message is an ASCII string composed of a command followed by zero or more arguments.
  3. A command and its arguments are delimited by spaces.
  4. Messages are terminated by a carriage return (“\r”).
  5. All valid messages return an ASCII string value.
  6. [Int] refers to an integer argument that has no decimal point.
  7. [Float] refers to a floating point argument that has a decimal point in its value.
  8. 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.

General Commands

#Version

Arguments:

No Arguments Taken

Example:

#Version  
255.255 255.255 0.16 65535 (0.16 is version)

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


#SAVESETTINGS

Arguments:

No Arguments Taken

Example:

#SAVESETTINGS  
#SAVESETTINGS

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.


#Scbklt

Arguments:

No Arguments Taken

Example:

#Scbklt  
#SCBKLT

I2C Command Number:


Description

Returns the touch screen backlight setting


#Scbklt

Arguments:

[Int] level  (0 – 20) 

Example:

#Scbklt 3 
#SCBKLT 3

I2C Command Number:


Description

Sets the touch screen backlight setting to the level given as an argument


#Scvol

Arguments:

No Arguments Taken

Example:

#Scvol  
#SCVOL

I2C Command Number:


Description

Returns the touch screen and rotary knob audio feedback volume


#Scvol

Arguments:

[Int] level  (0 – 20) 

Example:

#Scvol 8 
#SCVOL 8

I2C Command Number:


Description

Sets the touch screen and rotary knob audio feedback volume


*IDN

Arguments:

No Arguments Taken

Example:

  • IDN

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


*RST

Arguments:

No Arguments Taken

Example:

  • RST

Resetting System I2C Command Number:


Description

Restarts the device (power cycle)


Control API

MSTRCTL

Arguments:

No Arguments Taken

Example:

MSTRCTL  
MSTRCTL

I2C Command Number:


Description

Returns the enumerated operating mode of the FFC Where: 0 = OFF 1 = STANDBY 2 = LASER ON


MSTRCTL

Arguments:

[Int] MODE 

Example:

MSTRCTL 1 
MSTRCTL 1

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.


CATCTRL

Arguments:

No Arguments Taken

Example:

CATCTRL  
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


CATCTRL

Arguments:

[Int] State    

Example:

CATCTRL 1 
CATCTRL 1

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?


OSTCTRL

Arguments:

No Arguments Taken

Example:

OSTCTRL  
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


OSTCTRL

Arguments:

[Int] State 

Example:

OSTCTRL 3 
OSTCTRL 3

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.


AMTCTRL

Arguments:

No Arguments Taken

Example:

AMTCTRL  
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


AMTCTRL

Arguments:

[Int] State  

Example:

AMTCTRL 1 
AMTCTRL 1

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.


INTERLK

Arguments:

No Arguments Taken

Example:

INTERLK  
INTERLK

I2C Command Number:


Description

Reads the status of the Interlock system Where: Closed = Interlock Circuit Closed. Lasers Available Open = Interlock Circuit Open. Lasers Disabled


Temperature Controls

CATSETP

Arguments:

No Arguments Taken

Example:

CATSETP  
CATSETP

I2C Command Number:


Description

Returns the temperature setpoint for the Cavity Temperature Control


CATSETP

Arguments:

[Float] Temperature  

Example:

CATSETP 24.5 
CATSETP 24.5

I2C Command Number:


Description

Sets the temperature setpoint for the Cavity Temperature Control Returns CATSETP?


OSTSETP

Arguments:

No Arguments Taken

Example:

OSTSETP  
OSTSETP

I2C Command Number:


Description

Returns the temperature setpoint for the Oscillator Temperature Control


OSTSETP

Arguments:

No Arguments Taken

Example:

OSTSETP  
OSTSETP 24.5

I2C Command Number:


Description

Sets the temperature setpoint for the Oscillator Temperature Control Returns OSTSETP?


AMTSETP

Arguments:

No Arguments Taken

Example:

AMTSETP  
AMTSETP

I2C Command Number:


Description

Returns the temperature setpoint for the Amplifier Temperature Control


AMTSETP

Arguments:

[Float] Temperature  

Example:

AMTSETP 24.5 
AMTSETP 24.5

I2C Command Number:


Description

Sets the temperature setpoint for the Amplifier Temperature Control Returns AMTSETP?


CAVTEMP

Arguments:

No Arguments Taken

Example:

CAVTEMP  
CAVTEMP

I2C Command Number:


Description

Reads the measured Cavity Temperature [C]


OSCTEMP

Arguments:

No Arguments Taken

Example:

OSCTEMP  
OSCTEMP

I2C Command Number:


Description

Reads the measured Oscillator Temperature [C]


AMPTEMP

Arguments:

No Arguments Taken

Example:

AMPTEMP  
AMPTEMP

I2C Command Number:


Description

Reads the measured Amplifier Temperature [C]


CAVTERR

Arguments:

No Arguments Taken

Example:

CAVTERR  
CAVTERR

I2C Command Number:


Description

Reads the measured Cavity Temperature Error [mK]


OSCTERR

Arguments:

No Arguments Taken

Example:

OSCTERR  
OSCTERR

I2C Command Number:


Description

Reads the measured Oscillator Temperature Error [mK]


AMPTERR

Arguments:

No Arguments Taken

Example:

AMPTERR  
AMPTERR

I2C Command Number:


Description

Reads the measured Amplifier Temperature Error [mK]


OSCTECI

Arguments:

No Arguments Taken

Example:

OSCTECI  
OSCTECI

I2C Command Number:


Description

Reads the measured Oscillator Temperature Control Current [A]


AMPTECI

Arguments:

No Arguments Taken

Example:

AMPTECI  
AMPTECI

I2C Command Number:


Description

Reads the measured Amplifier Temperature Control Current [A]


CAVBETA

Arguments:

No Arguments Taken

Example:

CAVBETA  
CAVBETA

I2C Command Number:


Description

Reads the Thermistor Beta Coefficient for Cavity Temperature Control


CAVBETA

Arguments:

[Float] Coefficient

Example:

CAVBETA 3500 
CAVBETA 3500

I2C Command Number:


Description

Sets the Thermistor Beta Coefficient for Cavity Temperature Control Returns CAVBETA?


OSCBETA

Arguments:

No Arguments Taken

Example:

OSCBETA  
OSCBETA

I2C Command Number:


Description

Reads the Thermistor Beta Coefficient for Oscillator Temperature Control


OSCBETA

Arguments:

[Float] Coefficient 

Example:

OSCBETA 3500 
OSCBETA 3500

I2C Command Number:


Description

Sets the Thermistor Beta Coefficient for Oscillator Temperature Control Returns OSCBETA?


AMPBETA

Arguments:

No Arguments Taken

Example:

AMPBETA  
AMPBETA

I2C Command Number:


Description

Reads the Thermistor Beta Coefficient for Amplifier Temperature Control


AMPBETA

Arguments:

[Float] Coefficient 

Example:

AMPBETA 3500 
AMPBETA 3500

I2C Command Number:


Description

Sets the Thermistor Beta Coefficient for Amplifier Temperature Control Returns AMPBETA?


CAVREFT

Arguments:

No Arguments Taken

Example:

CAVREFT  
CAVREFT

I2C Command Number:


Description

Reads the Thermistor Reference Temperature for Cavity Temperature Control


CAVREFT

Arguments:

[Float] Temperature  

Example:

CAVREFT 20 
CAVREFT 20

I2C Command Number:


Description

Sets the Thermistor Reference Temperature for Cavity Temperature Control Returns CAVREFT?


OSCREFT

Arguments:

No Arguments Taken

Example:

OSCREFT  
OSCREFT

I2C Command Number:


Description

Reads the Thermistor Reference Temperature for Oscillator Temperature Control


OSCREFT

Arguments:

[Float] Temperature  

Example:

OSCREFT 20 
OSCREFT 20

I2C Command Number:


Description

Sets the Thermistor Reference Temperature for Oscillator Temperature Control Returns OSCREFT?


AMPREFT

Arguments:

No Arguments Taken

Example:

AMPREFT  
AMPREFT

I2C Command Number:


Description

Reads the Thermistor Reference Temperature for Amplifier Temperature Control


AMPREFT

Arguments:

[Float] Temperature   

Example:

AMPREFT 20 
AMPREFT 20

I2C Command Number:


Description

Sets the Thermistor Reference Temperature for Amplifier Temperature Control Returns AMPREFT?


CAVREFR

Arguments:

No Arguments Taken

Example:

CAVREFR  
CAVREFR

I2C Command Number:


Description

Reads the Thermistor Reference Resistor for Cavity Temperature Control


CAVREFR

Arguments:

[Float] Resistance  

Example:

CAVREFR 30000 
CAVREFR 30000

I2C Command Number:


Description

Sets the Thermistor Reference Resistor for Cavity Temperature Control Returns CAVREFR?


OSCREFR

Arguments:

No Arguments Taken

Example:

OSCREFR  
OSCREFR

I2C Command Number:


Description

Reads the Thermistor Reference Resistor for Oscillator Temperature Control


OSCREFR

Arguments:

[Float] Resistance  

Example:

OSCREFR 30000 
OSCREFR 30000

I2C Command Number:


Description

Sets the Thermistor Reference Resistor for Oscillator Temperature Control Returns OSCREFR?


AMPREFR

Arguments:

No Arguments Taken

Example:

AMPREFR  
AMPREFR

I2C Command Number:


Description

Reads the Thermistor Reference Resistor for Amplifier Temperature Control


AMPREFR

Arguments:

[Float] Resistance  

Example:

AMPREFR 30000 
AMPREFR 30000

I2C Command Number:


Description

Sets the Thermistor Reference Resistor for Amplifier Temperature Control Returns AMPREFR?


CAVCOFA

Arguments:

No Arguments Taken

Example:

CAVCOFA  
CAVCOFA

I2C Command Number:


Description

Reads the Steinhart-Hart A Thermistor coefficient for Cavity Temperature Control


CAVCOFA

Arguments:

[Float] Coefficient A 

Example:

CAVCOFA 0.000722 
CAVCOFA 0.000722

I2C Command Number:


Description

Sets the Steinhart-Hart A Thermistor coefficient for Cavity Temperature Control Returns CAVCOFA?


CAVCOFB

Arguments:

No Arguments Taken

Example:

CAVCOFB  
CAVCOFB

I2C Command Number:


Description

Reads the Steinhart-Hart B Thermistor coefficient for Cavity Temperature Control


CAVCOFB

Arguments:

[Float] Coefficient B

Example:

CAVCOFB 0.000286 
CAVCOFB 0.000286

I2C Command Number:


Description

Sets the Steinhart-Hart B Thermistor coefficient for Cavity Temperature Control Returns CAVCOFB?


CAVCOFC

Arguments:

No Arguments Taken

Example:

CAVCOFC  
CAVCOFC

I2C Command Number:


Description

Reads the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control


CAVCOFC

Arguments:

[Float] Coefficient C

Example:

CAVCOFC 0.000001 
CAVCOFC 0.000001

I2C Command Number:


Description

Sets the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control Returns CAVCOFC?


OSCCOFA

Arguments:

No Arguments Taken

Example:

OSCCOFA  
OSCCOFA

I2C Command Number:


Description

Reads the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control


OSCCOFA

Arguments:

[Float] Coefficient A

Example:

OSCCOFA 0.000684 
OSCCOFA 0.000684

I2C Command Number:


Description

Sets the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control Returns OSCCOFA?


OSCCOFB

Arguments:

No Arguments Taken

Example:

OSCCOFB  
OSCCOFB

I2C Command Number:


Description

Reads the Steinhart-Hart B Thermistor coefficient for Oscillator Temperature Control


OSCCOFB

Arguments:

[Float] Coefficient B

Example:

OSCCOFB 0.000286 
OSCCOFB 0.000286

I2C Command Number:


Description

Sets the Steinhart-Hart B Thermistor coefficient for Oscillator Temperature Control Returns OSCCOFB?


OSCCOFC

Arguments:

No Arguments Taken

Example:

OSCCOFC  
OSCCOFC

I2C Command Number:


Description

Reads the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control


OSCCOFC

Arguments:

[Float] Coefficient C

Example:

OSCCOFC 0.000001 
OSCCOFC 0.000001

I2C Command Number:


Description

Sets the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control Returns OSCCOFC?


AMPCOFA

Arguments:

No Arguments Taken

Example:

AMPCOFA  
AMPCOFA

I2C Command Number:


Description

Reads the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control


AMPCOFA

Arguments:

[Float] Coefficient A

Example:

AMPCOFA 0.000684 
AMPCOFA 0.000684

I2C Command Number:


Description

Sets the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control Returns AMPCOFA?


AMPCOFB

Arguments:

No Arguments Taken

Example:

AMPCOFB  
AMPCOFB

I2C Command Number:


Description

Reads the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control


AMPCOFB

Arguments:

[Float] Coefficient B

Example:

AMPCOFB 0.000286 
AMPCOFB 0.000286

I2C Command Number:


Description

Sets the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control Returns AMPCOFB?


AMPCOFC

Arguments:

No Arguments Taken

Example:

AMPCOFC  
AMPCOFC

I2C Command Number:


Description

Reads the Steinhart-Hart C Thermistor coefficient for Amplifier Temperature Control


AMPCOFC

Arguments:

[Float] Coefficient C

Example:

AMPCOFC 0.000001 
AMPCOFC 0.000001

I2C Command Number:


Description

Sets the Steinhart-Hart C Thermistor coefficient for Amplifier Temperature Control Returns AMPCOFC?


CAVPROP

Arguments:

No Arguments Taken

Example:

CAVPROP  
CAVPROP

I2C Command Number:


Description

Reads the Proportional gain for Cavity Temperature Control


CAVPROP

Arguments:

[Float] Proportional Gain 

Example:

CAVPROP 7.500000 
CAVPROP 7.500000

I2C Command Number:


Description

Sets the Proportional gain for Cavity Temperature Control Returns CAVPROP?


CAVINT

Arguments:

No Arguments Taken

Example:

CAVINT  
CAVINT

I2C Command Number:


Description

Reads the Integral gain for Cavity Temperature Control


CAVINT

Arguments:

[Float] Integral Gain

Example:

CAVINT 2.0 
CAVINT 2.0

I2C Command Number:


Description

Sets the Integral gain for Cavity Temperature Control Returns CAVINT?


CAVDERV

Arguments:

No Arguments Taken

Example:

CAVDERV  
CAVDERV

I2C Command Number:


Description

Reads the Derivative term for Cavity Temperature Control


CAVDERV

Arguments:

[Float] Derivative 

Example:

CAVDERV 0.5 
CAVDERV 0.5

I2C Command Number:


Description

Sets the Derivative term for Cavity Temperature Control Returns CAVDERV?


OSCPROP

Arguments:

No Arguments Taken

Example:

OSCPROP  
OSCPROP

I2C Command Number:


Description

Reads the Proportional gain for Oscillator Temperature Control


OSCPROP

Arguments:

[Float] Proportional Gain 

Example:

OSCPROP 7.500000 
OSCPROP 7.500000

I2C Command Number:


Description

Sets the Proportional gain for Oscillator Temperature Control Returns OSCPROP?


OSCINT

Arguments:

No Arguments Taken

Example:

OSCINT  
OSCINT

I2C Command Number:


Description

Reads the Integral gain for Oscillator Temperature Control


OSCINT

Arguments:

[Float]  Integral Gain 

Example:

OSCINT 2.0 
OSCINT 2.0

I2C Command Number:


Description

Sets the Integral gain for Oscillator Temperature Control Returns OSCINT?


OSCDERV

Arguments:

No Arguments Taken

Example:

OSCDERV  
OSCDERV

I2C Command Number:


Description

Reads the Derivative term for Oscillator Temperature Control


OSCDERV

Arguments:

[Float] Derivative 

Example:

OSCDERV 0.5 
OSCDERV 0.5

I2C Command Number:


Description

Sets the Derivative term for Oscillator Temperature Control Returns OSCDERV?


AMPPROP

Arguments:

No Arguments Taken

Example:

AMPPROP  
AMPPROP

I2C Command Number:


Description

Reads the Proportional gain for Amplifier Temperature Control


AMPPROP

Arguments:

[Float] Proportional Gain 

Example:

AMPPROP 7.500000 
AMPPROP 7.500000

I2C Command Number:


Description

Sets the Proportional gain for Amplifier Temperature Control Returns AMPPROP?


AMPINT

Arguments:

No Arguments Taken

Example:

AMPINT  
AMPINT

I2C Command Number:


Description

Reads the Integral gain for Amplifier Temperature Control


AMPINT

Arguments:

[Float] Integral Gain 

Example:

AMPINT 2.0 
AMPINT 2.0

I2C Command Number:


Description

Sets the Integral gain for Amplifier Temperature Control Returns AMPINT?


AMPDERV

Arguments:

No Arguments Taken

Example:

AMPDERV  
AMPDERV

I2C Command Number:


Description

Reads the Derivative term for Amplifier Temperature Control


AMPDERV

Arguments:

[Float] Derivative 

Example:

AMPDERV 0.5 
AMPDERV 0.5

I2C Command Number:


Description

Sets the Derivative term for Amplifier Temperature Control Returns AMPDERV?


CAPROEN

Arguments:

No Arguments Taken

Example:

CAPROEN  
CAPROEN

I2C Command Number:


Description

Reads the enabled status of Proportional Gain for Cavity Temperature Control


CAPROEN

Arguments:

[Int] 0 = OFF  1 = ON  

Example:

CAPROEN OFF 
CAPROEN OFF

I2C Command Number:


Description

Sets the enabled status of Proportional Gain for Cavity Temperature Control Returns CAPROEN?


OSPROEN

Arguments:

No Arguments Taken

Example:

OSPROEN  
OSPROEN

I2C Command Number:


Description

Reads the enabled status of Proportional Gain for Oscillator Temperature Control


OSPROEN

Arguments:

[Int] 0 = OFF 1 = ON  

Example:

OSPROEN OFF 
OSPROEN OFF

I2C Command Number:


Description

Sets the enabled status of Proportional Gain for Oscillator Temperature Control Returns OSPROEN?


AMPROEN

Arguments:

No Arguments Taken

Example:

AMPROEN  
AMPROEN

I2C Command Number:


Description

Reads the enabled status of Proportional Gain for Amplifier Temperature Control


AMPROEN

Arguments:

[Int]  0 = OFF  1 = ON  

Example:

AMPROEN OFF 
AMPROEN OFF

I2C Command Number:


Description

Sets the enabled status of Proportional Gain for Amplifier Temperature Control Returns AMPROEN?


CAVSLEW

Arguments:

No Arguments Taken

Example:

CAVSLEW  
CAVSLEW

I2C Command Number:


Description

Reads the Slew Rate of the Cavity Temperature Control [°C/min]


CAVSLEW

Arguments:

[Float]  Slew Rate 

Example:

CAVSLEW 3.5 
CAVSLEW 3.5

I2C Command Number:


Description

Sets the Slew Rate of the Cavity Temperature Control [°C/min] Returns: CAVSLEW?


OSCSLEW

Arguments:

No Arguments Taken

Example:

OSCSLEW  
OSCSLEW

I2C Command Number:


Description

Reads the Slew Rate of the Oscillator Temperature Control [°C/min]


OSCSLEW

Arguments:

[Float]  Slew Rate 

Example:

OSCSLEW 3.5 
OSCSLEW 3.5

I2C Command Number:


Description

Sets the Slew Rate of the Oscillator Temperature Control [°C/min] Returns: OSCSLEW?


AMPSLEW

Arguments:

No Arguments Taken

Example:

AMPSLEW  
AMPSLEW

I2C Command Number:


Description

Reads the Slew Rate of the Amplifier Temperature Control [°C/min]


AMPSLEW

Arguments:

[Float]  Slew Rate 

Example:

AMPSLEW 3.5 
AMPSLEW 3.5

I2C Command Number:


Description

Sets the Slew Rate of the Amplifier Temperature Control [°C/min] Returns: AMPSLEW?


CASLWEN

Arguments:

No Arguments Taken

Example:

CASLWEN  
CASLWEN

I2C Command Number:


Description

Reads the Slew Rate Enabled state of the Cavity Temperature Control


CASLWEN

Arguments:

[Int]   0 = OFF  1 = ON 

Example:

CASLWEN ON 
CASLWEN ON

I2C Command Number:


Description

Sets the Slew Rate Enabled state of the Cavity Temperature Control Returns: CASLWEN?


OSSLWEN

Arguments:

No Arguments Taken

Example:

OSSLWEN  
OSSLWEN

I2C Command Number:


Description

Reads the Slew Rate Enabled state of the Oscillator Temperature Control


OSSLWEN

Arguments:

[Int]   0 = OFF  1 = ON 

Example:

OSSLWEN ON 
OSSLWEN ON

I2C Command Number:


Description

Sets the Slew Rate Enabled state of the Oscillator Temperature Control Returns: OSSLWEN?


AMSLWEN

Arguments:

No Arguments Taken

Example:

AMSLWEN  

I2C Command Number:


Description

Reads the Slew Rate Enabled state of the Amplifier Temperature Control


AMSLWEN

Arguments:

[Int]   0 = OFF  1 = ON 

Example:

AMSLWEN ON 
AMSLWEN ON

I2C Command Number:


Description

Sets the Slew Rate Enabled state of the Amplifier Temperature Control Returns: AMSLWEN?


CATILIM

Arguments:

No Arguments Taken

Example:

CATILIM  

I2C Command Number:


Description

Reads the Cavity Temperature Control Current Limit [A]


CATILIM

Arguments:

[Float] Current Limit 

Example:

CATILIM 0.6 
CATILIM 0.6

I2C Command Number:


Description

Sets the Cavity Temperature Control Current Limit [A] Returns: CATILIM?


OSTILIM

Arguments:

No Arguments Taken

Example:

OSTILIM  

I2C Command Number:


Description

Reads the Oscillator Temperature Control Current Limit [A]


OSTILIM

Arguments:

[Float] Current Limit 

Example:

OSTILIM 0.500000 
OSTILIM 0.500000

I2C Command Number:


Description

Sets the Oscillator Temperature Control Current Limit [A] Returns: OSTILIM?


AMTILIM

Arguments:

No Arguments Taken

Example:

AMTILIM  

I2C Command Number:


Description

Reads the Amplifier Temperature Control Current Limit [A]


AMTILIM

Arguments:

[Float] Current Limit 

Example:

AMTILIM 0.5 
AMTILIM 0.5

I2C Command Number:


Description

Sets the Amplifier Temperature Control Current Limit [A] Returns: AMTILIM?


CATPLIM

Arguments:

No Arguments Taken

Example:

CATPLIM  

I2C Command Number:


Description

Reads the Cavity Temperature Control Power Limit [W]


CATPLIM

Arguments:

[Float] Power Limit 

Example:

CATPLIM 7.000000 
CATPLIM 7.000000

I2C Command Number:


Description

Sets the Cavity Temperature Control Power Limit [W] Returns: CATPLIM?


OSTPLIM

Arguments:

No Arguments Taken

Example:

OSTPLIM  

I2C Command Number:


Description

Reads the Oscillator Temperature Control Power Limit [W]


OSTPLIM

Arguments:

[Float] Power Limit 

Example:

OSTPLIM 7 
OSTPLIM 7

I2C Command Number:


Description

Sets the Oscillator Temperature Control Power Limit [W] Returns: OSTPLIM?


AMTPLIM

Arguments:

No Arguments Taken

Example:

AMTPLIM  

I2C Command Number:


Description

Reads the Amplifier Temperature Control Power Limit [W]


AMTPLIM

Arguments:

[Float] Power Limit  

Example:

AMTPLIM 6.5 
AMTPLIM 6.5

I2C Command Number:


Description

Sets the Amplifier Temperature Control Power Limit [W] Returns: AMTPLIM?


CATWARN

Arguments:

No Arguments Taken

Example:

CATWARN  

I2C Command Number:


Description

Reads the Temperature Error Warning Threshold of the Cavity Temperature Control [mK]


CATWARN

Arguments:

[Float]  Warning Threshold 

Example:

CATWARN 1.0 
CATWARN 1.0

I2C Command Number:


Description

the Temperature Error Warning Threshold of the Cavity Temperature Control [mK] Returns: CATWARN?


OSTWARN

Arguments:

No Arguments Taken

Example:

OSTWARN  

I2C Command Number:


Description

Reads the Temperature Error Warning Threshold of the Oscillator Temperature Control [mK]


OSTWARN

Arguments:

[Float]  Warning Threshold 

Example:

OSTWARN 1.0 
OSTWARN 1.0

I2C Command Number:


Description

the Temperature Error Warning Threshold of the Oscillator Temperature Control [mK] Returns: OSTWARN?


AMTWARN

Arguments:

No Arguments Taken

Example:

AMTWARN  

I2C Command Number:


Description

Reads the Temperature Error Warning Threshold of the Amplifier Temperature Control [mK]


AMTWARN

Arguments:

[Float]  Warning Threshold 

Example:

AMTWARN 1.0 
AMTWARN 1.0

I2C Command Number:


Description

the Temperature Error Warning Threshold of the Amplifier Temperature Control [mK] Returns: AMTWARN?


CATMAX

Arguments:

No Arguments Taken

Example:

CATMAX  

I2C Command Number:


Description

Reads the Maximum Temperature Limit of the Cavity Temperature Control [C]


CATMAX

Arguments:

[Float]  Maximum Temperature 

Example:

CATMAX 40.0 
CATMAX 40.0

I2C Command Number:


Description

Sets the Maximum Temperature Limit of the Cavity Temperature Control [C] Returns: CATMAX?


OSTMAX

Arguments:

No Arguments Taken

Example:

OSTMAX  

I2C Command Number:


Description

Reads the Maximum Temperature Limit of the Oscillator Temperature Control [C]


OSTMAX

Arguments:

[Float]  Maximum Temperature 

Example:

OSTMAX 30.0 
OSTMAX 30.0

I2C Command Number:


Description

Sets the Maximum Temperature Limit of the Oscillator Temperature Control [C] Returns: OSTMAX?


AMTMAX

Arguments:

No Arguments Taken

Example:

AMTMAX  

I2C Command Number:


Description

Reads the Maximum Temperature Limit of the Amplifier Temperature Control [C]


AMTMAX

Arguments:

[Float]  Maximum Temperature 

Example:

AMTMAX 30.0 
AMTMAX 30.0

I2C Command Number:


Description

Sets the Maximum Temperature Limit of the Amplifier Temperature Control [C] Returns: AMTMAX?


CATMIN

Arguments:

No Arguments Taken

Example:

CATMIN  

I2C Command Number:


Description

Reads the Minimum Temperature Limit of the Cavity Temperature Control [C]


CATMIN

Arguments:

[Float]  Minimum Temperature 

Example:

CATMIN -4.0 
CATMIN -4.0

I2C Command Number:


Description

Sets the Minimum Temperature Limit of the Cavity Temperature Control [C] Returns: CATMIN?


OSTMIN

Arguments:

No Arguments Taken

Example:

OSTMIN  

I2C Command Number:


Description

Reads the Minimum Temperature Limit of the Oscillator Temperature Control [C]


OSTMIN

Arguments:

[Float]  Minimum Temperature 

Example:

OSTMIN -4.0 
OSTMIN -4.0

I2C Command Number:


Description

Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C] Returns: OSTMIN?


AMTMIN

Arguments:

No Arguments Taken

Example:

AMTMIN  

I2C Command Number:


Description

Reads the Minimum Temperature Limit of the Amplifier Temperature Control [C]


AMTMIN

Arguments:

[Float]  Minimum Temperature 

Example:

AMTMIN -4.0 
AMTMIN -4.0

I2C Command Number:


Description

Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C] Returns: AMTMIN?


CASDTIM

Arguments:

No Arguments Taken

Example:

CASDTIM  

I2C Command Number:


Description

Reads the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Cavity Temperature Control


CASDTIM

Arguments:

[Float] Seconds 

Example:

CASDTIM 5.0 
CASDTIM 5.0

I2C Command Number:


Description

Sets the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Cavity Temperature Control Returns: CASDTIM?


OSSDTIM

Arguments:

No Arguments Taken

Example:

OSSDTIM  

I2C Command Number:


Description

Reads the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Oscillator Temperature Control


OSSDTIM

Arguments:

[Float] Seconds 

Example:

OSSDTIM 5.0 
OSSDTIM 5.0

I2C Command Number:


Description

Sets the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Oscillator Temperature Control Returns: OSSDTIM?


AMSDTIM

Arguments:

No Arguments Taken

Example:

AMSDTIM  

I2C Command Number:


Description

Reads the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Amplifier Temperature Control


AMSDTIM

Arguments:

[Float] Seconds 

Example:

AMSDTIM 5.0 
AMSDTIM 5.0

I2C Command Number:


Description

Sets the Number of Seconds Until Temperature Control Shuts Down When Temperature Exceeds a Maximum or Minimum for Amplifier Temperature Control Returns: AMSDTIM?


Laser Current Controls

OSISETP

Arguments:

No Arguments Taken

Example:

OSISETP  

I2C Command Number:


Description

Reads the Current Setpoint for the Oscillator Laser [mA]


OSISETP

Arguments:

[Float]  Laser Current Setpoint

Example:

OSISETP 850 
OSISETP 850

I2C Command Number:


Description

Sets the Current Setpoint for the Oscillator Laser [mA] Returns: OSISETP?


AMISETP

Arguments:

No Arguments Taken

Example:

AMISETP  

I2C Command Number:


Description

Reads the Current Setpoint for the Amplifier Laser [mA]


AMISETP

Arguments:

[Float]  Laser Current Setpoint

Example:

AMISETP 1400.0 
AMISETP 1400.0

I2C Command Number:


Description

Sets the Current Setpoint for the Amplifier Laser [mA] Returns: AMISETP?


OSCCURR

Arguments:

No Arguments Taken

Example:

OSCCURR  

I2C Command Number:


Description

Reads the Laser Current Output for the Oscillator [mA]


AMPCURR

Arguments:

No Arguments Taken

Example:

AMPCURR  

I2C Command Number:


Description

Reads the Laser Current Output for the Amplifier [mA]


OSCILIM

Arguments:

No Arguments Taken

Example:

OSCILIM  

I2C Command Number:


Description

Reads the Laser Current Limit for the Oscillator [mA]


OSCILIM

Arguments:

[Float]   Current Limit 

Example:

OSCILIM 1000 
OSCILIM 1000

I2C Command Number:


Description

Sets the Laser Current Limit for Oscillator [mA] Returns: OSCILIM?


AMCILIM

Arguments:

No Arguments Taken

Example:

AMCILIM  

I2C Command Number:


Description

Reads the Laser Current Limit for the Amplifier [mA]


AMCILIM

Arguments:

[Float]  Current Limit 

Example:

AMCILIM 1575 
AMCILIM 1575

I2C Command Number:


Description

Sets the Laser Current Limit for Amplifier [mA] Returns: AMCILIM?


OSCPLIM

Arguments:

No Arguments Taken

Example:

OSCPLIM  

I2C Command Number:


Description

Reads the Laser Power Limit for the Oscillator [W]


OSCPLIM

Arguments:

[Float]  Power Limit 

Example:

OSCPLIM 10 
OSCPLIM 10

I2C Command Number:


Description

Sets the Laser Power Limit for Oscillator [W] Returns: OSCPLIM?


AMCPLIM

Arguments:

No Arguments Taken

Example:

AMCPLIM  

I2C Command Number:


Description

Reads the Laser Power Limit for the Amplifier [W]


AMCPLIM

Arguments:

[Float]  Power Limit 

Example:

AMCPLIM 10 
AMCPLIM 10

I2C Command Number:


Description

Sets the Laser Power Limit for Amplifier [W] Returns: AMCPLIM?


_OSCTLIMMAX

Arguments:

No Arguments Taken

Example:

_OSCTLIMMAX  

I2C Command Number:


Description

Reads the Oscillator Laser Temperature Upper Limit [°C] (Laser is shut down if exceeded)


_OSCTLIMMAX

Arguments:

[Float]  Laser Temperature Upper Limit

Example:

_OSCTLIMMAX 33.5 
_OSCTLIMMAX 33.5

I2C Command Number:


Description

Sets the Oscillator Laser Temperature Upper Limit [°C] (Laser is shut down if exceeded) Returns: _OSCTLIMMAX?


_AMPTLIMMAX

Arguments:

No Arguments Taken

Example:

_AMPTLIMMAX  

I2C Command Number:


Description

Reads the Amplifier Laser Temperature Upper Limit [°C] (Laser is shut down if exceeded)


_AMPTLIMMAX

Arguments:

[Float]  Laser Temperature Upper Limit

Example:

_AMPTLIMMAX 33.5 
_ AMPTLIMMAX 33.5

I2C Command Number:


Description

Sets the Amplifier Laser Temperature Upper Limit [°C] (Laser is shut down if exceeded) Returns: _ AMPTLIMMAX?


_OSCTLIMMIN

Arguments:

No Arguments Taken

Example:

_OSCTLIMMIN  

I2C Command Number:


Description

Reads the Oscillator Laser Temperature Lower Limit [°C] (Laser is shut down if exceeded)


_OSCTLIMMIN

Arguments:

[Float]  Laser Temperature Lower Limit

Example:

_OSCTLIMMIN 5.5 
_OSCTLIMMIN 5.5

I2C Command Number:


Description

Sets the Oscillator Laser Temperature Lower Limit [°C] (Laser is shut down if exceeded) Returns: _OSCTLIMMIN?


_AMPTLIMMIN

Arguments:

No Arguments Taken

Example:

_AMPTLIMMIN  

I2C Command Number:


Description

Reads the Amplifier Laser Temperature Lower Limit [°C] (Laser is shut down if exceeded)


_AMPTLIMMIN

Arguments:

[Float]  Laser Temperature Lower Limit

Example:

_AMPTLIMMIN 5.5 
_ AMPTLIMMIN 5.5

I2C Command Number:


Description

Sets the Amplifier Laser Temperature Lower Limit [°C] (Laser is shut down if exceeded) Returns: _ AMPTLIMMIN?


Laser PZT Controls

CADCBSP

Arguments:

No Arguments Taken

Example:

CADCBSP  

I2C Command Number:


Description

Reads the DC Bias Setpoint for the Cavity [V]


CADCBSP

Arguments:

[Float]   Voltage 

Example:

CADCBSP 60 
CADCBSP 60

I2C Command Number:


Description

Sets the DC Bias Setpoint for the Cavity [V] Returns: CADCBSP?


CADCBV

Arguments:

No Arguments Taken

Example:

CADCBV  

I2C Command Number:


Description

Reads the PZT Voltage Output for the Cavity [V]


VLIM

Arguments:

No Arguments Taken

Example:

VLIM  

I2C Command Number:


Description

Reads the DC Bias Setpoint Limit for the Cavity [V]


VLIM

Arguments:

[Float]  Voltage 

Example:

VLIM 90 
VLIM 90

I2C Command Number:


Description

Sets the DC Bias Setpoint Limit for the Cavity [V] Returns: VLIM?


Mode Lock Controls

MLDCTHR

Arguments:

No Arguments Taken

Example:

MLDCTHR  

I2C Command Number:


Description

Reads the Mode Lock DC Threshold Parameter [mV]


MLDCTHR

Arguments:

[Float] Voltage 

Example:

MLDCTHR 6000 
MLDCTRH 6000 [mV]

I2C Command Number:


Description

Sets the Mode Lock DC Threshold Parameter [mV] Returns: MLDCTHR?


MLRMTHR

Arguments:

No Arguments Taken

Example:

MLRMTHR  

I2C Command Number:


Description

Reads the Mode Lock RMS Threshold Parameter [mV]


MLRMTHR

Arguments:

[Float] Voltage 

Example:

MLRMTHR 110 
MLRMTHR 110 [mV]

I2C Command Number:


Description

Sets the Mode Lock RMS Threshold Parameter [mV] Returns: MLRMTHR?


MLSMPLM

Arguments:

No Arguments Taken

Example:

MLSMPLM  

I2C Command Number:


Description

Reads the Mode Lock Sample Limit


MLSMPLM

Arguments:

[Int] Limit 

Example:

MLSMPLM 250 
MLSMPLM 250

I2C Command Number:


Description

Sets the Mode Lock Sample Limit Returns: MLSMPLM?


MODELOK

Arguments:

No Arguments Taken

Example:

MODELOK  

I2C Command Number:


Description

Reads the Mode Lock Status [Off/On]


#MLSTATS

Arguments:

[Int] State 

Example:

#MLSTATS ON 
#MLSTATS ON

I2C Command Number:


Description

Enables / Disables Touch Screen Display of Mode Lock Mean and Standard Deviation Returns: ON or OFF in response to argument


ffc/100/api.txt · Last modified: 2023/11/30 21:32 by 127.0.0.1