Release Version: AlphaRelease VersionAlpha


Setup Instructions

1. Prerequisites

SvanLINK devices expose a local API that uses token-based authentication. Before setting up the integration, confirm the following:

  1. You have access to a running SvanLINK server (local or remote).
  2. You know the server URL displayed in the SvanLINK application (e.g., http://localhost:8000).
  3. You know the SvanLINK password configured for the application.
  4. Your device is connected and visible in the SvanLINK interface.

Once you have these values, you can proceed to create your Credentials in IMSURGE.


2. Creating the Credentials

When adding your SvanLINK integration, you will be prompted to create or select a set of Credentials. To create them, you will provide:

  • SvanLINK Server URL - The base URL of your running SvanLINK server (e.g., http://localhost:8000).
  • SvanLINK Password - The password used to authenticate with the SvanLINK API.

IMSURGE will automatically authenticate with the API and handle token refresh when needed.


3. Creating the Integration

After creating or selecting your Credentials, you will need to configure the integration by selecting the following options:

  • Device - The SvanLINK device you want to query. This list is populated using the SvanLINK getStatus API and displays each device by its name and serial number.

Once configured, the integration will use the device serial number to fetch measurement results from the SvanLINK API during each pipeline execution.


Reference


Concerns & Limitations

  • No Historic Readings: This integration pulls live data only and cannot retrieve historical readings.
  • Polling Rate Configuration: The recommended polling rates are based on default device configurations. If you have customized your device’s settings, ensure your pipeline’s polling rate aligns with your device’s data update frequency.
  • Local Server Dependency: SvanLINK typically runs as a local application. Ensure the server is reachable from your pipeline environment.

External References