Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
shipp02 authored May 15, 2024
1 parent c103f65 commit c010b36
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,21 @@
![PlatformIO CI](https://img.shields.io/github/actions/workflow/status/uci-overRID/RID/pio_build.yml?style=for-the-badge&logo=github&link=https%3A%2F%2Fgithub.com%2Fuci-overRID%2FRID%2Factions%2Fworkflows%2Fpio_build.yml
)
![Build with PlatformIO](https://img.shields.io/badge/build%20with-PlatformIO-orange?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMjUwMCIgaGVpZ2h0PSIyNTAwIiB2aWV3Qm94PSIwIDAgMjU2IDI1NiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBwcmVzZXJ2ZUFzcGVjdFJhdGlvPSJ4TWlkWU1pZCI+PHBhdGggZD0iTTEyOCAwQzkzLjgxIDAgNjEuNjY2IDEzLjMxNCAzNy40OSAzNy40OSAxMy4zMTQgNjEuNjY2IDAgOTMuODEgMCAxMjhjMCAzNC4xOSAxMy4zMTQgNjYuMzM0IDM3LjQ5IDkwLjUxQzYxLjY2NiAyNDIuNjg2IDkzLjgxIDI1NiAxMjggMjU2YzM0LjE5IDAgNjYuMzM0LTEzLjMxNCA5MC41MS0zNy40OUMyNDIuNjg2IDE5NC4zMzQgMjU2IDE2Mi4xOSAyNTYgMTI4YzAtMzQuMTktMTMuMzE0LTY2LjMzNC0zNy40OS05MC41MUMxOTQuMzM0IDEzLjMxNCAxNjIuMTkgMCAxMjggMCIgZmlsbD0iI0ZGN0YwMCIvPjxwYXRoIGQ9Ik0yNDkuMzg2IDEyOGMwIDY3LjA0LTU0LjM0NyAxMjEuMzg2LTEyMS4zODYgMTIxLjM4NkM2MC45NiAyNDkuMzg2IDYuNjEzIDE5NS4wNCA2LjYxMyAxMjggNi42MTMgNjAuOTYgNjAuOTYgNi42MTQgMTI4IDYuNjE0YzY3LjA0IDAgMTIxLjM4NiA1NC4zNDYgMTIxLjM4NiAxMjEuMzg2IiBmaWxsPSIjRkZGIi8+PHBhdGggZD0iTTE2MC44NjkgNzQuMDYybDUuMTQ1LTE4LjUzN2M1LjI2NC0uNDcgOS4zOTItNC44ODYgOS4zOTItMTAuMjczIDAtNS43LTQuNjItMTAuMzItMTAuMzItMTAuMzJzLTEwLjMyIDQuNjItMTAuMzIgMTAuMzJjMCAzLjc1NSAyLjAxMyA3LjAzIDUuMDEgOC44MzdsLTUuMDUgMTguMTk1Yy0xNC40MzctMy42Ny0yNi42MjUtMy4zOS0yNi42MjUtMy4zOWwtMi4yNTggMS4wMXYxNDAuODcybDIuMjU4Ljc1M2MxMy42MTQgMCA3My4xNzctNDEuMTMzIDczLjMyMy04NS4yNyAwLTMxLjYyNC0yMS4wMjMtNDUuODI1LTQwLjU1NS01Mi4xOTd6TTE0Ni41MyAxNjQuOGMtMTEuNjE3LTE4LjU1Ny02LjcwNi02MS43NTEgMjMuNjQzLTY3LjkyNSA4LjMyLTEuMzMzIDE4LjUwOSA0LjEzNCAyMS41MSAxNi4yNzkgNy41ODIgMjUuNzY2LTM3LjAxNSA2MS44NDUtNDUuMTUzIDUxLjY0NnptMTguMjE2LTM5Ljc1MmE5LjM5OSA5LjM5OSAwIDAgMC05LjM5OSA5LjM5OSA5LjM5OSA5LjM5OSAwIDAgMCA5LjQgOS4zOTkgOS4zOTkgOS4zOTkgMCAwIDAgOS4zOTgtOS40IDkuMzk5IDkuMzk5IDAgMCAwLTkuMzk5LTkuMzk4em0yLjgxIDguNjcyYTIuMzc0IDIuMzc0IDAgMSAxIDAtNC43NDkgMi4zNzQgMi4zNzQgMCAwIDEgMCA0Ljc0OXoiIGZpbGw9IiNFNTcyMDAiLz48cGF0aCBkPSJNMTAxLjM3MSA3Mi43MDlsLTUuMDIzLTE4LjkwMWMyLjg3NC0xLjgzMiA0Ljc4Ni01LjA0IDQuNzg2LTguNzAxIDAtNS43LTQuNjItMTAuMzItMTAuMzItMTAuMzItNS42OTkgMC0xMC4zMTkgNC42Mi0xMC4zMTkgMTAuMzIgMCA1LjY4MiA0LjU5MiAxMC4yODkgMTAuMjY3IDEwLjMxN0w5NS44IDc0LjM3OGMtMTkuNjA5IDYuNTEtNDAuODg1IDIwLjc0Mi00MC44ODUgNTEuODguNDM2IDQ1LjAxIDU5LjU3MiA4NS4yNjcgNzMuMTg2IDg1LjI2N1Y2OC44OTJzLTEyLjI1Mi0uMDYyLTI2LjcyOSAzLjgxN3ptMTAuMzk1IDkyLjA5Yy04LjEzOCAxMC4yLTUyLjczNS0yNS44OC00NS4xNTQtNTEuNjQ1IDMuMDAyLTEyLjE0NSAxMy4xOS0xNy42MTIgMjEuNTExLTE2LjI4IDMwLjM1IDYuMTc1IDM1LjI2IDQ5LjM2OSAyMy42NDMgNjcuOTI2em0tMTguODItMzkuNDZhOS4zOTkgOS4zOTkgMCAwIDAtOS4zOTkgOS4zOTggOS4zOTkgOS4zOTkgMCAwIDAgOS40IDkuNCA5LjM5OSA5LjM5OSAwIDAgMCA5LjM5OC05LjQgOS4zOTkgOS4zOTkgMCAwIDAtOS4zOTktOS4zOTl6bS0yLjgxIDguNjcxYTIuMzc0IDIuMzc0IDAgMSAxIDAtNC43NDggMi4zNzQgMi4zNzQgMCAwIDEgMCA0Ljc0OHoiIGZpbGw9IiNGRjdGMDAiLz48L3N2Zz4=&style=for-the-badge)
![Last Commit](https://img.shields.io/github/last-commit/uci-overRID/RID?style=for-the-badge)
![Tag](https://img.shields.io/github/v/tag/uci-overRID/RID?style=for-the-badge)

This is firmware to turn an esp32 into an OpenDroneID receiver which then
is transmitted via mavlink over serial to a flight controller. It can be used
This is firmware to turn an ESP32-C3 into an OpenDroneID receiver which then
is transmitted via mavlink over serial to a (ArduPilot) flight controller. It can be used
to report threats to the ground station or perform other actions based on the
flight controllers discretion.

This project is done as part of UCI's EECS Senior Design Project and is also supported
by [ASTM International](https://astm.org/) through their [Senior Design Project Grants](https://sn.astm.org/nextgen/nextgen-project-grants-paper-competition-and-more-jf24.html).

It uses FAA regulations that require [Open Drone ID](https://www.opendroneid.org/)
transmitters on every Drone. This regulation can be extended to allow the automated
drone warning and avoidance systems for other drone usersof collisions between drones
when they fly close to each other. Our project aims to achieve this.

This firmware works in combination with our fork of the ardupilot project which collects the
data sent over mavlink to warn the pilot of incoming UAV's and take evasive action if necessary.
For instructions on how to use this you should look at [uci-overRID ardupilot](https://github.com/uci-overRID/ardupilot/).

## Build
Repo is meant to work with PlatformIO in Visual Studio Code.
Expand Down Expand Up @@ -48,13 +47,19 @@ Add the serial device to your sitl command by adding this:
Change the last part to your the file you found by listing `/dev/serial/by-id`.


## Thanks to
# Thanks

This project is done as part of UCI's EECS Senior Design Project and is also supported
by [ASTM International](https://astm.org/) through their [Senior Design Project Grants](https://sn.astm.org/nextgen/nextgen-project-grants-paper-competition-and-more-jf24.html). We also thank [UCI's UROP](https://urop.uci.edu/) for their support.

We also appreciate the support of our advisor [Professor Peter Burke](https://www.burkelab.com/) and the technical support from Shawn Davis

## Code
We appreciate the code that we were able to refer to and use
in order to build this project.

Fork of [uav_electronic_ids](https://github.com/sxjack/uav_electronic_ids)
with libraries from:
[opendroneid-core-c](https://github.com/opendroneid/opendroneid-core-c)
[mavlink](https://github.com/mavlink/mavlink)
- [opendroneid-core-c](https://github.com/opendroneid/opendroneid-core-c)
- [mavlink](https://github.com/mavlink/mavlink)

0 comments on commit c010b36

Please sign in to comment.