Edge SDK -- Models Reference

This document provides a comprehensive reference for all request, response, and data models used in the Zequent Edge SDK.

Table of Contents

• Command Models
  • CommandResult
  • CurrentCapabilities
  • Capability
• Flight Control Models
  • TakeOffRequest
  • ReturnToHomeRequest
  • GoToRequest
  • Coordinates
• Manual Control Models
  • ManualControlRequest
  • ManualControlInput
• Camera and Gimbal Models
  • LookAtRequest
  • ChangeLensRequest
  • ChangeZoomRequest
• Live Streaming Models
  • LiveStreamStartRequest
  • LiveStreamStopRequest
• Telemetry Models
  • TelemetryRequestData
  • TelemetryData
  • AssetDetails
  • SubAssetDetails
• Mission Models
  • MissionData
• Configuration Models
  • EdgeClientConfig

Command Models

CommandResult

The universal return type for all EdgeAdapterService commands.

Package: com.zqnt.sdk.edge.adapter.domains

CommandResultType enum:

Factory methods:

// Success
CommandResult.success("Message", sn)
CommandResult.success("Message", tid, sn)

// Accepted — still running asynchronously
CommandResult.success("Message", vendorExecutionId, sn)   // vendor id rides on the transaction id

// Error
CommandResult.error("Error message", sn)
CommandResult.error("Error message", tid, sn)

// Not implemented (used internally by default methods)
CommandResult.notImplemented("Not supported", sn)

Utility methods:

boolean isNotImplemented()  // returns true if resultType == NOT_IMPLEMENTED

CurrentCapabilities

Reports the set of capabilities that an adapter currently supports.

Package: com.zqnt.sdk.edge.adapter.domains

Factory methods:

// Empty capabilities
CurrentCapabilities.empty(sn)

// With specific capabilities
CurrentCapabilities.of(sn, AssetTypeEnum.ASSET_TYPE_DOCK, capabilitySet)

Capability

Describes a single capability of the adapter.

Package: com.zqnt.sdk.edge.adapter.domains

Flight Control Models

TakeOffRequest

Request to initiate takeoff.

Package: com.zqnt.sdk.edge.adapter.domains

ReturnToHomeRequest

Request to return the sub-asset (drone) to its home position.

Package: com.zqnt.sdk.edge.adapter.domains

GoToRequest

Request to navigate to specific coordinates.

Package: com.zqnt.sdk.edge.adapter.domains

Coordinates

Geographic coordinates.

Package: com.zqnt.sdk.edge.adapter.domains

Manual Control Models

ManualControlRequest

Request to enter or exit manual control mode.

Package: com.zqnt.sdk.edge.adapter.domains

ManualControlInput

A single frame of joystick/stick input for controlling the device in real-time.

Package: com.zqnt.sdk.edge.adapter.domains

This model supports the @Builder pattern:

ManualControlInput input = ManualControlInput.builder()
    .sn("DEVICE_SN")
    .roll(0.0f)
    .pitch(0.5f)
    .yaw(0.0f)
    .throttle(0.3f)
    .gimbalPitch(-0.2f)
    .build();

Camera and Gimbal Models

LookAtRequest

Request to point the camera at specific coordinates.

Package: com.zqnt.sdk.edge.adapter.domains

ChangeLensRequest

Request to switch the active camera lens.

Package: com.zqnt.sdk.edge.adapter.domains

ChangeZoomRequest

Request to adjust the camera zoom level.

Package: com.zqnt.sdk.edge.adapter.domains

Live Streaming Models

LiveStreamStartRequest

Request to start a video live stream.

Package: com.zqnt.sdk.edge.adapter.domains

LiveStreamStopRequest

Request to stop a video live stream.

Package: com.zqnt.sdk.edge.adapter.domains

Telemetry Models

TelemetryRequestData

Top-level wrapper for pushing telemetry data to the Live Data Service.

Package: com.zqnt.sdk.edge.adapter.domains

Supports the @Builder pattern:

TelemetryRequestData data = TelemetryRequestData.builder()
    .sn("DEVICE_SN")
    .tid(UUID.randomUUID().toString())
    .timestamp(LocalDateTime.now())
    .telemetry(telemetryData)
    .build();

TelemetryData

Unified asset and sub-asset telemetry. Exactly one of asset / subAsset must be set — which one determines getSourceType() (ASSET, SUB_ASSET, or UNSPECIFIED if neither/both are set). Position and movement fields that both an asset and a sub-asset can report (latitude, longitude, absoluteAltitude, relativeAltitude, windSpeed, heading) live directly on TelemetryData, not duplicated per source type.

asset and subAsset describe the source/context of the reading — which entity it is about — not a device category. An Asset is the registered top-level entity (a drone, dock, ground vehicle, sensor gateway, camera or station); a SubAsset is an optional child entity belonging to an Asset. Set .asset(...) when the reading describes the Asset itself, including when that Asset is the drone, and .subAsset(...) when it describes a child SubAsset. A drone registered directly as an Asset therefore correctly reports sourceType = ASSET with subAsset left null. See Assets & Sub-Assets for worked examples of both configurations.

Package: com.zqnt.utils.edge.sdk.domains

validate() throws IllegalArgumentException if id/timestamp/sn are missing, or if asset/subAsset aren't set to exactly one.

TelemetryData telemetry = TelemetryData.builder()
    .id(UUID.randomUUID().toString())
    .timestamp(LocalDateTime.now())
    .sn("DOCK-1")          // or a standalone drone's own SN, e.g. "SIM-DRONE-001"
    .latitude(47.3769)
    .longitude(8.5417)
    .absoluteAltitude(450.0f)
    .asset(assetDetails)   // or .subAsset(subAssetDetails) — exactly one
    .build();

AssetDetails

Telemetry describing the registered top-level Asset itself. Nested under TelemetryData.asset.

This is a superset covering every kind of Asset, so not every field applies to every device. A dock populates the enclosure and climate fields (coverState, airConditioner, insideTemp, workingVoltage); a standalone drone registered as an Asset leaves those null and populates only what it physically has. Leaving inapplicable fields null is correct behaviour, not incomplete telemetry.

SubAssetDetails

Telemetry specific to a sub-asset (drone, vehicle). Nested under TelemetryData.subAsset.

Nested types

SubAssetInformation:

NetworkInformation:

AirConditioner:

BatteryInformation:

PayloadTelemetry:

ComponentTelemetryData (one entry per physical component/payload on a sub-asset):

CameraData:

RangeFinderData:

SensorData:

PositionState:

WirelessLinkInformation and SdrState carry low-level 4G/SDR link diagnostics (frequency band, quality, link state) — populate them only if your device actually reports this level of detail; both are optional.

Mission Models

MissionData

Represents a mission returned by the Mission Autonomy Service.

Package: com.zqnt.sdk.edge.adapter.domains

Configuration Models

EdgeClientConfig

The edge adapter configuration interface, mapped from application.properties with @ConfigMapping(prefix = "zequent.edge").

Package: com.zqnt.sdk.edge.config

Access these values in your code via the EdgeClient bean:

@Inject
EdgeClient edgeClient;

String sn = edgeClient.getSn();
EdgeClientConfig config = edgeClient.getConfig();
Duration timeout = config.timeout();

Or inject EdgeClientConfig directly:

@Inject
EdgeClientConfig config;

String sn = config.sn();
AssetTypeEnum type = config.assetType();