Welcome to DroNeS’ documentation!

DroNeS is a graphical simulation software that aims to let end-users test and benchmark the performances of different routing and scheduling algorithms in a large scale drone network.

This documentation archive contains instructions on how to build, run, and use the DroNeS program.

Installation

This section includes instructions on how to install project and its dependencies.

Git

Git can be installed on respective systems using the following instructions.

Ubuntu

  1. From your shell, install Git using apt-get:

    $ sudo apt-get update
$ sudo apt-get install git

Windows

  1. Download the latest Git for Windows installer
  2. Proceed through the Git Setup wizard to complete the installation. The default options are sufficient at this stage.

Mac OS

  1. Download the latest Git for Mac installer

  2. Follow the prompts to install Git

  3. Open a terminal and verify the installation was successful by checking the installed version:

    $ git --version
git version 2.9.2

Once completed, install the rest of the dependencies or proceed to build instructions.

Python

This section contains instructions on how to install Python on respective systems.

Note

Python 3.6.7 is the version that the project has been tested against. You can use 3.x but no support will be given.

Ubuntu

  1. Python can be installed with the following commands:

    $ sudo apt-get update
$ sudo apt-get install python3.6

Windows

  1. Download the latest Python 3 Release - Python 3.6.x’ Select either the 64-bit or the 32-bit installer, depending on your system.
  2. Proceed through the Python 3.6.x Installer wizard to complete the installation. The default options are sufficient at this stage. Check the box that says ‘Add Python 3.x to PATH’ to ensure that the interpreter will be placed in your execution path.

Mac OS

  1. Install Homebrew by following the instructions at <http://brew.sh/>`_

  2. Return to terminal and run the following command:

    $ brew install python3

Once completed, install the rest of the dependencies or proceed to build instructions.

Unity 3D

This section contains instructions on how to install Unity 3D, which we will later use to build the project.

Installation

  1. Download and install Unity Hub following the official instructions
  2. The Unity version used for this project is Unity 2018.3.0f2, and is what you will need to use to build the project
  3. Download and install the correct version (Unity 2018.3.0) from the Unity archives page

Once completed, install the rest of the dependencies or proceed to build instructions.

Project development was done in Mac OS and Windows, and therefore are the recommended development platforms for this project.

Unity currently does not have an official Unity3D build for Linux systems. Though there is currently an unofficial build, it is untested and therefore unsupported by this project.

Downloading the project

To download a copy of the latest master branch in git you can clone the repository:

git clone --recursive https://github.com/muramasa2402/DroNeSProject

Building

This section contains instructions on how to build the project. The following steps assume that you’ve installed the project prerequisites and have cloned the project repository.

Importing the project

  1. First open Unity Hub. In the Projects pane on the left, click on the top-left Add button and add the root folder containing the cloned project repository.
  2. Double-click on the project to open it, selecting Unity 2018.3.0f2 as the project version.
  3. At this point Unity 3D should take a couple of minutes to import all the project assets and scripts.

Fixing Test Runner errors

Note

At this point there may be one or more errors pertaining to tests written for Mapbox components because Unity does not include test assemblies in compiled builds.

To remove these errors, you need to reference test assemblies from all the assemblies:

  1. Go to Window -> General -> Test Runner
  2. Click the small drop-down menu in the top-right of the window.
  3. Click Enable playmode tests for all assemblies
  4. In the dialog box appears, click OK to manually restart the Editor.
_images/UnityTestRunner.png

After relaunching the project there should be no more errors.

Building the project

  1. Go to File -> Build Settings… (alternative press CTRL + SHIFT + B)

  2. Configure the build settings choosing the appropriate target platform and architecture of choice. The following platforms have been tested:

    • Windows x86_64
    • Windows x86

  3. Click Build and Run and specify the build output folder

  4. Wait for the build to complete

Once complete, the output folder should contain a city_v1.exe executable where the simulation program can be launched.

DroNeS Tutorial

Quickstart

External Servers

Default minimum-working examples for the external routing and job scheduling servers required by DroNeS are provided.

Instructions on how to install, configure and run these servers can be found in the DroNeS-Servers documentation.

DroNeS

  1. Launch the city_v1.exe file, selecting appropriate display options.
  2. At the start screen, head to the settings page to configure the endpoints of the external servers being used. When connected properly, the indicators on the left of the fields should turn green.
  3. Head back to the menu and click on Start

A simulation should launch shortly within a minute. Drones and hubs may be added using the controls at the bottom left of the screen.