Flight
Returns flight information. Flight information contains properties that either do not change (ex. physical limitations) or change rarely (ex. legal restrictions).
- : Grants access to retrieve system data and information.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
Success execution
Flight information
Kite takeoff altitude (meters). The takeoff altitude is the altitude to which the Kite rises after takeoff. Important: The Kite cannot fly lower than the takeoff altitude.
Maximum altitude (hard limit) of the Fotokite system (meters). Hard limit dictated by system capabilities or legal restrictions. The Kite cannot fly higher than this altitude.
Maximum altitude (soft limit) of the Fotokite system (meters). This value can be set by an operator or API client to limit the maximum altitude of the Kite (ex. for safety reasons). This value resets on system reboot. The Kite cannot fly higher than this altitude.
Total Kite flight time (hours). This value can be used for maintenance purposes. Note: initial value can be greater than 0 due to pre-delivery testing.
GET /api/v1/flight/info HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Success execution
{
"altitude_takeoff": 1,
"altitude_hard_max": 45,
"altitude_soft_max": 10,
"total_kite_flight_hours": 15.3
}Returns frequently changing flight information.
- : Grants access to retrieve system data and information.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
Success execution
Represents frequently changing flight information. A property is not presented if it could not be gathered (for example due to a magnetometer or a GPS issue). Note: there is always a margin of error between the altitude_target and the altitude the Kite will take. And this error is not a constant.
Flight state enumeration
Unknown- We couldn't get required data to conclude flight sate. This may happen due to numerous reasons: Kite detached, Kite power is off, etc. More information can be found in notifications.StandBy- Kite is on the Ground StationTakingOff- Kite is doing preflight checks or taking offFlying- Kite is flyingLanding- Kite is landingSafetyLanding- Kite is landing due to a critical issue happened during the flight. More information can be found in notifications.SafetyDescending- Kite is descending for safety reasons (due to strong wind or weak GPS signal). More information can be found in notifications.
Current Kite altitude above the Ground Station (meters)
Target Kite altitude set by the user (meters)
Kite heading [0..+360) (degrees)
Whether Kite is rotating (changing heading) (ex. as a result of the rotation command). True - Kite is rotating
Whether Kite is changing altitude (ex. as a result of the set altitude command). True - Kite is changing altitude
Whether the data reported by the Kite GPS is useable
Latitude reported by Kite GPS [-90..+90] (degrees)
Longitude reported by Kite GPS (-180..+180] (degrees)
Elevation reported by Kite GPS (meters)
Kite GPS accuracy in meters
GET /api/v1/flight/state HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Success execution
{
"flight_state": "Flying",
"altitude": 40,
"altitude_target": 11,
"kite_heading": 98,
"is_rotating": false,
"is_changing_altitude": true,
"kite_gps_has_fix": true,
"kite_gps_lat": 47.3883959,
"kite_gps_lon": 8.5229581,
"kite_gps_elevation": 443,
"kite_gps_accuracy": 0.23
}- : Allows sending commands to control the system.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
The command was sent successfully
No content
Control is not allowed because somebody else is controlling the System.
The operation is not allowed in current state. Example: Rotation is not allowed during landing.
POST /api/v1/flight/control/take_off HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
- : Allows sending commands to control the system.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
The command was sent successfully
No content
Control is not allowed because somebody else is controlling the System.
The operation is not allowed in current state. Example: Rotation is not allowed during landing.
POST /api/v1/flight/control/land HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
- : Allows sending commands to control the system.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
The command was sent successfully
No content
Control is not allowed because somebody else is controlling the System.
The operation is not allowed in current state. Example: Rotation is not allowed during landing.
POST /api/v1/flight/control/abort HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
- : Allows sending commands to control the system.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
Control altitude request data
Sets target Kite altitude above the Ground Station (meters). Must not be lower than Kite takeoff altitude + 1 meter. But lower than both altitude_hard_limit and altitude_soft_limit. Note: there is always a margin of error between the altitude_target and the altitude the Kite will take. And this error is not a constant.
20The command was sent successfully
No content
Request parameter doesn't meet criteria
Control is not allowed because somebody else is controlling the System.
The operation is not allowed in current state. Example: Rotation is not allowed during landing.
The service is not ready yet. Usually this means that service didn't gather all the necessary information from subsystems.
POST /api/v1/flight/control/altitude HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"altitude": 20
}No content
Sets or updates the Kite flight max altitude (soft limit). If the Kite is airborne at an altitude above the new soft limit, it will automatically descend to comply with the new limit. Note: this value resets on system reboot.
- : Allows sending commands to control the system.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
Control altitude soft limit request data
Maximum altitude (soft limit)
20The command was sent successfully
No content
Request parameter doesn't meet criteria
Control is not allowed because somebody else is controlling the System.
The service is not ready yet. Usually this means that service didn't gather all the necessary information from subsystems.
POST /api/v1/flight/control/altitude_soft_max HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"altitude": 20
}No content
Last updated