> ## 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.

# Working with Integrations

> Add, configure, start, and monitor integrations on a gateway

Every integration follows the same lifecycle on the **Integrations** page: add it, configure it, start it, and watch its health. This page covers what is the same for all of them.

To have Atomscale do the setup for you, click **Ask assistant**. Tell the [Gateway assistant](https://docs.atomscale.ai/gateway/assistant.md#set-up-an-integration) what you want to connect. It can install the integration and apply its settings after you approve the changes.

After setup, [link the integrations to their Growth Instrument](https://docs.atomscale.ai/gateway/data.md#link-integrations-to-the-growth-instrument)
so Atomscale groups recordings from the same growth. To manage integrations from a browser, see
[Remote Management](https://docs.atomscale.ai/gateway/remote-management.md). If data is missing, see
[Trace the Data Path](https://docs.atomscale.ai/gateway/reference/troubleshooting.md#trace-the-data-path).

```text theme={null}
 Add ──► Configure ──► Apply ──► Start ──► Running
          ▲                                  │
          └──────────── Stop ◄───────────────┘
```

## Available Integrations

| Integration | Collects | Setup |
| - | - | - |
| **RHEED Camera (GenTL)** | Live RHEED frames from a GigE Vision or GenTL camera, while your RHEED software runs it | [RHEED Camera](https://docs.atomscale.ai/gateway/rheed.md) |
| **kSA 400** | RHEED frames from k-Space kSA 400's Image Streamer | [kSA 400](https://docs.atomscale.ai/gateway/rheed/ksa-400.md) |
| **Tool Log Streamer** | Tool state from CSV or EpiTrend logs your tool's control software writes | [Tool Logs](https://docs.atomscale.ai/gateway/tool-state.md) |
| **FilmSense FS-1** | Dynamic ellipsometry measurements from a Film Sense FS-1 | [FilmSense FS-1](https://docs.atomscale.ai/gateway/filmsense.md) |
| **File Watcher** | Files an instrument saves to a folder | [File Watcher](https://docs.atomscale.ai/gateway/file-watcher.md) |

The catalog in the app shows which of them you can add on this computer.

## Add an Integration

**1. Open the catalog**

Open Integrations (in the icon rail in Full mode, or the sidebar in Data Ingestion mode) and click Add Integration.

**2. Add it**

Click Add on the integration. The app downloads it and
verifies its checksum. If a required setting has no default, such as the Tool Log Streamer's
log folder, the configuration page opens with Configure it to start. Otherwise the
integration's page opens with Start it when ready. To run a second copy, for example for a
second camera or log folder, click Add another. To tell the
copies apart, click a copy's name to rename it.

A disabled catalog entry shows its reason in amber: Application update required (update the desktop app first, see [Updates](https://docs.atomscale.ai/gateway/updates.md)), Not available on this platform, or Version has been revoked.

## Configure It

The **Configure Integration** page shows the settings most installations need. A few controls appear on every integration:

| Control | Use |
| - | - |
| Setup guide | Opens this guide's page for the integration's type, inside the app. |
| Show advanced settings | Reveals tuning and troubleshooting settings. Hidden values are still saved. |
| Import configuration | Loads settings from a `.json` file, such as one copied from another gateway. Review the form, then apply. Tool log parsing schemas are not imported. |
| Copy configuration | Copies the current settings as JSON, for a backup or a support request. |
| Apply Configuration | Validates and saves the settings. |

Some fields have their own button. A folder field has Browse, and the RHEED camera's **Camera IP Address** has Detect.

If you leave a field with the placeholder **Auto** blank, the integration sets its value. While it runs, the field shows that value next to Managed. To set the value yourself, enter it. To let the integration set it again, click Auto Manage. Changes take effect when you apply.

When you click Apply Configuration, the integration checks the settings. A rejected field is highlighted with the reason; if it is an advanced setting, Show advanced settings turns on so you can see it. Applying saves the configuration but doesn't start the integration. To start it, click ← Details at the top right, then Start Integration.

A running integration's configuration is read-only. Stop it to make changes.

## Start and Stop

Click Start Integration on the integration's page. The app remembers your choice: integrations you started start again automatically whenever the app opens, and integrations you stopped stay stopped.

Rename an integration by clicking its name at the top of its page, for example to tell two cameras apart.

## Watch It Run

Click an integration in the **Integrations** table to open its page.

| Section | Shows |
| - | - |
| **Details** | The connector, its description, its type, and its installed version. |
| **Health** | **Status**, **Last successful upload**, and **Running since**. While it runs, an integration that reports its own health shows a health summary above them, with a summary such as Receiving 30.0 fps (recording limit off). and any decisions it made for you. See [Health Verdicts](#health-verdicts). |
| **Upload Queue** | Data waiting to upload. See [Uploads and Buffering](https://docs.atomscale.ai/gateway/uploads.md). |
| **Activity Logs** | Events from the last 24 hours, with search and filters. Actions taken from the web app carry a Remote badge with the requester's email. Clear logs only clears the list on screen; Open logs directory opens the files. |

The Standard / Advanced selector at the top switches to diagnostics that support usually asks for:

| Section | Fields |
| - | - |
| **Process** | Started at, Host PID, Restarts, Last crash, Next restart |
| **Delivery** | Gateway queue depth, Oldest queued item, Retry attempt, Next retry, Last upload error, Last dropped delivery |
| **Host** | Disk free, Install path, State directory |
| **Contract** | Protocol version, Config version |

### Health Verdicts

| Verdict | Meaning |
| - | - |
| Healthy | Data arrives whole and is being recorded. |
| Tuning | The integration is starting, or adjusting Auto values to the data it sees. Wait. |
| Idle | Running, but nothing to record right now, for example while the instrument isn't acquiring. The detail line says why. |
| Degraded | Some data is being lost. The details recommend a fix. |
| Not capturing | Capture stopped after a fault. The activity log has the cause. |

### Statuses

| Status | Meaning | What to do |
| - | - | - |
| Starting | Launching. | Wait. |
| Running | Collecting and uploading. | Nothing. |
| Not configured | Stopped, and a required setting is missing. | Click Configure, fill in the settings, and apply. |
| Stopped | Not running. | Start it when ready. |
| Uploads paused | Collecting, but not uploading because no one from the owning organization is signed in. | Sign in. See [Keep the Gateway Running](https://docs.atomscale.ai/gateway/keep-running.md). |
| Paused | The integration paused collection itself. | The activity log gives the reason. |
| Error | A problem it couldn't recover from. | Read the activity log, fix the cause, then stop and start it. |
| Quarantined | It crashed 5 times within 10 minutes, so the app stopped restarting it. Before that, it restarts automatically after 1 second, doubling the wait up to 30 seconds. | Find the cause in the activity log, often a configuration value, a missing folder, or a disconnected device. Fix it, then click Resume Integration. |
| Protocol error | The integration and the desktop app couldn't communicate. | Update both, then restart the integration. |
| Revoked | Atomscale withdrew this version, and it won't run. | Update or uninstall it. |
| Update available | A newer version can be installed. | See [Updates](https://docs.atomscale.ai/gateway/updates.md). |

If the page says Fix the following to start this integration:, the saved configuration is incomplete or no longer valid, for example after an update added a required field, or Start found several cameras and needs you to pick one. Click Choose next to an issue, or open Configure, fix the highlighted fields, and apply.

## Uninstall an Integration

Stop the integration, open Configure, and turn on Show advanced settings. Under **Danger zone**, click Uninstall integration and confirm.

> [!WARNING]
>
> Uninstalling deletes the integration's upload queue, including data that has not been uploaded
> yet. Check its **Upload Queue** first.


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