Skip to content

AviDrone/backend

Repository files navigation

Avidrone Avalanche Rescue 🏔⛑

All Contributors license stars

Table of Contents

AviDrone Project Introduction

This project continues the AviDrone Project from last year, whose goal was to create a drone capable of completing this search process autonomously. This year, our goals were to resolve the hardware's shortcomings, expand the search procedure algorithms by implementing the primary search procedure, test tools for secondary search, and create a user-friendly interface to lead to a faster and safer victim search.

During the 2021-2022 academic year, we expanded search missions by implementing primary search and creating testing tools for both search algorithms. We improved hardware by fixing pre-existing shortcomings which prevented practical use. Additionally, we designed a user interface for fast deployment and an improved user experience. We successfully improved the drone on all fronts, bringing it closer to real-life deployment.

AviDrone GitHub Page Introduction

This page is primarily set up with the code, software explanations, and relevant documentation required to set up the software portion of this project. To access further hardware documentation, as well as documentation created for our class requirements, contact us. This code is currently specifically configured and set up to simulate the various aspects of the AviDrone search stages, additional work would be required before running it on a physical drone.

Getting Started

To clone this repository, run the following command on your terminal.

git clone https://github.com/AviDrone/backend.git --single-branch --branch main

Set up

Before getting started, you will need to install a few libraries by running install.sh.

chmod -x scripts/install.sh && bash scripts/install.sh

This will take care of installing the libraries used in the backend of this project.

It is possible to run a search mission using our command-line arguments (CLI) arguments, but using our frontend will definitely speed things up. To install QGroundControl for Avidrone, see the frontend repository.

How to use

Examples

Go through a few examples so you can learn to

  • Run a basic mission
  • Run a transceiver simulation
  • Run a search mission simulation

You can find the examples in EXAMPLE.md.

Search

To run a full search mission using CLI arguments, run

avidrone-search --run

To run primary search only, use

avidrone-search --primary

To run secondary search only, use

avidrone-search --secondary

If you'd like to learn more, run the following command to see what other things you can do with avidrone-search.

avidrone-search --help

Simulation

To run a simulated search mission, follow the guide in SIMULATION.md.

How to contribute

To contribute, carefully read the CONTRIBUTING.md file.

Contributors

Thanks goes to these wonderful people

License

Licensed under the LGPL-2.1 License.

Contact

For any questions, feel free to contact me at any time through email