Skip to content
forked from snstac/adsbxcot

ADSBExchange.com ADS-B to Cursor-On-Target Gateway transforms ADS-B Objects to COT PLI.

License

Notifications You must be signed in to change notification settings

bobgann/adsbxcot

 
 

Repository files navigation

ADSBExchange.com ADS-B to Cursor-On-Target Gateway.

Screenshot of ADS-B PLI in ATAK.

The ADSBXCOT ADS-B to Cursor-On-Target Gateway transforms Automatic Dependent Surveillance-Broadcast (ADS-B) aircraft position information into Cursor-On-Target (COT) Position Location Information for display on Situational Awareness applications such as the Android Team Awareness Kit (ATAK), WinTAK, RaptorX, TAKX, iTAK, et al. ADS-B data is provided by ADSBExchange.com and requires an API key from that service.

For more information on the TAK suite of tools, see: https://www.tak.gov/

ADSBXCOT Concept.

Support Development

Tech Support: Email support@undef.net or Signal/WhatsApp: +1-310-621-9598

This tool has been developed for the Disaster Response, Public Safety and Frontline Healthcare community. This software is currently provided at no-cost to users. Any contribution you can make to further this project's development efforts is greatly appreciated.

Support Development: Buy me a coffee!

Installation

ADSBXCOT's functionality provided by a command-line program called adsbxcot.

Installing as a Debian / Ubuntu Package [Recommended]:

$ sudo apt update
$ wget https://github.com/ampledata/aircot/releases/latest/download/python3-aircot_latest_all.deb
$ sudo apt install -f ./python3-aircot_latest_all.deb
$ wget https://github.com/ampledata/pytak/releases/latest/download/python3-pytak_latest_all.deb
$ sudo apt install -f ./python3-pytak_latest_all.deb
$ wget https://github.com/ampledata/adsbxcot/releases/latest/download/python3-adsbxcot_latest_all.deb
$ sudo apt install -f ./python3-adsbxcot_latest_all.deb

Install from the Python Package Index (PyPI) [Advanced Users]:

$ pip install adsbxcot

Install from this source tree [Developers]:

$ git clone https://github.com/ampledata/adsbxcot.git
$ cd adsbxcot/
$ python setup.py install

Usage

The adsbxcot command-line program has 2 runtime arguments:

usage: adsbxcot [-h] [-c CONFIG_FILE]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG_FILE, --CONFIG_FILE CONFIG_FILE. Default: config.ini

Configuration

Configuration parameters can be specified either via environment variables or in a INI-stile configuration file.

Parameters:

  • ADSBX_URL: ADSBExchange.com API or Rapid API URL.
  • COT_URL: (optional) Destination for Cursor-On-Target messages. See PyTAK for options.
  • POLL_INTERVAL: (optional) Period in seconds to poll API. Default: 30
  • KNOWN_CRAFT: (optional) CSV-style aircraft hints file for overriding callsign, icon, COT Type, etc.
  • INCLUDE_TISB: (optional) If set, will also including TIS-B identified aircraft.
  • INCLUDE_ALL_CRAFT: (optional) If set & KNOWN_CRAFT is set, will include aircraft not in KNOWN_CRAFT.

There are other configuration parameters available via PyTAK.

Configuration parameters are imported in the following priority order:

  1. config.ini (if exists) or -c <filename> (if specified).
  2. Environment Variables (if set).
  3. Defaults.

Source

ADSBXCOT source can be found on Github: https://github.com/ampledata/adsbxcot

Author

ADSBXCOT is written and maintained by Greg Albrecht W2GMD oss@undef.net

https://ampledata.org/

Copyright

ADSBXCOT is Copyright 2022 Greg Albrecht

License

Copyright 2022 Greg Albrecht <oss@undef.net>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

ADSBExchange.com ADS-B to Cursor-On-Target Gateway transforms ADS-B Objects to COT PLI.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 94.1%
  • Makefile 5.9%