Zequent

Framework Setup

Set up your project to work with the Zequent platform: pick the SDK you need, add it, and point it at your Zequent installation.

Zequent has two SDKs:

  • The Client SDK is for your own applications: look up assets, send commands, run Applications and Skills, and stream live data.
  • The Edge SDK is for adapters: the piece of software that connects a device (drone, dock, sensor, ...) to the platform.

Before you start

You need:

  • A Zequent installation and the addresses of its services: Remote Control (8002), Live Data (8003), Mission Autonomy (8004) and Connector (8010).
  • A credential, issued by an organization administrator in the Admin Console under Manage → Access & Integrations → Credentials:
    • a client credential for an application (ZQNT_CLIENT_TOKEN);
    • an edge adapter credential for an adapter (ZQNT_EDGE_TOKEN), plus the platform's public key (ZQNT_PLATFORM_PUBLIC_KEY).
  • GitHub access to the Zequent SDK repositories. The SDKs are distributed through GitHub.

Prerequisites

  • Java 21 or higher
  • Maven 3.6 or higher

Step 1: Configure package access

The Java SDKs are published to GitHub Packages. Add your GitHub credentials to Maven's settings.xml:

<!-- ~/.m2/settings.xml -->
<settings>
  <servers>
    <server>
      <id>github</id>
      <username>YOUR_GITHUB_USERNAME</username>
      <password>YOUR_GITHUB_TOKEN</password>
    </server>
  </servers>
</settings>

Create the token under GitHub Settings → Tokens with the read:packages scope.

Step 2: Add the SDK

Client SDK

<dependency>
    <groupId>com.zqnt.sdk</groupId>
    <artifactId>client-java-sdk</artifactId>
    <version>2.0.0</version>
</dependency>

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/Zequent/zqnt-client-sdk-java</url>
    </repository>
</repositories>

Edge SDK

<dependency>
    <groupId>com.zqnt.sdk</groupId>
    <artifactId>edge-java-sdk</artifactId>
    <version>2.0.0</version>
</dependency>

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/Zequent/zqnt-edge-sdk-java</url>
    </repository>
</repositories>

Step 3: Configure

For a client application, create a .env file in your project root:

ZQNT_CLIENT_TOKEN=<your client credential>

REMOTE_CONTROL_SERVICE_HOST=localhost
REMOTE_CONTROL_SERVICE_PORT=8002
LIVE_DATA_SERVICE_HOST=localhost
LIVE_DATA_SERVICE_PORT=8003
MISSION_AUTONOMY_SERVICE_HOST=localhost
MISSION_AUTONOMY_SERVICE_PORT=8004
CONNECTOR_SERVICE_HOST=localhost
CONNECTOR_SERVICE_PORT=8010

Replace localhost with the addresses of your installation. An adapter is configured in its application.properties — see the Edge SDK Quick Start.

Next steps

Was this page helpful?