> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atomscale.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# FilmSense FS-1

> Stream FilmSense FS-1 ellipsometer measurements to Atomscale

The **FilmSense FS-1** integration watches a Film Sense ellipsometer over its network command interface (FS-API) and streams each dynamic measurement run to Atomscale as an ellipsometry data item. It only observes: you start and stop measurements in the Film Sense software, and the integration never changes the instrument's model or acquisition settings. Stopping the integration doesn't stop acquisition on the instrument.

For the steps every integration shares, see [Working with Integrations](https://docs.atomscale.ai/gateway/integrations.md).

## How a Run Is Captured

* **Run start**: Every **Polling Interval**, the integration asks the FS-1 whether dynamic measurements are being acquired. When acquisition starts, a new run begins.
* **Measurements**: Each dynamic measurement point, with its fitted parameters and the instrument's `Time`, becomes one row. Rows are uploaded in chunks of **Points per Chunk**, released every **Delivery Interval**.
* **Run end**: The run ends once acquisition has stopped and no new points have arrived for **Idle Timeout**, so trailing measurements are still collected.
* **In Atomscale**: Each run becomes one ellipsometry data item named `filmsense_` followed by the run's start time in Unix milliseconds.

With **Raw Dynamic Export** on, the integration also downloads the instrument's native dynamic data file during the run (at most once per **Raw Export Interval**) and again when the run ends. With **Upload Final Native Copy** on, the final file is stored as a separate ellipsometry item linked to the streamed run.

## Before You Start

* The desktop app on Windows 10 or later. The Atomscale CLI doesn't run this integration.
* Film Sense software version 3.77 or higher on the FS-1, which the FS-API requires.
* The gateway on the same local network as the FS-1, either with an Ethernet cable directly to the ellipsometer or through a network switch or router. By default the FS-1 answers at `169.254.1.1` (or `fs.local`) on TCP port `4000`.
* If you changed the FS-1's hostname or set a static IP address in the Film Sense software, use that address instead.

## Set Up the Integration

To have the [Gateway assistant](https://docs.atomscale.ai/gateway/assistant.md#set-up-an-integration) install and configure FilmSense FS-1, give it the instrument's address and port. Use **Test connection** in the configuration form to verify the connection.

**1. Add the integration**

Open **Integrations**, click Add Integration, and click
Add on **FilmSense FS-1**. Add one copy per instrument.

**2. Enter the instrument address**

Set **Instrument Host** and **Instrument Port**. The defaults, `169.254.1.1` and `4000`, match
an FS-1 with its factory network settings.

**3. Test the connection**

Click Test connection in the **Instrument Host** field. It
sends the FS-API communication check, which doesn't change anything on the instrument. If it
fails, the reason appears under the field.

**4. Apply and start**

Click Apply Configuration, then
Start Integration.

**5. Verify with a run**

Start dynamic measurements in the Film Sense software. The integration's **Activity Logs**
show FilmSense run started, and FilmSense run ended after acquisition stops and the idle
timeout passes.

> [!NOTE]
>
> To try the integration without creating new uploads, turn on Dry Run. Runs are captured on the
> gateway only. Data already queued for upload is still delivered.

## Settings Reference

| Field | Default | Description |
| - | - | - |
| **Instrument Host** | `169.254.1.1` | Hostname or IP address of the FS-1. Required. |
| **Instrument Port** | 4000 | TCP port of the FS-API command interface, from 1 to 65535. |
| **Polling Interval** | 1 second | Seconds between status checks for new measurements. |
| **Delivery Interval** | 10 seconds | Seconds between releasing recorded chunks for upload. |
| **Points per Chunk** | 25 | Measurement rows per chunk, from 1 to 100,000. Only the final chunk of a run can be shorter. |
| **Idle Timeout** | 30 seconds | Seconds acquisition must stay stopped with no new points before a run ends. |
| **Dry Run** | Off | Captures locally without creating uploads for new runs. |
| **Raw Dynamic Export** | Off | Also captures the native dynamic data file during and after runs. Capture during a run depends on the instrument firmware. |
| **Raw Export Interval** | 60 seconds | Shown when **Raw Dynamic Export** is on. Minimum seconds between native file downloads during a run. |
| **Upload Final Native Copy** | On | Shown when **Raw Dynamic Export** is on. Stores the complete final native file as a separate ellipsometry item. |
| **Upload Backlog Size Limit**, **Free Disk Space To Keep** (advanced) | Auto, 1 GB | See [Disk Buffering](https://docs.atomscale.ai/gateway/uploads.md#disk-buffering). |

All interval and timeout fields accept 0.001 to 86,400 seconds.

## Troubleshooting

Check the integration's **Activity Logs** on the gateway.

| Message or symptom | Cause and fix |
| - | - |
| connect to FilmSense *host*:*port*: … | The gateway can't reach the FS-1. Check the cable or network connection, and the **Instrument Host** and **Instrument Port** values. |
| FilmSense poll failed; retrying: … | A status or measurement read failed during polling. The integration reconnects and retries on its own. |
| FilmSense dynamic point missing Time; using local clock instead | The measurement results don't include `Time`, so rows are placed by the gateway computer's clock. |
| Instrument history changed; closing the previous stream without attaching replacement data | The FS-1's dynamic data was reset or replaced, for example by a new acquisition, before the previous run ended. The earlier run is closed with the data captured so far. |
| Periodic native capture failed; retrying: … | A native file download during the run failed, for example because the firmware doesn't support it while acquiring. It's retried, and a final capture is attempted when the run ends. |
| Raw capture incomplete after three attempts; retained snapshots and recorded rows remain available | The final native file couldn't be downloaded. Measurement rows already recorded are kept. |
| FilmSense delivery retained for retry | Handing data to the gateway's upload queue failed. It's kept and retried. See [Uploads and Buffering](https://docs.atomscale.ai/gateway/uploads.md). |
| A run never appears in Atomscale | Check that **Dry Run** is off, then follow [Trace the Data Path](https://docs.atomscale.ai/gateway/reference/troubleshooting.md#trace-the-data-path). |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.