Zequent Framework Edge SDK

The Edge SDK provides the foundation for building Edge Adapters that connect physical assets (drones, docks, vehicles, and other remote devices) to the Zequent Framework ecosystem. By implementing the interfaces defined in this SDK, each vendor-specific edge adapter exposes a uniform set of commands and data streams that the platform and its Client SDK consumers can use without any knowledge of the underlying hardware.

Tech Specs

Architecture Overview

The Edge SDK sits between the physical device and the Zequent platform services. An edge adapter is a standalone Quarkus application that depends on the Edge SDK library and provides concrete implementations for the commands relevant to its hardware.

Core Concepts

EdgeClient

The central entry point of the SDK. It is a CDI-managed bean that gives you access to the configured serial number, edge configuration, and the EdgeAdapterService instance.

EdgeAdapterService

The primary interface that every edge adapter must implement. It declares commands for flight control, dock management, camera operations, manual control, live streaming, task execution, and more. All methods come with a default NOT_IMPLEMENTED return so you only need to override what your hardware supports.

ConnectorService

Provides CRUD operations against the platform's Connector Service over gRPC. Use it to register and manage assets, missions, tasks, schedulers, waypoints, and organizations.

LiveDataService

Manages persistent gRPC telemetry streams. It lets you push asset and sub-asset telemetry data to the Live Data Service using either the POJO-based API or the raw Proto-based API.

MissionAutonomyService

Communicates with the Mission Autonomy Service over gRPC to create, update, and retrieve missions, tasks, and schedulers.

Available Documentation

Quick Start

Add the Edge SDK dependency to your project:

<dependency>
  <groupId>com.zequent.framework.edge.sdk</groupId>
  <artifactId>java-edge-sdk</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Configure your edge in application.properties:

zequent.edge.endpoint=localhost:9001
zequent.edge.sn=YOUR_DEVICE_SERIAL_NUMBER
zequent.edge.asset-type=ASSET_TYPE_DOCK
zequent.edge.asset-vendor=DJI

Implement the adapter interface:

@ApplicationScoped
public class MyEdgeAdapter implements EdgeAdapterService {

    @Override
    public CompletableFuture<CommandResult> takeOff(TakeOffRequest request) {
        // your hardware-specific takeoff logic
        return CompletableFuture.completedFuture(
            CommandResult.success("Takeoff initiated", request.getSn())
        );
    }

    // override only the commands your device supports
}

Run the application:

./mvnw quarkus:dev

For a complete walkthrough, see the Quickstart Guide.