Zequent Client SDK — Remote Control API Reference

Exhaustive method reference for client.remoteControl(). For a narrative introduction, response semantics, and worked examples, see the Remote Control guide.

Every method targets a single asset by serial number (sn), and returns a CompletableFuture. RemoteControlResponse/TakeoffResponse/CustomCommandResponse all use isSuccess() + getError().getErrorMessage() — see Functional Responses for what success actually confirms.

Flight ops

MethodReturnsPurpose
takeoff(TakeoffRequest)TakeoffResponseTake off and fly to a target lat/lon/altitude
goTo(GoToRequest)RemoteControlResponseFly to a target lat/lon/altitude
returnToHome(ReturnToHomeRequest)RemoteControlResponseReturn to home, optionally at a given altitude
lookAt(LookAtRequest)RemoteControlResponsePoint the gimbal/camera at a lat/lon/altitude

missionId/taskId on TakeoffRequest/GoToRequest are optional — set them to correlate the command with a mission/task you already created via Connector.

Manual control

MethodReturnsPurpose
enterManualControl(ManualControlRequest)RemoteControlResponseTake exclusive manual control of an asset
exitManualControl(ManualControlRequest)RemoteControlResponseRelease manual control
startManualControlInput(sn, assetId)ManualControlInputSessionOpen a gRPC streaming session for continuous stick input — not a CompletableFuture; call sendInput repeatedly, then complete()

Dock & asset ops

All of these take a DockOperationRequest (sn, assetId, optional value) except liveStreamSplitScreen, and all return RemoteControlResponse.

Methodvalue meaning
openCover(DockOperationRequest)ignored
closeCover(DockOperationRequest)true forces the close
startCharging(DockOperationRequest)ignored
stopCharging(DockOperationRequest)ignored
rebootAsset(DockOperationRequest)ignored
bootSubAsset(DockOperationRequest)true/false — boot the paired sub-asset on or off
debugMode(DockOperationRequest)true/false — enable/disable debug mode
changeAcMode(DockOperationRequest)ignored
takePhoto(DockOperationRequest)ignored
liveStreamSplitScreen(LiveStreamSplitScreenRequest)enabled (true/false) — toggle split-screen live view

Capabilities & custom commands

MethodReturnsPurpose
getCapabilities(String sn)CapabilitySnapshotLive capability snapshot — every command this asset currently supports, including vendor-defined ones with no built-in method
sendCustomCommand(CustomCommandRequest)CustomCommandResponseInvoke a command by id, e.g. from a CapabilityDescriptor via the forCapability factory

CapabilitySnapshot.snapshotState is e.g. CAPABILITY_SNAPSHOT_STATE_CURRENT or ..._STALE (stale when the asset is unreachable). Each CapabilityDescriptor carries: commandId, displayName, description, state, unavailableReason (set when state isn't available), targetType (ASSET/SUB_ASSET/PAYLOAD/COMPONENT), targetRef, schemaVersion, and metadata/constraints/inputSchema/outputSchema maps describing the command's parameters.

Was this page helpful?