fcc:100:api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
fcc:100:api [2021/10/18 22:54] – external edit 127.0.0.1 | fcc:100:api [2021/10/18 23:17] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 42: | Line 42: | ||
For most complete version of API, download the FFC-Serial API PDF from the [[fcc: | For most complete version of API, download the FFC-Serial API PDF from the [[fcc: | ||
- | =====New Table===== | + | =====General Commands===== |
< | < | ||
Returns firmware version of master board where arguments are used as follows: | Returns firmware version of master board where arguments are used as follows: | ||
Line 65: | Line 65: | ||
Sets the touch screen and rotary knob audio feedback volume | Sets the touch screen and rotary knob audio feedback volume | ||
---- | ---- | ||
- | < | + | < |
Returns the Manufacturer, | Returns the Manufacturer, | ||
---- | ---- | ||
- | < | + | < |
Restarts the device (power cycle) | Restarts the device (power cycle) | ||
---- | ---- | ||
Line 79: | Line 79: | ||
- | =====New Table===== | + | =====Control API===== |
< | < | ||
Returns the enumerated operating mode of the FFC | Returns the enumerated operating mode of the FFC | ||
Line 163: | Line 163: | ||
- | =====New Table===== | + | =====Temperature Controls===== |
< | < | ||
Returns the temperature setpoint for the Cavity Temperature Control | Returns the temperature setpoint for the Cavity Temperature Control | ||
Line 212: | Line 212: | ||
Reads the Thermistor Beta Coefficient for Cavity Temperature Control | Reads the Thermistor Beta Coefficient for Cavity Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Thermistor Beta Coefficient for Cavity Temperature Control | Sets the Thermistor Beta Coefficient for Cavity Temperature Control | ||
Returns CAVBETA? | Returns CAVBETA? | ||
Line 278: | Line 278: | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart A Thermistor coefficient for Cavity Temperature Control | Sets the Steinhart-Hart A Thermistor coefficient for Cavity Temperature Control | ||
Returns CAVCOFA? | Returns CAVCOFA? | ||
Line 287: | Line 287: | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart B Thermistor coefficient for Cavity Temperature Control | Sets the Steinhart-Hart B Thermistor coefficient for Cavity Temperature Control | ||
Returns CAVCOFB? | Returns CAVCOFB? | ||
Line 294: | Line 294: | ||
Reads the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control | Reads the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control | Sets the Steinhart-Hart C Thermistor coefficient for Cavity Temperature Control | ||
Returns CAVCOFC? | Returns CAVCOFC? | ||
Line 301: | Line 301: | ||
Reads the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control | Reads the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control | Sets the Steinhart-Hart A Thermistor coefficient for Oscillator Temperature Control | ||
Returns OSCCOFA? | Returns OSCCOFA? | ||
Line 310: | Line 310: | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart B Thermistor coefficient for Oscillator Temperature Control | Sets the Steinhart-Hart B Thermistor coefficient for Oscillator Temperature Control | ||
Returns OSCCOFB? | Returns OSCCOFB? | ||
Line 317: | Line 317: | ||
Reads the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control | Reads the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control | Sets the Steinhart-Hart C Thermistor coefficient for Oscillator Temperature Control | ||
Returns OSCCOFC? | Returns OSCCOFC? | ||
Line 324: | Line 324: | ||
Reads the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control | Reads the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control | Sets the Steinhart-Hart A Thermistor coefficient for Amplifier Temperature Control | ||
Returns AMPCOFA? | Returns AMPCOFA? | ||
Line 331: | Line 331: | ||
Reads the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control | Reads the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control | Sets the Steinhart-Hart B Thermistor coefficient for Amplifier Temperature Control | ||
Returns AMPCOFB? | Returns AMPCOFB? | ||
Line 340: | Line 340: | ||
---- | ---- | ||
- | < | + | < |
Sets the Steinhart-Hart C Thermistor coefficient for Amplifier Temperature Control | Sets the Steinhart-Hart C Thermistor coefficient for Amplifier Temperature Control | ||
Returns AMPCOFC? | Returns AMPCOFC? | ||
Line 347: | Line 347: | ||
Reads the Proportional gain for Cavity Temperature Control | Reads the Proportional gain for Cavity Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Proportional gain for Cavity Temperature Control | Sets the Proportional gain for Cavity Temperature Control | ||
Returns CAVPROP? | Returns CAVPROP? | ||
Line 354: | Line 354: | ||
Reads the Integral gain for Cavity Temperature Control | Reads the Integral gain for Cavity Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the Integral gain for Cavity Temperature Control | Sets the Integral gain for Cavity Temperature Control | ||
Returns CAVINT? | Returns CAVINT? | ||
Line 362: | Line 362: | ||
---- | ---- | ||
- | < | + | < |
Sets the Derivative term for Cavity Temperature Control | Sets the Derivative term for Cavity Temperature Control | ||
Returns CAVDERV? | Returns CAVDERV? | ||
Line 370: | Line 370: | ||
---- | ---- | ||
- | < | + | < |
Sets the Proportional gain for Oscillator Temperature Control | Sets the Proportional gain for Oscillator Temperature Control | ||
Returns OSCPROP? | Returns OSCPROP? | ||
Line 379: | Line 379: | ||
---- | ---- | ||
- | < | + | < |
Sets the Integral gain for Oscillator Temperature Control | Sets the Integral gain for Oscillator Temperature Control | ||
Returns OSCINT? | Returns OSCINT? | ||
Line 388: | Line 388: | ||
---- | ---- | ||
- | < | + | < |
Sets the Derivative term for Oscillator Temperature Control | Sets the Derivative term for Oscillator Temperature Control | ||
Returns OSCDERV? | Returns OSCDERV? | ||
Line 397: | Line 397: | ||
---- | ---- | ||
- | < | + | < |
Sets the Proportional gain for Amplifier Temperature Control | Sets the Proportional gain for Amplifier Temperature Control | ||
Returns AMPPROP? | Returns AMPPROP? | ||
Line 406: | Line 406: | ||
---- | ---- | ||
- | < | + | < |
Sets the Integral gain for Amplifier Temperature Control | Sets the Integral gain for Amplifier Temperature Control | ||
Returns AMPINT? | Returns AMPINT? | ||
Line 415: | Line 415: | ||
---- | ---- | ||
- | < | + | < |
Sets the Derivative term for Amplifier Temperature Control | Sets the Derivative term for Amplifier Temperature Control | ||
Returns AMPDERV? | Returns AMPDERV? | ||
Line 422: | Line 422: | ||
Reads the enabled status of Proportional Gain for Cavity Temperature Control | Reads the enabled status of Proportional Gain for Cavity Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the enabled status of Proportional Gain for Cavity Temperature Control | Sets the enabled status of Proportional Gain for Cavity Temperature Control | ||
Returns CAPROEN? | Returns CAPROEN? | ||
Line 429: | Line 429: | ||
Reads the enabled status of Proportional Gain for Oscillator Temperature Control | Reads the enabled status of Proportional Gain for Oscillator Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the enabled status of Proportional Gain for Oscillator Temperature Control | Sets the enabled status of Proportional Gain for Oscillator Temperature Control | ||
Returns OSPROEN? | Returns OSPROEN? | ||
Line 436: | Line 436: | ||
Reads the enabled status of Proportional Gain for Amplifier Temperature Control | Reads the enabled status of Proportional Gain for Amplifier Temperature Control | ||
---- | ---- | ||
- | < | + | < |
Sets the enabled status of Proportional Gain for Amplifier Temperature Control | Sets the enabled status of Proportional Gain for Amplifier Temperature Control | ||
Returns AMPROEN? | Returns AMPROEN? | ||
Line 498: | Line 498: | ||
---- | ---- | ||
- | < | + | < |
Sets the Cavity Temperature Control Current Limit [A] | Sets the Cavity Temperature Control Current Limit [A] | ||
Returns: CATILIM? | Returns: CATILIM? | ||
Line 507: | Line 507: | ||
---- | ---- | ||
- | < | + | < |
Sets the Oscillator Temperature Control Current Limit [A] | Sets the Oscillator Temperature Control Current Limit [A] | ||
Returns: OSTILIM? | Returns: OSTILIM? | ||
Line 516: | Line 516: | ||
---- | ---- | ||
- | < | + | < |
Sets the Amplifier Temperature Control Current Limit [A] | Sets the Amplifier Temperature Control Current Limit [A] | ||
Returns: AMTILIM? | Returns: AMTILIM? | ||
Line 525: | Line 525: | ||
---- | ---- | ||
- | < | + | < |
Sets the Cavity Temperature Control Power Limit [W] | Sets the Cavity Temperature Control Power Limit [W] | ||
Returns: CATPLIM? | Returns: CATPLIM? | ||
Line 534: | Line 534: | ||
---- | ---- | ||
- | < | + | < |
Sets the Oscillator Temperature Control Power Limit [W] | Sets the Oscillator Temperature Control Power Limit [W] | ||
Returns: OSTPLIM? | Returns: OSTPLIM? | ||
Line 543: | Line 543: | ||
---- | ---- | ||
- | < | + | < |
Sets the Amplifier Temperature Control Power Limit [W] | Sets the Amplifier Temperature Control Power Limit [W] | ||
Returns: AMTPLIM? | Returns: AMTPLIM? | ||
Line 553: | Line 553: | ||
---- | ---- | ||
- | < | + | < |
the Temperature Error Warning Threshold of the Cavity Temperature Control [mK] | the Temperature Error Warning Threshold of the Cavity Temperature Control [mK] | ||
Returns: CATWARN? | Returns: CATWARN? | ||
Line 562: | Line 562: | ||
---- | ---- | ||
- | < | + | < |
the Temperature Error Warning Threshold of the Oscillator Temperature Control [mK] | the Temperature Error Warning Threshold of the Oscillator Temperature Control [mK] | ||
Returns: OSTWARN? | Returns: OSTWARN? | ||
Line 571: | Line 571: | ||
---- | ---- | ||
- | < | + | < |
the Temperature Error Warning Threshold of the Amplifier Temperature Control [mK] | the Temperature Error Warning Threshold of the Amplifier Temperature Control [mK] | ||
Returns: AMTWARN? | Returns: AMTWARN? | ||
Line 579: | Line 579: | ||
---- | ---- | ||
- | < | + | < |
Sets the Maximum Temperature Limit of the Cavity Temperature Control [C] | Sets the Maximum Temperature Limit of the Cavity Temperature Control [C] | ||
Returns: CATMAX? | Returns: CATMAX? | ||
Line 587: | Line 587: | ||
---- | ---- | ||
- | < | + | < |
Sets the Maximum Temperature Limit of the Oscillator Temperature Control [C] | Sets the Maximum Temperature Limit of the Oscillator Temperature Control [C] | ||
Returns: OSTMAX? | Returns: OSTMAX? | ||
Line 596: | Line 596: | ||
---- | ---- | ||
- | < | + | < |
Sets the Maximum Temperature Limit of the Amplifier Temperature Control [C] | Sets the Maximum Temperature Limit of the Amplifier Temperature Control [C] | ||
Returns: AMTMAX? | Returns: AMTMAX? | ||
Line 604: | Line 604: | ||
---- | ---- | ||
- | < | + | < |
Sets the Minimum Temperature Limit of the Cavity Temperature Control [C] | Sets the Minimum Temperature Limit of the Cavity Temperature Control [C] | ||
Returns: CATMIN? | Returns: CATMIN? | ||
Line 612: | Line 612: | ||
---- | ---- | ||
- | < | + | < |
Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C] | Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C] | ||
Returns: OSTMIN? | Returns: OSTMIN? | ||
Line 621: | Line 621: | ||
---- | ---- | ||
- | < | + | < |
Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C] | Sets the Minimum Temperature Limit of the Oscillator Temperature Control [C] | ||
Returns: AMTMIN? | Returns: AMTMIN? | ||
Line 657: | Line 657: | ||
- | =====New Table===== | + | =====Laser Current Controls===== |
< | < | ||
Reads the Current Setpoint for the Oscillator Laser [mA] | Reads the Current Setpoint for the Oscillator Laser [mA] | ||
---- | ---- | ||
- | < | + | < |
Sets the Current Setpoint for the Oscillator Laser [mA] | Sets the Current Setpoint for the Oscillator Laser [mA] | ||
Returns: OSISETP? | Returns: OSISETP? | ||
Line 671: | Line 671: | ||
---- | ---- | ||
- | < | + | < |
Sets the Current Setpoint for the Amplifier Laser [mA] | Sets the Current Setpoint for the Amplifier Laser [mA] | ||
Returns: AMISETP? | Returns: AMISETP? | ||
Line 697: | Line 697: | ||
---- | ---- | ||
- | < | + | < |
Sets the Laser Current Limit for Amplifier [mA] | Sets the Laser Current Limit for Amplifier [mA] | ||
Returns: AMCILIM? | Returns: AMCILIM? | ||
Line 706: | Line 706: | ||
---- | ---- | ||
- | < | + | < |
Sets the Laser Power Limit for Oscillator [W] | Sets the Laser Power Limit for Oscillator [W] | ||
Returns: OSCPLIM? | Returns: OSCPLIM? | ||
Line 715: | Line 715: | ||
---- | ---- | ||
- | < | + | < |
Sets the Laser Power Limit for Amplifier [W] | Sets the Laser Power Limit for Amplifier [W] | ||
Returns: AMCPLIM? | Returns: AMCPLIM? | ||
Line 725: | Line 725: | ||
---- | ---- | ||
- | < | + | < |
Sets the Oscillator Laser Temperature Upper Limit [°C] | Sets the Oscillator Laser Temperature Upper Limit [°C] | ||
(Laser is shut down if exceeded) | (Laser is shut down if exceeded) | ||
Line 736: | Line 736: | ||
---- | ---- | ||
- | < | + | < |
Sets the Amplifier Laser Temperature Upper Limit [°C] | Sets the Amplifier Laser Temperature Upper Limit [°C] | ||
(Laser is shut down if exceeded) | (Laser is shut down if exceeded) | ||
Line 747: | Line 747: | ||
---- | ---- | ||
- | < | + | < |
Sets the Oscillator Laser Temperature Lower Limit [°C] | Sets the Oscillator Laser Temperature Lower Limit [°C] | ||
(Laser is shut down if exceeded) | (Laser is shut down if exceeded) | ||
Line 758: | Line 758: | ||
---- | ---- | ||
- | < | + | < |
Sets the Amplifier Laser Temperature Lower Limit [°C] | Sets the Amplifier Laser Temperature Lower Limit [°C] | ||
(Laser is shut down if exceeded) | (Laser is shut down if exceeded) | ||
Line 772: | Line 772: | ||
- | =====New Table===== | + | =====Laser PZT Controls===== |
< | < | ||
Reads the DC Bias Setpoint for the Cavity [V] | Reads the DC Bias Setpoint for the Cavity [V] | ||
Line 802: | Line 802: | ||
- | =====New Table===== | + | =====Mode Lock Controls===== |
< | < | ||
Reads the Mode Lock DC Threshold Parameter [mV] | Reads the Mode Lock DC Threshold Parameter [mV] |