System
Returns system information.
- : Grants access to retrieve system data and information.
Plugin authentication using Bearer token. For more details, see Fotokite API Documentation.
Success execution
Represents system information
Identity of the Ground Station
G001ZHThe MAC address of the router WAN port
00:11:22:33:44:55Name of the Kite
K2020MFName of the Rooftop Box (RTB)
R001NDType of installation. Possible values:
Transport CaseTray MountRooftop BoxDev KitBare Ground Station
Rooftop BoxModel/generation of the Fotokite system
SigmaModel of the propellers used in the system. Possible values:
Propeller 1st GenerationPropeller 2nd Generation
Propeller 1st GenerationTimezone of the Fotokite system
Europe/ZurichShort name of the timezone
CESTOffset of the timezone
+02:00System software channel
productionSystem software release version number
59GET /api/v1/system/info HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Success execution
{
"gs_name": "G001ZH",
"gs_mac": "00:11:22:33:44:55",
"kite_name": "K2020MF",
"rtb_name": "R001ND",
"installation": "Rooftop Box",
"model": "Sigma",
"propeller_model": "Propeller 1st Generation",
"timezone": "Europe/Zurich",
"timezone_name_short": "CEST",
"timezone_offset": "+02:00",
"boards": [
{
"board": "GMC",
"id": "001111211136511134311FFF"
}
],
"software_channel": "production",
"software_version": "59",
"drone_id": {
"regulatory_mode": "US_REMOTE_ID_STANDARD",
"serial": "1898B0020G9132PH"
}
}Returns frequently changing system 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 system information
Kite backup battery charge level in percents [0..+100]
Ground Station backup battery charge level in percents [0..+100]
Ground Station input voltage (volts)
Whether the data reported by the Ground Station GPS is useable
Latitude reported by Ground Station GPS [-90..+90] (degrees)
Longitude reported by Ground Station GPS (-180..+180] (degrees)
Elevation reported by Ground Station GPS (meters)
Ground Station GPS accuracy in meters
Rooftop Box (RTB) lids state
State of the external safety land button connected to the Rooftop Box
State of the parking brake on the Rooftop Box. When the parking brake is engaged, the system will not take off.
GET /api/v1/system/state HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Success execution
{
"kite_battery_level": 100,
"gs_battery_level": 98,
"gs_input_voltage": 112,
"gs_gps_has_fix": true,
"gs_gps_lat": 47.3883959,
"gs_gps_lon": 8.5229581,
"gs_gps_elevation": 403,
"gs_gps_accuracy": 0.31,
"drone_id": {
"status": {
"status": "OK"
},
"error_codes": []
},
"rtb_lids_state": "Opened",
"rtb_external_safety_land_button_state": "NotPressed",
"rtb_parking_brake_state": "Disengaged"
}Opens the Rooftop Box (RTB) lids. It is not necessary to call this endpoint before takeoff, as the system will automatically open the lids when needed. This endpoint is intended for maintenance purposes.
- : 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
The system is not set up to work as Rooftop Box, so the operation cannot be performed.
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/system/control/open_rtb_lids HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Closes the Rooftop Box (RTB) lids. It is not necessary to call this endpoint after landing, as the system will automatically close the lids when needed. This endpoint is intended for maintenance purposes.
- : 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
The system is not set up to work as Rooftop Box, so the operation cannot be performed.
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/system/control/close_rtb_lids HTTP/1.1
Host: 192.168.2.100:3128
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated