FLARM HUB version 1.8.5

http://10.10.10.10/api

General Principles

For most API calls such as GET, PUT and POST where json is sent to the HUB the "application/json" content-type header is expected.
For large uploads or downloads, progress information is provided by a dedicated progress reporting REST endpoint /transfer/progress.

The use of the command line utility curl is a good starting point to facilitate the use of the HUB REST API, and gain some experience with it. Here some examples on how to operate curl in combination with this REST API.

Getting Information

curl -X GET http://10.10.10.10/api/config
{"WIFI_AP_SSID":"FLAFUS10W-000003","WIFI_AP_KEY":"Ravefoli23","BLUETOOTH_NAME":"FLAFUS10W-000003"}

Putting Information

curl -X PUT -H "Content-Type: application/json" -d '"Pilot Name"' http://10.10.10.10/api/flarm/config/PILOT
"Pilot Name"

Uploading Firmware and Obstacle Files

curl -X PUT --data-binary "@flarm_firmware.fw" http://10.10.10.10/api/flarm/fw
{"message": "File successfully received"}

The progress can be queried concurrently to the upload or download at:

curl -X GET http://10.10.10.10/api/transfer/progress
{"total":690,"loaded":516}

/info

/info get

Provides basic device information about FLARM Hub

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "device_id": "HUB-c04d84",
  "heap_free": 37588,
  "network": {
    "wifi_ap_ip": "10.10.10.10"
  }
}

/reset

/reset post delete

/config

/config get

Configuration is simply a key/value store. Configuration keys are represented here in upper case, but the API is case insensitive. The configuration values are “typed”, i.e. taking one of the following types: int (32-bit width, signed), double (64-bit), string. Note that JSON does not support integers directly – int types will thus be truncated when storing. Items holding a raw binary blob cannot be represented in JSON: they are omitted from this listing, reading one yields a 404 and writing one a 400.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "WIFI_AP_SSID": "FLARM-MATE-c04d6c",
  "WIFI_AP_KEY": "Ruf3Qeib7ohT"
}

/config/{item} get put

Get the value for the given item.

Request

URI Parameters

item: required(string)

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

"FLARM-MATE-c04d6c"

HTTP status code 401

In case of attempting to read a write only item.

HTTP status code 404

No such item found in the configuration.

Set the value for the given item.

Request

URI Parameters

item: required(string)

Body

Media type: application/json

Type: any

Example:

"FLARM-MATE-c04d6c"

Response

HTTP status code 200

The value was successfully stored.

Body

Media type: application/json

Type: any

Example:

"FLARM-MATE-c04d6c"

HTTP status code 400

Invalid value for the desired item, the item is read only, or it holds a raw binary blob.

HTTP status code 401

Write lock is active.

HTTP status code 404

The configuration item was not found.

/default

/default get

See the /config endpoint. Returns the default configuration values.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "WIFI_AP_SSID": "FLAFUS10W-000512",
  "WIFI_AP_KEY": "Aerydys78"
}

/default/{item} get

Get the default value for the given item.

Request

URI Parameters

item: required(string)

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

"FLAFUS10W-000512"

HTTP status code 401

In case of attempting to read a write only item.

HTTP status code 404

No such item found in the configuration.

/logs

/logs get

Returns a list of logfiles available in the system.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "name": "mate.log",
    "size": 193408
  },
  {
    "name": "mate1.log",
    "size": 163246
  }
]

HTTP status code 500

If the storage facility is unavailable.

/logs/{filename} get

Download the given file's content.

Request

URI Parameters

filename: required(string)

Response

HTTP status code 200

Body

Media type: text/plain

Type: any

Example:

I (4011192) DATAPORT SRV: _dp_ExecuteMultilineCommand(): Executing command: $PFLAC,R,NMEAOUT2

HTTP status code 400

Malformed request.

HTTP status code 404

File not found.

/system

/system get

Provides a RTOS system overview containing all tasks, ram usage and wifi.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "heap": {
    "current_remaining_heap": 34048,
    "largest_free_block": 33208,
    "heap_watermark": 32552
  },
  "wifi": {
    "ap": {
      "mac": "80:37:73:fd:4b:62",
      "ssid": "FLARM_2G",
      "channel": 1,
      "rssi": -45
    },
    "sta": [
      {
        "mac": "b4:9d:0b:79:25:80",
        "rssi": -28
      }
    ]
  },
  "tasks": [
    {
      "name": "BTC_TASK",
      "status": "Blocked",
      "runtime": 30256,
      "percentage": 0,
      "priority": 19,
      "stack allocated": 3072,
      "stack in use": 496,
      "stack remaining": 2576,
      "stack watermark": 1392
    },
    {
      "name": "DNS Server",
      "status": "Blocked",
      "runtime": 1319,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 3072,
      "stack in use": 1308,
      "stack remaining": 1764,
      "stack watermark": 1488
    },
    {
      "name": "DP Server",
      "status": "Blocked",
      "runtime": 26075,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 3072,
      "stack in use": 560,
      "stack remaining": 2512,
      "stack watermark": 1724
    },
    {
      "name": "DP Socket",
      "status": "Blocked",
      "runtime": 743,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 3072,
      "stack in use": 732,
      "stack remaining": 2340,
      "stack watermark": 1940
    },
    {
      "name": "DP Virtual",
      "status": "Blocked",
      "runtime": 13653,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 4096,
      "stack in use": 804,
      "stack remaining": 3292,
      "stack watermark": 2172
    },
    {
      "name": "GLD90 Provider",
      "status": "Blocked",
      "runtime": 20654,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 3072,
      "stack in use": 468,
      "stack remaining": 2604,
      "stack watermark": 1180
    },
    {
      "name": "HTTPD Server",
      "status": "Running",
      "runtime": 56533,
      "percentage": 0,
      "priority": 5,
      "stack allocated": 5120,
      "stack in use": 1256,
      "stack remaining": 3864,
      "stack watermark": 2328
    },
    {
      "name": "IDLE0",
      "status": "Running",
      "runtime": 32368349,
      "percentage": 86,
      "priority": 0,
      "stack allocated": 768,
      "stack in use": 424,
      "stack remaining": 344,
      "stack watermark": 200
    },
    {
      "name": "IDLE1",
      "status": "Running",
      "runtime": 34364298,
      "percentage": 91,
      "priority": 0,
      "stack allocated": 768,
      "stack in use": 424,
      "stack remaining": 344,
      "stack watermark": 248
    },
    {
      "name": "SBT Bridge",
      "status": "Blocked",
      "runtime": 10583,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 4096,
      "stack in use": 584,
      "stack remaining": 3512,
      "stack watermark": 3304
    },
    {
      "name": "Tmr Svc",
      "status": "Blocked",
      "runtime": 32,
      "percentage": 0,
      "priority": 1,
      "stack allocated": 1536,
      "stack in use": 452,
      "stack remaining": 1084,
      "stack watermark": 1084
    },
    {
      "name": "UDP Beacon",
      "status": "Blocked",
      "runtime": 1413,
      "percentage": 0,
      "priority": 0,
      "stack allocated": 3072,
      "stack in use": 1080,
      "stack remaining": 1992,
      "stack watermark": 1656
    },
    {
      "name": "btController",
      "status": "Blocked",
      "runtime": 476205,
      "percentage": 1,
      "priority": 23,
      "stack allocated": 3584,
      "stack in use": 500,
      "stack remaining": 3084,
      "stack watermark": 1580
    },
    {
      "name": "btuT",
      "status": "Blocked",
      "runtime": 11384,
      "percentage": 0,
      "priority": 20,
      "stack allocated": 4096,
      "stack in use": 488,
      "stack remaining": 3608,
      "stack watermark": 2648
    },
    {
      "name": "esp_timer",
      "status": "Blocked",
      "runtime": 94274,
      "percentage": 0,
      "priority": 22,
      "stack allocated": 2048,
      "stack in use": 452,
      "stack remaining": 1596,
      "stack watermark": 1324
    },
    {
      "name": "hciT",
      "status": "Blocked",
      "runtime": 11534,
      "percentage": 0,
      "priority": 22,
      "stack allocated": 2048,
      "stack in use": 492,
      "stack remaining": 1556,
      "stack watermark": 1172
    },
    {
      "name": "ipc0",
      "status": "Blocked",
      "runtime": 4466,
      "percentage": 0,
      "priority": 24,
      "stack allocated": 1024,
      "stack in use": 464,
      "stack remaining": 560,
      "stack watermark": 560
    },
    {
      "name": "ipc1",
      "status": "Blocked",
      "runtime": 3036843,
      "percentage": 8,
      "priority": 24,
      "stack allocated": 1024,
      "stack in use": 420,
      "stack remaining": 604,
      "stack watermark": 492
    },
    {
      "name": "main",
      "status": "Blocked",
      "runtime": 3779599,
      "percentage": 10,
      "priority": 1,
      "stack allocated": 4096,
      "stack in use": 536,
      "stack remaining": 3560,
      "stack watermark": 1912
    },
    {
      "name": "sys_evt",
      "status": "Blocked",
      "runtime": 24224,
      "percentage": 0,
      "priority": 20,
      "stack allocated": 2048,
      "stack in use": 516,
      "stack remaining": 1532,
      "stack watermark": 780
    },
    {
      "name": "tiT",
      "status": "Blocked",
      "runtime": 62596,
      "percentage": 0,
      "priority": 18,
      "stack allocated": 3072,
      "stack in use": 552,
      "stack remaining": 2520,
      "stack watermark": 1748
    },
    {
      "name": "wifi",
      "status": "Blocked",
      "runtime": 586430,
      "percentage": 1,
      "priority": 23,
      "stack allocated": 3072,
      "stack in use": 504,
      "stack remaining": 2568,
      "stack watermark": 1128
    }
  ]
}

/transfer

/transfer/progress get

Reports the progress of an ongoing transfer. Not every transfer reports progress: the ones that do say so in their own description, along with the unit they count in (bytes, pages or percent). Only the ratio of loaded to total is therefore meaningful across transfers. Both values are 0 while no transfer is active.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "total": 0,
  "loaded": 0
}

/firmware

/firmware/info get

Provides a description of the currently installed Hub firmware.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "app": "flarm-mate",
  "version": "0.1.2dev",
  "build_date": "May  6 2020",
  "build_no": "b602ed6",
  "boot_partition": "ota_0"
}

/firmware/image put

/permission

This API allows to write lock/unlock the REST API With a user defined password.

/permission/token put delete

Defines a write permission token (password)

Request

Body

Media type: application/json

Type: any

Example:

{
  "token": "Zt7pQr2mWk9x"
}

Response

HTTP status code 200

If the token was valid and successfully stored in the system.

Body

Media type: application/json

Type: any

Example:

{
  "lock_set": true,
  "allowed": true
}

HTTP status code 400

If the body was malformed, or the password token is not between 8 and 63 characters long.

HTTP status code 500

If the token cannot be stored in the system.

/permission/write get put delete

Unlocks write access.

Request

Body

Media type: application/json

Type: any

Example:

{
  "token": "Zt7pQr2mWk9x"
}

Response

HTTP status code 200

The write lock was successfully removed.

Body

Media type: application/json

Type: any

Example:

{
  "lock_set": true,
  "allowed": true
}

HTTP status code 400

If the request body is malformed.

HTTP status code 401

If the given token is not valid.

HTTP status code 500

If no write token was defined.

/mavlink

/mavlink/status get

Provides an array with status information for all available mavlink interfaces, e.g. port name, connection status, mavlink system id and injected GPS fix quality

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "port": "JST",
    "mav_connected": false,
    "mav_sysid": 1,
    "mav_compid": 160,
    "mav_packets_received": 0,
    "mav_fix3d": false,
    "gnss_inject_timer_running": false,
    "esp32_valid_timesync": false
  }
]

HTTP status code 501

There are no mavlink interfaces on this device

/flarm

Note that /api/flarm/dataport is not a REST resource: it upgrades to a WebSocket that tunnels the FLARM dataport (NMEA) stream, and is therefore not documented here.

/flarm/status

/flarm/status/dataport get

/flarm/status/navigation get

Provides the current navigation solution that is available from GPS.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "heartbeat_counter": 13599,
  "time_epoch": 0,
  "longitude": 0,
  "latitude": 0,
  "alt_wgs84": 0,
  "alt_egm96": 0,
  "alt_baro": 603.808837890625,
  "groundspeed_ms": 0,
  "track_deg": 0,
  "fix_valid": false
}

HTTP status code 500

If the connection to the FLARM could not be obtained.

/flarm/status/heartbeat get

FLARM Heartbeat information, this correlates with the Dataport $PFLAU heartbeat message.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "counter": 13715,
  "rx": 0,
  "tx": false,
  "gps": 0,
  "power": true,
  "alarm_level": 0,
  "relative_bearing": 0,
  "alarm_type": 0,
  "relative_vertical": 0,
  "distance": 0,
  "id": 0
}

HTTP status code 500

If the connection to the FLARM could not be obtained.

/flarm/status/error get

List of errors that occurred since device startup. The error code is hex!

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "code": "0",
    "severity": 0,
    "message": ""
  }
]

/flarm/status/aircraft get

Provides the list of aircraft in the vicinity. This correlates with the Dataport $PFLAA message.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
     "12A5B2": { "heartbeat_counter": 1504, "id": "12A5B2", "id_type": 2, "alarm_level": 1, "relative_north": 4552, "relative_east": 2145, "relative_vertical": -240, "track_deg": 20, "turnrate": 0.2, "groundspeed": 40.2, "climbrate": 0.6, "acft_type": 6, "no_track": false, "source": 2, "rssi": 42 },
     "43B7CC": { "heartbeat_counter": 1504, "id": "43B7CC", "id_type": 2, "alarm_level": 3, "relative_north": 552, "relative_east": 145, "relative_vertical": -40, "track_deg": 200, "turnrate": -0.24, "groundspeed": 68.2, "climbrate": 0.2, "acft_type": 1, "no_track": false, "source": 2, "rssi": 68 }
}

/flarm/status/version get

FLARM firmware and Obstacle database version indication.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "firmware": "7.00",
  "obstacle_db": ""
}

HTTP status code 500

If the connection to the FLARM could not be obtained.

/flarm/status/flight get

Current in-flight and IGC recording status.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "flight": 0,
  "flight_recorder": 0,
  "tisb_adsr_client_status": 0
}

HTTP status code 500

If the connection to the FLARM could not be obtained.

/flarm/config put

Upload a flarm configuration file. Progress is reported on /transfer/progress, counted in bytes.

Request

Body

Media type: text/plain

Type: any

Example:

$PFLAC,S,ACFT,1
$PFLAC,S,PILOT,Pilot Name
$PFLAC,S,COPIL,Copilot Name

Response

HTTP status code 200

The file was successfully uploaded. Note that it does not mean the content was valid FLARM commands.

HTTP status code 401

Write lock is active.

HTTP status code 500

The upload failed.

/flarm/config/{item} get put

Query a FLARM configuration item.

Request

URI Parameters

item: required(string)

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

"Pilot Name"

HTTP status code 400

Malformed request, or the configuration item does not exist.

HTTP status code 500

If the connection to the FLARM could not be obtained.

Write FLARM configuration item. Numbers MUST be written as json strings!

Request

URI Parameters

item: required(string)

Body

Media type: application/json

Type: any

Example:

"65535"

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

"65535"

HTTP status code 400

Malformed request, non compliant json request body or the configuration item does not exist.

HTTP status code 401

Write lock is active.

HTTP status code 500

If the connection to the FLARM could not be obtained.

/flarm/ob2 put delete

/flarm/fw put

/flarm/lics put

/flarm/flash get

/flarm/carp get delete

Download the current CARP data. This selects the default CARP method, e.g. InstaCARP or (legacy) CARP.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "antenna_A_range": [
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null
  ],
  "antenna_B_range": [
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null
  ],
  "count": 0,
  "first_contact": 0,
  "last_contact": 0
}

/flarm/legacycarp get

Download the data from the (legacy) CARP method.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "antenna_A_range": [
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null
  ],
  "antenna_B_range": [
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null,
    null
  ],
  "count": 0,
  "first_contact": 0,
  "last_contact": 0
}

/flarm/igc get

Returns a list of available IGC flight record files meta data.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "index": 0,
    "filename": "051XCP71.IGC",
    "timestamp": "2020-05-01T06:17:48",
    "duration": "00:12:45",
    "pilot": null,
    "compid": null,
    "class": null
  },
  {
    "index": 1,
    "filename": "04PXCP71.IGC",
    "timestamp": "2020-04-25T10:10:42",
    "duration": "00:19:39",
    "pilot": null,
    "compid": null,
    "class": null
  },
  {
    "index": 2,
    "filename": "04JXCP71.IGC",
    "timestamp": "2020-04-19T06:47:24",
    "duration": "00:12:47",
    "pilot": null,
    "compid": null,
    "class": null
  },
  {
    "index": 3,
    "filename": "04IXCP71.IGC",
    "timestamp": "2020-04-18T10:05:48",
    "duration": "00:20:46",
    "pilot": null,
    "compid": null,
    "class": null
  },
  {
    "index": 4,
    "filename": "049XCP71.IGC",
    "timestamp": "2020-04-09T09:00:21",
    "duration": "00:12:35",
    "pilot": null,
    "compid": null,
    "class": null
  },
  {
    "index": 5,
    "filename": "014XCP71.IGC",
    "timestamp": "1970-01-04T19:33:10",
    "duration": "00:12:34",
    "pilot": null,
    "compid": null,
    "class": null
  },
  {
    "index": 6,
    "filename": "29RXCP7E.IGC",
    "timestamp": "1970-01-01T00:55:40",
    "duration": "00:12:28",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 7,
    "filename": "29RXCP7D.IGC",
    "timestamp": "1970-01-01T00:22:24",
    "duration": "00:18:18",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 8,
    "filename": "29RXCP7C.IGC",
    "timestamp": "1970-01-01T01:19:04",
    "duration": "00:12:28",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 9,
    "filename": "019XCP71.IGC",
    "timestamp": "1970-01-09T17:41:02",
    "duration": "00:12:37",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 10,
    "filename": "019XCP71.IGC",
    "timestamp": "1970-01-09T16:31:44",
    "duration": "00:15:42",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 11,
    "filename": "017XCP71.IGC",
    "timestamp": "1970-01-07T19:34:30",
    "duration": "00:13:14",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 12,
    "filename": "015XCP71.IGC",
    "timestamp": "1970-01-05T19:57:19",
    "duration": "00:12:29",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 13,
    "filename": "015XCP71.IGC",
    "timestamp": "1970-01-05T19:15:22",
    "duration": "00:22:49",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 14,
    "filename": "015XCP71.IGC",
    "timestamp": "1970-01-05T18:52:37",
    "duration": "00:24:49",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 15,
    "filename": "015XCP71.IGC",
    "timestamp": "1970-01-05T17:43:43",
    "duration": "01:04:43",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 16,
    "filename": "015XCP71.IGC",
    "timestamp": "1970-01-05T16:47:27",
    "duration": "00:23:04",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 17,
    "filename": "014XCP71.IGC",
    "timestamp": "1970-01-04T02:27:33",
    "duration": "00:12:30",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 18,
    "filename": "29RXCP72.IGC",
    "timestamp": "1970-01-01T00:49:53",
    "duration": "00:12:28",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  },
  {
    "index": 19,
    "filename": "018XCP71.IGC",
    "timestamp": "1970-01-08T17:14:34",
    "duration": "00:18:03",
    "pilot": "Pilot Name",
    "compid": null,
    "class": null
  }
]

HTTP status code 500

If the connection to the FLARM could not be obtained

/flarm/igc/{index} get

Returns the text based IGC data as a chunked HTTP response. Progress is reported on /transfer/progress, counted in percent.

Request

URI Parameters

index: required(string)

Response

HTTP status code 200

Body

Media type: text/plain

Type: any

Example:

B0617484711214N00828640EA004530048200210003

HTTP status code 400

Malformed url

HTTP status code 404

A file with the given index could not be found.

HTTP status code 500

If the connection to the FLARM could not be obtained

/flarm/simulation get post

Retrieve the currently running simulation scenario, if any.

Response

HTTP status code 200

Return the number of the currently running simulation scenario, or null if none is running.

Body

Media type: application/json

Type: any

Example:

HTTP status code 500

Internal error while retrieving the simulation status.

Start the requested simulation scenario.

Request

Body

Media type: application/json

Type: any

Example:

Response

HTTP status code 200

The requested simulation scenario was started. Returns the started scenario.

Body

Media type: application/json

Type: any

Example:

HTTP status code 400

An invalid request was made. Potentially the device state does not allow for a scenario to be run (in flight, another scenario already running). See message for more information.

HTTP status code 404

The given scenario number does not exist.

HTTP status code 500

Internal error while starting the requested scenario.

/remoteid

/remoteid/status get

Provides an array with Remote ID configuration status information

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "ok": false,
  "msg": "RID_OPERATOR_ID must be a valid UAS OPRN"
}

/power

/power get

Available on PowerFLARM Flex. Provides the power state of the device.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "batteryPercent": 72.04296875,
  "temperatureC": 29.59765625,
  "rj45_voltage": 11.13700008392334,
  "powerSource": 2,
  "batteryState": 1
}

HTTP status code 500

If the power state is not available.

FLARM HUB version 1.8.5

General Principles

Examples

Getting Information

Putting Information

Uploading Firmware and Obstacle Files

/info

/info get

get /info

HTTP status code 200

Body

/reset

/reset post delete

post /reset

HTTP status code 200

HTTP status code 401

delete /reset

HTTP status code 200

HTTP status code 401

/config

/config get

get /config

HTTP status code 200

Body

/config/{item} get put

get /config/{item}

URI Parameters

HTTP status code 200

Body

HTTP status code 401

HTTP status code 404

put /config/{item}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 400

HTTP status code 401

HTTP status code 404

/default

/default get

get /default

HTTP status code 200

Body

/default/{item} get

get /default/{item}

URI Parameters

HTTP status code 200

Body

HTTP status code 401

HTTP status code 404

/logs

/logs get

get /logs

HTTP status code 200

Body

HTTP status code 500

/logs/{filename} get

get /logs/{filename}

URI Parameters

HTTP status code 200

Body

HTTP status code 400

HTTP status code 404

/system

/system get

get /system

HTTP status code 200

Body

/transfer

/transfer/progress get

get /transfer/progress

HTTP status code 200

Body

/firmware

/firmware/info get

get /firmware/info

HTTP status code 200

Body

/firmware/image put