======FFC-CM Fiber Frequency Comb Module Quick Start Guide======

Document Last Updated on ~~LASTMOD~~

Please read [[:limited_warranty|Limited Warranty]] and [[:warnings_cautions|General Warnings and Cautions]] prior to operating the FFC-100.

{{d2:d2-100:class_iiib.png?nolink&200}}
<imgcaption ffc|The FFC-CM with a coffee mug for scale>{{ :ffc:microsoftteams-image.png?350|}}</imgcaption>

====Useful Links====
[[http://www.vescent.com/manuals/doku.php?id=manuals|Vescent manuals page]].\\
[[ffc:cm:api-ld|FFC-CM Laser Driver API]].\\
[[ffc:cm:api-osc|FFC-CM Fiber Laser/Oscillator API]].\\
[[https://www.vescent.com/products/lasers/ffc-100-frequency-comb/|FFC-CM web page]].\\
[[https://github.com/Vescent/FFC_Firmware_Upgrade-and-FPGA-Software-Firmware|Github page for FFC-100 firmware revisions]]
[[https://www.vescent.com/manuals/doku.php?id=ffc:100m|FFC-100 Manual]]\\
Please check back for added functionality.  Contact [[sales@vescent.com|sales [at] vescent [dot] com]] for questions and corrections, or to request added functionality.

===== Notice =====
| {{ :warning-sign.png?100&nolink }}  | Do not block the airflow vents on the side of the chassis or the fan inputs & outputs on either the FFC-100 or the SLICE-FPGA. |
|:::| The mode-lock indicator on the GUI front panel cannot detect CW breakthrough. Keep the oscillator current within the range specified in your product's final test documentation or CoC.  |

===== Proper Usage =====
| {{ :warning-sign.png?100&nolink }}  | If this instrument is used in a manner not specified by the manufacturer in this manual or other relevant literature, protection provided by the instrument may be impaired. |
|:::| Successful implementation of the FFC-CM depends critically on the design of the whole system: FFC-CM, phase locking electronics, and any references to which the FFC-CM is locked or //vice versa//. |

=====Purchase Includes=====
  * FFC-CM Fiber Frequency Comb Module
  * Power cord for your country (if known)
  * Instructions on how to download & install control software
  * Final Test Documentation
  * Other items depending on specific configuration

===== Absolute Maximum Ratings and Power Input =====
Note: All modules designed to be operated in a laboratory environment.

<WRAP center round box 60%><tabcaption abs_max_rat |Absolute Maximum Ratings>
| **Parameter** | **Rating** |
| Environmental Temperature | >15°C and <30°C|
| Environmental Humidity | <60% | 
| Environmental Dew Points | <15°C |
| Maximum AC Line Input Current | 2 A |
</tabcaption></WRAP>



=====Operating the FFC-CM=====
This document provides basic instructions on how to operate the Vescent Photonics FFC-CM Fiber Frequency Comb Module in conjunction with the Vescent SLICE-FPGA. It is important to note that the FFC-CM itself does not come with a built in GUI, and as such communication must be done through the [[ffc:cm:api-osc|Serial Command API]] or the [[ffc:comb_module_quickstart #FPGA Control|FPGA Software]]. This document will walk through usage of the Serial Command interface including  several basic commands, as well as using the FPGA Software to obtain and optimize your lock.

=====System Set-up=====

====Initial Connections====
To begin, connect the FFC-CM to power, turn it on, then connect it to a Windows 10 computer using the included USB Type-B to USB Type-A connector. The next few steps will walk through installing and verifying the SSH software required to communicate with the FFC-CM.

====Serial Command Interface====
To use the FFC-CM, you will first need to install SSH software for communicating via serial commands. Vescent recommends using either [[https://ttssh2.osdn.jp/index.html.en|Tera Term]] or [[https://www.putty.org/|PuTTy]], but there are a variety of other options. This guide will focus on connecting to the FFC-CM using Tera Term.

===Installing SSH Software===
To download Tera Term for Windows 10, follow [[https://osdn.net/projects/ttssh2/releases/|this link]], and click on the .exe file for the latest release (see <imgref download_TT>). You will be redirected to another page, where your download will begin automatically. Once the download is complete, launch the application from the downloads folder, and follow the instructions to configure Tera Term on your device. You do not need to select or deselect any of the optional packages.

<imgcaption download_TT|Tera Term Downloads Page>{{ :ffc:teraterm_install.png?500 |}}</imgcaption>

===Connecting to the Comb Module===
Once Tera Term is finished installing, launch the application. You will be shown a window like the one in <imgref TT_Open>. Check the "Serial" option and select the COM Port associated with your comb module. To find the correct COM Port, open the Device Manager, and expand the "Ports (COM & LPT)" drop-down. Unplug the USB Type-B to Type-A connector while watching the list of devices. The COM Port of the FFC-CM will be the one that disappears and re-appears. Click "OK" in the window.

<imgcaption TT_Open|Initial Tera Term Window>{{ :ffc:tera_term.png?400 |}}</imgcaption>

Next, navigate to "Setup --> Serial Port..." and change the "Speed" drop-down menu from 9600 to 115200 and click "New Setting" to save. Then navigate to "Setup --> Terminal..." and change both "Receive" and "Transmit" from "CR" to "CR+LF". Check "Local Echo" and then click "OK" to save the settings. 


<imgcaption Version|Verify that the FFC-CM is communicating with the Version command>{{ :ffc:version.png?400 |}}</imgcaption>

Finally, type ''Version'' into the terminal and hit enter to verify communication with the FFC-CM as shown in <imgref Version>. If the connection was successful, the return will be 8 bits showing the firmware version on the FFC-CM. 

===Sending Commands===
With the Serial Command interface set up now, you will be able to send individual commands to the FFC-CM by typing them directly into the terminal. During the initial verification and test setup of the FFC-CM, it is recommended to use the terminal interface as shown in this guide, though later it may be beneficial to write your own serial command scripts.

====FPGA Control====
The SLICE-FPGA dual-channel Offset Phase Lock Servo can be used to phase lock ƒ<sub>CEO</sub> and ƒ<sub>opt</sub>. Locking f<sub>opt</sub> requires a reference CW laser and heterodyne setup (such as a 50:50 beam splitter and DWDM filter). The stability of the lock will depend on the reference laser used. All performance data is collected with a Rio Planex laser.

===Installing FPGA Software===
To use the FPGA software you must download both WinPyton and the software itself. To install the software, follow [[https://github.com/Vescent/FFC-100_FPGA-Software-Firmware|this link]], click on "FPGA Software.zip", and then press the download button. Make sure to save the zip file to your computer, and not just open it. Extract the file to a directory which will be convenient to navigate to using a command line.

Next, install WinPython version 2.7.10.3 by following [[https://sourceforge.net/projects/winpython/files/WinPython_2.7/2.7.10.3/|this link]] and choosing the appropriate file for your system. Do **not** download the latest version of WinPython, as it will not work with the FPGA software.

<imgcaption WinPython_Download|Download Screen for WinPython. Choose one of the two options from within the red box.>{{ :ffc:winpython.png?500 |}}</imgcaption>

To check which of the two files is correct for your system, go to the windows search bar or hit the "Windows" key on your keyboard, and type "About your PC". The window shown in <imgref about> will appear, and you can find whether your computer is 32-bit or 64-bit. Choose the corresponding file from the download list in <imgref WinPython_Download>.

<imgcaption about|Check whether your operating system is 32-bit or 64-bit>{{ :ffc:about.png?500 |}}</imgcaption>

Open the WinPython folder and navigate to the site-packages directory: ''...\WPy64-3950\python-3.9.5.amd64\Lib\site-packages''. In a new window, open the FPGA Software folder and locate the file "ok". Copy this file from FPGA Software into the site-packages directory of WinPython. Close the WinPython folder, and open a command line or terminal. Navigate to the ''...\FPGA Software\FPGA Software'' directory in the terminal and run the command ''pip install PyVISA-1.8-py2.py3-none-any.whl''. 

<imgcaption pyvisa|A successful installation will look like this. >{{ :ffc:pyvisa_install.png?500 |}}</imgcaption>

Finally, go back to the FPGA Software folder in your file explorer and run both "FrontPanelUSB-Win-x64-4.5.6", and "vcredist_x64". Each will open their own installer. Follow the instructions on both and click finish. When both are done installing, your computer should be configured to run the FPGA software. 
=====Locking the FFC-CM=====
Before locking, it may be beneficial to familiarize yourself with the full list of API commands for the FFC-CM, which can be found [[ffc:cm:api-osc|here]], as well as the front and rear panel connections, which can be found in Figure 8. It is also important to note that, aside from those set in the FPGA software, all PID parameters come preset and should not need to be adjusted.

===Connections===
After initial verification of the FFC-CM with Tera Term, the system as a whole can be connected as shown in <imgref Diagram>. The USB "Optional Programming Interface" labeled "13" should already be connected to a Windows 10 machine, and should be left connected for the duration of this setup. Ensure that the FPGA remains off until [[ffc:comb_module_quickstart#Step 7: Power on and Set Up the FPGA|Step 7]]. In general, do not power on any components of the system until explicitly instructed to do so. Failing to follow the correct start-up order may damage your system.


<imgcaption Diagram|High Level Block Diagram of FFC-CM system>{{ :ffc:high_level_diagram.png?600 |}}</imgcaption>


===Step 1: Turn on TEC and HV PZT===
In the Tera Term terminal window, type ''Tempset? 0'' to check the setpoint temperature. If the return is not within the normal operating range of 20°C to 30°C, change the setpoint temperature to 25°C by typing ''Tempset 0 25.0''. Next, enable the oscillator cavity TEC by sending the ''Control 0 3'' command and turn on the HV PZT by sending ''Control 1 3''. Finally, wait 5-10 minutes for the TEC to stabilize. The current temperature of the TEC can be monitored with the ''Temp? 0'' command, and the error between the temperature and the setpoint temperature (in mK) with ''Terror? 0''. The TEC is stabilized when ''Terror? 0'' returns a value less than 0.1 mK.

===Step 2: Power Pump Diode Boards===
The actual I<sup>2</sup>C implementation of the Pump Diode boards has been left to the user, but in general it is at this time that the pump diode boards should be powered on and temperature stabilized. Do **not** supply current to the diodes themselves until their temperature has stabilized. If connections have not been made already, ensure that the OSC Out (Pump 1) and any EDFA Amplifiers (Pumps 2 and 3) on the Pump Diode Board have been connected to the FFC-CM as shown in <imgref Diagram>.

===Step 3: Power and Connect CW Laser===
It is essential that the FFC-CM be locked to an external reference, which should now be powered on and connected to the FFC-CM if it was not connected already. Follow the start-up procedure for your given CW reference laser.

Wrap this:
The maximum power input for CW in is 2mW. Exceeding this input power may damage your system.

===Step 4: Mode Lock the FFC-CM===
Connect the OSC Mon output to a spectrum analyzer or OSA. Check that the OSC pump diode's current setting is within the specified range of your CoC, and then enable current to the OSC pump. It is recommended to start near the middle of the specified current range, and then to increase the current until CW breakthrough can be observed on the spectrum in the form of a narrow peak forming above the broader curve. Once CW breakthrough is achieved, lower the current roughly 10 mA to give the system room to modulate for a lock.

<imgcaption ML_Spec|Example spectrum showing a mode locked system>{{ :ffc:boeingffc_system1_oscout.png?400 |}}</imgcaption>

Wrap this:
Should the current be increased too far, it is possible to enter a different mode locking regime as shown by the spectrum suddenly becoming visibly narrower than before. Should this occur, incrementally lower the current until the laser jumps back into the previous, wider, mode locking regime. There is a slight hysteresis in this process, so it is likely that you will need to lower the OSC pump current past the current where the regime changed and nearer the middle of the specified current range.

===Step 5: Verify Supercontinuum===
Now that the system is mode locked, turn on the EDFA/AMP pump diode and switch the monitored output to SC Out. Change your Spectrum Analyzer or OSA's window to span the 1-2 micron wavelength region and verify that the supercontinuum of your system matches that shown in your CoC. An example supercontinuum can be seen in <imgref SC>

<imgcaption SC|Example supercontinuum of the FCC-CM system>{{ :ffc:boeingffc_system1_scout.png?400 |}}</imgcaption>

===Step 6: Verify RF Output===
Connect the RF Mon output to a spectrum analyzer to verify that the RF output matches what is shown in your CoC. Set the spectrum analyzer's span to 1kHz-2GHz and look for a series of equally spaced peaks as shown in <imgref RF>. The first peak is the repetition rate of your FFC-CM, and the rest are harmonics.

<imgcaption RF|Example RF spectrum from the FFC-CM system with 100 MHz repetition rate>{{ :ffc:boeingffc_system1_freprfspec.png?400 |}}</imgcaption>

===Step 7: Power On and Set Up the FPGA===
After verifying the outputs of the FFC-CM, make connections to the FPGA as shown in <imgref Diagram> if they have not been made already, and turn the FPGA on. The FPGA will apply a modulation current to the oscillator, which if not accounted for properly in [[:ffc:comb_module_quickstart#Step 4: Mode Lock the FFC-CM|Step 4]] may cause your system to leave its mode lock regime. Open a WinPython terminal and navigate to the ''...\"FPGA Software"\"GUI and Firmware"'' folder then run ''python XEM_GUI3_VPv4.py'' to launch the FPGA software. A window will appear asking for initial configuration settings as shown in <imgref startup>. Ensure that "superlaserland_v12.bit" is selected for Fimware File, and check the "Send Firmware" and "Internal Clock (100 MHz)" boxes.

<imgcaption startup|Configuration window shown before FPGA software launches>{{ :ffc:fpga_startup.png?600 |}}</imgcaption>

Once the FPGA software launches, navigate to the "Filter Settings" tab and select "Narrowband (6MHz) for both channels. Finally, navigate to the "CEO Lock" tab, and input the PID parameters given in your CoC, then repeat for the "Optical Lock" tab.

<imgcaption PID|Location of CEO Lock PID parameter input fields>{{ :ffc:ceo_lock_pid_parameters.png?600 |}}</imgcaption>

===Step 8: CEO Lock===
Begin by navigating to the CEO Lock tab, then ensure that there is a visible beatnote displayed on the “Spectrum” plot. This will be an obvious peak above the noise floor which responds to adjustments of the “Offset DAC 0 [V]” slider as shown in <imgref CEO_1>. If a beatnote cannot be identified, check that the FFC-CM is still mode locked. Once a beatnote has been identified, adjust the “Offset DAC 0 [V]” slider such that the Baseband IQ plot is roughly circular, or the identified beatnote is between two of the dips on the spectrum plot corresponding to a bandpass filter.

<imgcaption CEO_1|Offset DAC location and Beatnote Example>{{ :ffc:ceo_lock_pt_1.png?600 |}}</imgcaption>

Determine the VCO sign of the system by very slightly increasing the "Offset DAC 0 [V]" slider. If the beatnote moves to the right the sign is positive. If it moves to the left the sign is negative. Check the appropriate VCO Sign checkbox shown in <imgref checkbox>, then press the "Lock" button. The system should quickly lock up, but if it does not check the opposite VCO sign check box and try again. If the system still does not lock, double check that the PID parameters were set to the values shown in your CoC.

<imgcaption checkbox|Location of the VCO Sign Checkboxes, and the "Lock" button.>{{ :ffc:ceo_lock_pt_2.png?600 |}}</imgcaption>

Once a lock has been obtained, the green plot of phase noise on the “Phase Noise PSD, std dev =” plot will show a dramatic reduction in noise from ƒCEO's unlocked state. This number is a good characterization of the stability of your lock. A good lock of ƒCEO is indicated by an integrated phase noise PSD less than 2 rad, but this value can be pushed down even further by adjusting the PID settings of your FFC-100.

Before adjusting the PID parameters, uncheck “Auto-refresh” at the top of the screen. Change the value of “RBW: 576 Hz; Points:” to “3e6”, then recheck “Auto-refresh” (figure 34). This will update the graph to plot more points and give a more accurate representation of the phase noise. It is important that Auto-Refresh be unchecked before making this adjustment, however, as doing so while the plot is refreshing may cause the FPGA software to crash. If this happens, simply relaunch the software and start again. 



====Slow Loop Feedback====
Slow loop functionality will be provided in a near-term software update.
  - Open your computer’s device manager from the control panel and find the COM port number for “STMicroelectronics”. Never assume that this number is the same as previous times. (If it doesn’t appear, make sure your computer is connected to the FFC.) 
  - Navigate to the “Slow Loop” tab in the GUI and enter the COM port number into “FFC COM Port”.
  - The PZT setpoint is set to an intermediate value (50V) to keep the servo from railing. This can be adjusted if desired.
  - Click “Activate Temperature Slow Loop”.