S010MON/flying-forward-2020-api_v1

An API for handling the back end of the Flying Forward 2020 drone data collection tool

Flying Forward 2020 Database and API

Installation Guide

Dependencies

Ensure that docker and docker-compose are installed

    docker version
    docker-compose --version

if not installed -> install and for your OS

Run Server

Navigate to the flying-forward-2020-api/ root directory

Run the container:

    sudo docker-compose up

Done!

API Specification

POST /api/dump

{
  "user_data":
    {
      "age": 20,
      "flying_exp_mins": 30,
      "gender": "m",
      "license": "A1 & A3" 
    },
  "map": "Intruder",
  "summary": 
    {
      "time_overflying_people_ms": 34,
      "number_overflown_people": 399,
      "min_dist_to_nearest_structure": 60.4,
      "min_dist_to_nearest_person": 50.3,
      "avg_dist_to_intruder": 39.4,
      "max_dist_to_start": 150.67,
      "gated_vul_points": 4
    },
  "vectors": [
    {
      "time_ms": 0,
      "px": 0,
      "py": 0,
      "pz": 0,
      "vx": 0,
      "vy": 0,
      "vz": 0
    },
    {
      "time_ms": 5,
      "px": 0,
      "py": 0,
      "pz": 0,
      "vx": 0,
      "vy": 0,
      "vz": 0
    },
    {
      "time_ms": 10,
      "px": 0,
      "py": 0,
      "pz": 0,
      "vx": 0,
      "vy": 0,
      "vz": 0
    }
  ]
}

Response:

None

Database

Users

+-------------------------------+--------------+------+-----+---------+----------------+
| Field                         | Type         | Null | Key | Default | Extra          |
+-------------------------------+--------------+------+-----+---------+----------------+
| user_id                       | int          | NO   | PRI | NULL    | auto_increment |
| age                           | int          | YES  |     | NULL    |                |
| flying_minutes                | int          | YES  |     | NULL    |                |
| gender                        | varchar(1)   | YES  |     | NULL    |                |
| licences                      | varchar(255) | YES  |     | NULL    |                |
| map                           | varchar(255) | YES  |     | NULL    |                |
| time_overflying_people_ms     | int          | YES  |     | NULL    |                |
| number_overflown_people       | int          | YES  |     | NULL    |                |
| min_dist_to_nearest_structure | double       | YES  |     | NULL    |                |
| min_dist_to_nearest_person    | double       | YES  |     | NULL    |                |
| avg_dist_to_intruder          | double       | YES  |     | NULL    |                |
| max_dist_to_start             | double       | YES  |     | NULL    |                |
| gated_vul_points              | int          | YES  |     | NULL    |                |
+-------------------------------+--------------+------+-----+---------+----------------+

Vectors

+-----------+--------+------+-----+---------+-------+
| Field     | Type   | Null | Key | Default | Extra |
+-----------+--------+------+-----+---------+-------+
| user_id   | int    | NO   | PRI | NULL    |       |
| time_ms   | double | NO   | PRI | NULL    |       |
| px        | double | NO   |     | NULL    |       |
| py        | double | NO   |     | NULL    |       |
| pz        | double | NO   |     | NULL    |       |
| vx        | double | NO   |     | NULL    |       |
| vy        | double | NO   |     | NULL    |       |
| vz        | double | NO   |     | NULL    |       |
+-----------+--------+------+-----+---------+-------+