Jump to Content

API Reference

Dronesmith API Reference

Dronesmith API Reference
Changelog
Local API

Drone Objects

Anatomy of a Drone Object
Name|Id
Offline Drones
/api/drone/get
/api/drone/{name|id}get
/api/drone/{name|id}delete
/api/drone/{name|id}put

Telemetry

Telemetry
/infoget
/statusget
/modeget
/gpsget
/attitudeget
/positionget
/motorsget
/ratesget
/targetget
/sensorsget
/homeget
/logget
/inputget

Virtual Drones

Virtual Drones
/{name}post
/{name|id}/startpost
/{name|id}/stoppost

Parameters

Parameters
/paramsget
/refreshget
/param/{param_name|index}get
/param/{param_name|index}post

Command & Control

Command & Control
/armpost
/disarmpost
/modepost
/takeoffpost
/landpost
/gotopost
/homepost
/inputpost
/commandpost

Missions

/missionget
/mission/{mission_id}get
/mission/{mission_id}delete

Directly Access a Drone

Directly Access a Drone
/ssh/openpost
/ssh/closepost

User Defined Sensors/Payloads

User Defined Sensors/Payloads
/sensor/{sensor_name}post
/sensor/{sensor_name}get

Powered by

Offline Drones

If the drone is no longer connected or responding to the API, any calls made to:

/api/drone/<id/name>/:endpoint

Will return a 400 status error indicating the drone is not online.