OpenAthena™ for Android

OpenAthena for Android

An Android port of the OpenAthena project

OpenAthena™ allows common drones to spot precise geodetic locations.

🖼️👨‍💻 + 🧮⛰️ = 🎯📍

License

Copyright (C) 2024 Theta Informatics LLC

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Install

<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">

GitHub releases page:

https://github.com/Theta-Limited/OpenAthenaAndroid/releases

Operation manual

Troubleshooting

Certain error conditions may occur during regular use of this software. For troubleshooting information and a detailed description of the cause of possible errors, review the following document TROUBLESHOOTING.md:

https://github.com/Theta-Limited/OpenAthenaAndroid/blob/master/TROUBLESHOOTING.md

Setup for drone flight

Compass sensor 🧭 calibration

It is strongly suggested that you should calibrate the drone's compass sensor for the local environment before taking photos to be used with OpenAthena. Consult your drone's operation manual for this procedure. The image metadata from an un-calibrated drone can be several degrees off from the correct heading. This can result in dramatic target-resolution inaccuracies if the sensor is not calibrated. Always verify a target match location from OpenAthena before use!

E.g.:

Optional: use the "Manual Azimuth Correction" slider to correct bad compass data

If you find your aircraft's compass sensor is still not providing correct heading information, you can use this slider to manually apply a configurable offset anywhere in the range of [-15.0°, +15.0°]. This offset will be added to your aircraft's camera heading before target calculation is performed:

NOTE: This value is NOT for setting magnetic declination! Magnetic declination is already accounted for by your drone's onboard digital World Magnetic Model (WMM). Improper use of this Manual Offset setting will result in bad target calculation output.

Your selected manual correction value is saved automatically between launches of the app. To reset the value, tap the "RESET" button in the Settings screen or move the slider to the middle.

Let your drone acquire GPS lock before flying

For the best results for target calculation, it's important to let your drone sit at the launch position until it can get an accurate GPS fix. This is important for it to be able measure altitude correctly during flight.

On DJI drones, this indicator shows the number of GPS satellites visible to the drone:

Wait until at least 6 GPS satellites are visible (or you can confirm the GPS fix is good) before starting flight.

Select an Image 🖼:

To being, tap the '🖼' button to select and load a drone image.

This app is compatible with images taken by select models of DJI, Skydio, Autel, and Parrot aircraft models. The drone's position and its camera's orientation are automatically extracted from the image metadata.

OpenAthena for Android (v0.21.0 and later) will automatically select and/or download a Digital Elevation Model (DEM) for the area around your selected drone image.

Calculate a target 🎯:

Tap anywhere on the displayed image to calculate the corresponding target location on the ground. You can tap the result display box to copy the result text to your clipboard or open the position in the maps app of your choice by clicking the blue hyperlink:

ATAK Cursor on Target

When the "✉️" button is pressed, OpenAthena will send a Cursor on Target multicast UDP packet to udp://239.2.3.1:6969 to all devices on the same network as your device. Under default settings, this will cause a marker to show up in ATAK at the target location for all recipients:

Change the marker to its appropriate type (friend, suspect, hostile) in ATAK, then send the updated target to other networked users.

Arbitrary Point Selection

OpenAthena allows users to tap any point in the image to locate it. Tapping on any point in the image will move the marker and calculate the new location. A new Cursor-on-Target message will not be sent to ATAK until the "✉️" button is pressed:

Application Settings (optional) ⚙:

OpenAthena for Android supports multiple output modes for target calculation, including:

• Latitude, Longitude (standard WGS84)
• UTM (Universal Transverse Mercator)
• Nato Military Grid Reference System (MGRS) 1m, 10m, and 100m
• CK-42 Система координат Latitude Longitude (an alternative geodetic system commonly used in slavic countries)
• CK-42 Система координат Gauss-Krüger Grid: Northing, Easting (an alternative military grid reference system used by former Warsaw pact countries)

To change the ouptut mode of OpenAthena for Android, tap the kebab menu icon (three dots) at the top-right corner of the screen and select "Settings":

Select your desired output mode by pressing its button in the list:

Then press the back button or again tap the kebab menu icon (three dots) to return to the "Calculate" screen:

The app also supports selection between Meter and US Foot as the Distance Unit for the apps's output.

Telemetry and localization from live video feed

The end goal of this project is to enable UAS operators to perform terrain-raycast localization from any point within a live video feed. The target resolution engine of this application is highly modular and may be extended to operate on any such telemetry data source. This capability will be specific to each UAS manufacturer's SDK; therefore, it will take time to develop.

Contributing

OpenAthena™ for Android is an open source project, and we thrive on contributions from the community. Whether you're a seasoned developer or just starting out, we welcome your involvement in making OpenAthena better for everyone.

Why Contribute?

Contributing to OpenAthena means being part of a community that values innovation and collaboration. It’s an opportunity to enhance your skills, connect with other talented individuals, and make a tangible impact on a tool that benefits drone enthusiasts and professionals around the world.

How You Can Contribute

• Code Contributions: If you're looking to write code, check out our issues on GitHub, especially those tagged with "Good First Issue". These are great for getting started!
• Bug Reports: Encountering bugs? Report them on our GitHub issue tracker. Detailed reports can help us improve stability and user experience.
• Feature Suggestions: Have ideas on how to make OpenAthena even better? We love hearing new ideas! Share them as feature requests on our issue tracker.
• Documentation: Help us improve our documentation to ensure it's clear and accessible to everyone. All documentation will be in Markdown format

Contributor license agreement

Other than documentation changes, contributors to this project must agree to Theta's Contributor License Agreement (CLA). This CLA is the minimum necessary to protect the OpenAthena project; it is designed to be as short and simple as possible to preserve the interests of contributors.

Code

If you're interested in contributing to this project, feel free to make a fork. This project will follow the fork and pull model for third-party contributions.

Cloning this project with submodules

This project requires content from other git repositories (such as Theta's DroneModels database) to build correctly.

To clone this project properly, with the necessary submodules:

git clone --recursive git@github.com:Theta-Limited/OpenAthenaAndroid.git # can also use https clone url instead

If you have already cloned, and wish to acquire the neccesary submodule contents:

git submodule init
git submodule update

If you wish to update the contents of submodules from their source:

git submodule update --remote

OPENTOPOGRAPHY_API_KEY in local.properties for DEM downloading

The OpenAthena app's automatic DEM downloading feature requires an Application Programming Interface (API) key from OpenTopography.org (obtainable here) to function. Such an API key authenticates the app with OpenTopography's servers for DEM downloading. A default key will be automatically included in releases from the Google Play or Apple AppStore; however, you will need to obtain one for yourself if you clone this project's code from GitHub or download it from F-Droid.

Add your OpenTopography API key from within the OpenAthena app

If you have downloaded OpenAthena™ from GitHub or F-Droid, you will be prompted the following upon your first time opening the app:

Select the option "take me there now!" to go to the screen for obtaining and inputting your API key (it can also be accessed at any time from the 3 dot action menu on the top right).

You will see "API Key Status: X (Invalid)", with a description and link below:

Click on the link to be taken to the OpenTopography.org website. There, create an account, sign in, go to the "MyOpenTopo Dashboard", and click on "Get An API Key":

Finally, paste your API key into the OpenAthena™ for Android app and hit the "Apply button":

If you have an internet connection, the API Key Status should appear as ✅ (Valid). If you are offline the status will appear as ❓ (Unknown). If your API key is in fact valid, the software will work correctly with the OpenTopography API for DEM downloading once internet connection is restored.

How to Acquire and use an OpenTopography API Key for building this project

Follow the instructions in the link below to obtain an API Key for OpenTopography.org:

https://opentopography.org/blog/introducing-api-keys-access-opentopography-global-datasets

After cloning this project, edit the file local.properties which is auto-generated by Android Studio in the root directory of the project. It should have appearance similar to below:

## This file must *NOT* be checked into Version Control Systems,
# as it contains information specific to your local configuration.
#
# Location of the SDK. This is only used by Gradle.
# For customization when using a Version Control System, please read the
# header note.
#Tue Jun 14 14:32:24 EDT 2022
sdk.dir=/home/YOURNAME/Android/Sdk/

Add your OpenTopography API key to the end of the local.properties file:

OPENTOPOGRAPHY_API_KEY=nlhhp3yd9ud54tr3eem4akqv49wcb23i

...replacing nlhh...23i with the OpenTopography API key you obtained from the above link

You will then be able to build the project and the API key will be included in the app.

Acknowledgements

This software project would not be possible without the tireless work of many U.S. public servants and open source maintainers. Please see CREDITS.md for a full list of included software libraries, and their authors and licenses.

Version v0.21.0 and later of this software use services of the website OpenTopography.org for DEM downloading within the app. The privacy policy of this website is available below:

https://opentopography.org/privacypolicy

OpenTopography is operated by the University of California San Diego with support from the National Science Foundation. It is not affiliated with the OpenAthena project.