* Quick-Start Guides
* Electronics
* Websites
* Downloads
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:
For most complete version of API, download the FFC-Serial API PDF from the downloads section.
Arguments:
No Arguments Taken
Example:
#Version 255.255 255.255 0.16 65535 (0.16 is version)
I2C Command Number:
Arguments:
No Arguments Taken
Example:
#SAVESETTINGS #SAVESETTINGS
I2C Command Number:
Arguments:
No Arguments Taken
Example:
#Scbklt #SCBKLT
I2C Command Number:
Arguments:
[Int] level (0 – 20)
Example:
#Scbklt 3 #SCBKLT 3
I2C Command Number:
Arguments:
No Arguments Taken
Example:
#Scvol #SCVOL
I2C Command Number:
Arguments:
[Int] level (0 – 20)
Example:
#Scvol 8 #SCVOL 8
I2C Command Number:
Arguments:
No Arguments Taken
Example:
Vescent Photonics,FFC,[serial#],S-[version],FL-[version],LD-[version],LD-[version] I2C Command Number:
Arguments:
No Arguments Taken
Example:
Resetting System I2C Command Number:
Arguments:
No Arguments Taken
Example:
MSTRCTL MSTRCTL
I2C Command Number:
Arguments:
[Int] MODE
Example:
MSTRCTL 1 MSTRCTL 1
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATCTRL CATCTRL
I2C Command Number:
Arguments:
[Int] State
Example:
CATCTRL 1 CATCTRL 1
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTCTRL OSTCTRL
I2C Command Number:
Arguments:
[Int] State
Example:
OSTCTRL 3 OSTCTRL 3
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTCTRL AMTCTRL
I2C Command Number:
Arguments:
[Int] State
Example:
AMTCTRL 1 AMTCTRL 1
I2C Command Number:
Arguments:
No Arguments Taken
Example:
INTERLK INTERLK
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATSETP CATSETP
I2C Command Number:
Arguments:
[Float] Temperature
Example:
CATSETP 24.5 CATSETP 24.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTSETP OSTSETP
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTSETP OSTSETP 24.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTSETP AMTSETP
I2C Command Number:
Arguments:
[Float] Temperature
Example:
AMTSETP 24.5 AMTSETP 24.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVTEMP CAVTEMP
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCTEMP OSCTEMP
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPTEMP AMPTEMP
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVTERR CAVTERR
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCTERR OSCTERR
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPTERR AMPTERR
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCTECI OSCTECI
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPTECI AMPTECI
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVBETA CAVBETA
I2C Command Number:
Arguments:
[Float] Coefficient
Example:
CAVBETA 3500 CAVBETA 3500
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCBETA OSCBETA
I2C Command Number:
Arguments:
[Float] Coefficient
Example:
OSCBETA 3500 OSCBETA 3500
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPBETA AMPBETA
I2C Command Number:
Arguments:
[Float] Coefficient
Example:
AMPBETA 3500 AMPBETA 3500
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVREFT CAVREFT
I2C Command Number:
Arguments:
[Float] Temperature
Example:
CAVREFT 20 CAVREFT 20
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCREFT OSCREFT
I2C Command Number:
Arguments:
[Float] Temperature
Example:
OSCREFT 20 OSCREFT 20
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPREFT AMPREFT
I2C Command Number:
Arguments:
[Float] Temperature
Example:
AMPREFT 20 AMPREFT 20
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVREFR CAVREFR
I2C Command Number:
Arguments:
[Float] Resistance
Example:
CAVREFR 30000 CAVREFR 30000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCREFR OSCREFR
I2C Command Number:
Arguments:
[Float] Resistance
Example:
OSCREFR 30000 OSCREFR 30000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPREFR AMPREFR
I2C Command Number:
Arguments:
[Float] Resistance
Example:
AMPREFR 30000 AMPREFR 30000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVCOFA CAVCOFA
I2C Command Number:
Arguments:
[Float] Coefficient A
Example:
CAVCOFA 0.000722 CAVCOFA 0.000722
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVCOFB CAVCOFB
I2C Command Number:
Arguments:
[Float] Coefficient B
Example:
CAVCOFB 0.000286 CAVCOFB 0.000286
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVCOFC CAVCOFC
I2C Command Number:
Arguments:
[Float] Coefficient C
Example:
CAVCOFC 0.000001 CAVCOFC 0.000001
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCCOFA OSCCOFA
I2C Command Number:
Arguments:
[Float] Coefficient A
Example:
OSCCOFA 0.000684 OSCCOFA 0.000684
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCCOFB OSCCOFB
I2C Command Number:
Arguments:
[Float] Coefficient B
Example:
OSCCOFB 0.000286 OSCCOFB 0.000286
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCCOFC OSCCOFC
I2C Command Number:
Arguments:
[Float] Coefficient C
Example:
OSCCOFC 0.000001 OSCCOFC 0.000001
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPCOFA AMPCOFA
I2C Command Number:
Arguments:
[Float] Coefficient A
Example:
AMPCOFA 0.000684 AMPCOFA 0.000684
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPCOFB AMPCOFB
I2C Command Number:
Arguments:
[Float] Coefficient B
Example:
AMPCOFB 0.000286 AMPCOFB 0.000286
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPCOFC AMPCOFC
I2C Command Number:
Arguments:
[Float] Coefficient C
Example:
AMPCOFC 0.000001 AMPCOFC 0.000001
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVPROP CAVPROP
I2C Command Number:
Arguments:
[Float] Proportional Gain
Example:
CAVPROP 7.500000 CAVPROP 7.500000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVINT CAVINT
I2C Command Number:
Arguments:
[Float] Integral Gain
Example:
CAVINT 2.0 CAVINT 2.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVDERV CAVDERV
I2C Command Number:
Arguments:
[Float] Derivative
Example:
CAVDERV 0.5 CAVDERV 0.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCPROP OSCPROP
I2C Command Number:
Arguments:
[Float] Proportional Gain
Example:
OSCPROP 7.500000 OSCPROP 7.500000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCINT OSCINT
I2C Command Number:
Arguments:
[Float] Integral Gain
Example:
OSCINT 2.0 OSCINT 2.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCDERV OSCDERV
I2C Command Number:
Arguments:
[Float] Derivative
Example:
OSCDERV 0.5 OSCDERV 0.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPPROP AMPPROP
I2C Command Number:
Arguments:
[Float] Proportional Gain
Example:
AMPPROP 7.500000 AMPPROP 7.500000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPINT AMPINT
I2C Command Number:
Arguments:
[Float] Integral Gain
Example:
AMPINT 2.0 AMPINT 2.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPDERV AMPDERV
I2C Command Number:
Arguments:
[Float] Derivative
Example:
AMPDERV 0.5 AMPDERV 0.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAPROEN CAPROEN
I2C Command Number:
Arguments:
[Int] 0 = OFF 1 = ON
Example:
CAPROEN OFF CAPROEN OFF
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSPROEN OSPROEN
I2C Command Number:
Arguments:
[Int] 0 = OFF 1 = ON
Example:
OSPROEN OFF OSPROEN OFF
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPROEN AMPROEN
I2C Command Number:
Arguments:
[Int] 0 = OFF 1 = ON
Example:
AMPROEN OFF AMPROEN OFF
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CAVSLEW CAVSLEW
I2C Command Number:
Arguments:
[Float] Slew Rate
Example:
CAVSLEW 3.5 CAVSLEW 3.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCSLEW OSCSLEW
I2C Command Number:
Arguments:
[Float] Slew Rate
Example:
OSCSLEW 3.5 OSCSLEW 3.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPSLEW AMPSLEW
I2C Command Number:
Arguments:
[Float] Slew Rate
Example:
AMPSLEW 3.5 AMPSLEW 3.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CASLWEN CASLWEN
I2C Command Number:
Arguments:
[Int] 0 = OFF 1 = ON
Example:
CASLWEN ON CASLWEN ON
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSSLWEN OSSLWEN
I2C Command Number:
Arguments:
[Int] 0 = OFF 1 = ON
Example:
OSSLWEN ON OSSLWEN ON
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMSLWEN
I2C Command Number:
Arguments:
[Int] 0 = OFF 1 = ON
Example:
AMSLWEN ON AMSLWEN ON
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATILIM
I2C Command Number:
Arguments:
[Float] Current Limit
Example:
CATILIM 0.6 CATILIM 0.6
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTILIM
I2C Command Number:
Arguments:
[Float] Current Limit
Example:
OSTILIM 0.500000 OSTILIM 0.500000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTILIM
I2C Command Number:
Arguments:
[Float] Current Limit
Example:
AMTILIM 0.5 AMTILIM 0.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATPLIM
I2C Command Number:
Arguments:
[Float] Power Limit
Example:
CATPLIM 7.000000 CATPLIM 7.000000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTPLIM
I2C Command Number:
Arguments:
[Float] Power Limit
Example:
OSTPLIM 7 OSTPLIM 7
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTPLIM
I2C Command Number:
Arguments:
[Float] Power Limit
Example:
AMTPLIM 6.5 AMTPLIM 6.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATWARN
I2C Command Number:
Arguments:
[Float] Warning Threshold
Example:
CATWARN 1.0 CATWARN 1.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTWARN
I2C Command Number:
Arguments:
[Float] Warning Threshold
Example:
OSTWARN 1.0 OSTWARN 1.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTWARN
I2C Command Number:
Arguments:
[Float] Warning Threshold
Example:
AMTWARN 1.0 AMTWARN 1.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATMAX
I2C Command Number:
Arguments:
[Float] Maximum Temperature
Example:
CATMAX 40.0 CATMAX 40.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTMAX
I2C Command Number:
Arguments:
[Float] Maximum Temperature
Example:
OSTMAX 30.0 OSTMAX 30.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTMAX
I2C Command Number:
Arguments:
[Float] Maximum Temperature
Example:
AMTMAX 30.0 AMTMAX 30.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CATMIN
I2C Command Number:
Arguments:
[Float] Minimum Temperature
Example:
CATMIN -4.0 CATMIN -4.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSTMIN
I2C Command Number:
Arguments:
[Float] Minimum Temperature
Example:
OSTMIN -4.0 OSTMIN -4.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMTMIN
I2C Command Number:
Arguments:
[Float] Minimum Temperature
Example:
AMTMIN -4.0 AMTMIN -4.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CASDTIM
I2C Command Number:
Arguments:
[Float] Seconds
Example:
CASDTIM 5.0 CASDTIM 5.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSSDTIM
I2C Command Number:
Arguments:
[Float] Seconds
Example:
OSSDTIM 5.0 OSSDTIM 5.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMSDTIM
I2C Command Number:
Arguments:
[Float] Seconds
Example:
AMSDTIM 5.0 AMSDTIM 5.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSISETP
I2C Command Number:
Arguments:
[Float] Laser Current Setpoint
Example:
OSISETP 850 OSISETP 850
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMISETP
I2C Command Number:
Arguments:
[Float] Laser Current Setpoint
Example:
AMISETP 1400.0 AMISETP 1400.0
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCCURR
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMPCURR
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCILIM
I2C Command Number:
Arguments:
[Float] Current Limit
Example:
OSCILIM 1000 OSCILIM 1000
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMCILIM
I2C Command Number:
Arguments:
[Float] Current Limit
Example:
AMCILIM 1575 AMCILIM 1575
I2C Command Number:
Arguments:
No Arguments Taken
Example:
OSCPLIM
I2C Command Number:
Arguments:
[Float] Power Limit
Example:
OSCPLIM 10 OSCPLIM 10
I2C Command Number:
Arguments:
No Arguments Taken
Example:
AMCPLIM
I2C Command Number:
Arguments:
[Float] Power Limit
Example:
AMCPLIM 10 AMCPLIM 10
I2C Command Number:
Arguments:
No Arguments Taken
Example:
_OSCTLIMMAX
I2C Command Number:
Arguments:
[Float] Laser Temperature Upper Limit
Example:
_OSCTLIMMAX 33.5 _OSCTLIMMAX 33.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
_AMPTLIMMAX
I2C Command Number:
Arguments:
[Float] Laser Temperature Upper Limit
Example:
_AMPTLIMMAX 33.5 _ AMPTLIMMAX 33.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
_OSCTLIMMIN
I2C Command Number:
Arguments:
[Float] Laser Temperature Lower Limit
Example:
_OSCTLIMMIN 5.5 _OSCTLIMMIN 5.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
_AMPTLIMMIN
I2C Command Number:
Arguments:
[Float] Laser Temperature Lower Limit
Example:
_AMPTLIMMIN 5.5 _ AMPTLIMMIN 5.5
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CADCBSP
I2C Command Number:
Arguments:
[Float] Voltage
Example:
CADCBSP 60 CADCBSP 60
I2C Command Number:
Arguments:
No Arguments Taken
Example:
CADCBV
I2C Command Number:
Arguments:
No Arguments Taken
Example:
VLIM
I2C Command Number:
Arguments:
[Float] Voltage
Example:
VLIM 90 VLIM 90
I2C Command Number:
Arguments:
No Arguments Taken
Example:
MLDCTHR
I2C Command Number:
Arguments:
[Float] Voltage
Example:
MLDCTHR 6000 MLDCTRH 6000 [mV]
I2C Command Number:
Arguments:
No Arguments Taken
Example:
MLRMTHR
I2C Command Number:
Arguments:
[Float] Voltage
Example:
MLRMTHR 110 MLRMTHR 110 [mV]
I2C Command Number:
Arguments:
No Arguments Taken
Example:
MLSMPLM
I2C Command Number:
Arguments:
[Int] Limit
Example:
MLSMPLM 250 MLSMPLM 250
I2C Command Number:
Arguments:
No Arguments Taken
Example:
MODELOK
I2C Command Number:
Arguments:
[Int] State
Example:
#MLSTATS ON #MLSTATS ON
I2C Command Number: