Product Manuals

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
=====FFC-CM Fiber Laser/Oscillator API=====

====Links====
* **Quick-Start Guides**
    * [[ffc:cm:quickstart|FFC-CM Quick Start]]

*  **Electronics**
    * [[ffc:cm:manual|FFC-CM Manual]]


*  **Websites**
    * [[https://vescent.com/us/ffc-100-frequency-comb.html|FFC-CM web page]]
    * [[https://github.com/Vescent/FFC_Firmware_Upgrade-and-FPGA-Software-Firmware|Github page for FFC-100 firmware revisions]]

*  **Downloads**
    * {{ :ffc:cm:ffc_gen2_osc_serial_command_api.docx |}}


=====Implementation Instructions=====

Listed below is the command set for the Application Programming Interface (API) for the FFC-100. Since the FFC-CM does not have a touch screen or GUI, all commands must 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     |  155200  |
^ 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-CM 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 [[ffc:cm:api-osc#Links|downloads]] section.