-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
44 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,46 +8,48 @@ aiscot - AIS Cursor-on-Target Gateway. | |
|
||
|
||
aiscot receives AIS Sentences from an AIS Receiver, such as ais-decoder, | ||
converts them to Cursor-on-Target Events, and transmits the CoT Events to a destination. | ||
converts them to Cursor-on-Target Events, and transmits the CoT Events to a | ||
destination. | ||
|
||
For use with CoT systems such as ATAK, WinTAK, etc. See https://www.civtak.org/ for more information on the TAK | ||
program. | ||
For use with CoT systems such as ATAK, WinTAK, etc. See https://www.civtak.org/ | ||
for more information on the TAK program. | ||
|
||
Utilized for an open ocean boat race in the Northern Pacific Ocean, as | ||
described in this article: http://ampledata.org/boat_race_support.html | ||
|
||
Support AISCoT Development | ||
Support AISCOT Development | ||
========================== | ||
|
||
AISCoT has been developed for the Disaster Response, Public Safety and Frontline community at-large. This software | ||
is currently provided at no-cost to our end-users. All development is self-funded and all time-spent is entirely | ||
voluntary. Any contribution you can make to further these software development efforts, and the mission of AISCoT | ||
to provide ongoing SA capabilities to our end-users, is greatly appreciated: | ||
AISCOT has been developed for the Disaster Response, Public Safety and | ||
Frontline community at-large. This software is currently provided at no-cost to | ||
our end-users. All development is self-funded and all time-spent is entirely | ||
voluntary. Any contribution you can make to further these software development | ||
efforts, and the mission of AISCOT to provide ongoing SA capabilities to our | ||
end-users, is greatly appreciated: | ||
|
||
.. image:: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png | ||
:target: https://www.buymeacoffee.com/ampledata | ||
:alt: Support AISCoT development: Buy me a coffee! | ||
:alt: Support AISCOT development: Buy me a coffee! | ||
|
||
Installation | ||
============ | ||
|
||
|
||
The AIS to Cursor on Target Gateway is provided by a command-line tool | ||
called `aiscot`, which can be installed several ways. | ||
AISCOT functionality is provided by a command-line tool called `aiscot`, | ||
which can be installed several ways. | ||
|
||
Installing as a Debian/Ubuntu Package:: | ||
Installing as a Debian/Ubuntu Package [USE ME]:: | ||
|
||
$ 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/aiscot/releases/latest/download/python3-aiscot_latest_all.deb | ||
$ sudo apt install -f ./python3-aiscot_latest_all.deb | ||
|
||
Install from the Python Package Index:: | ||
Install from the Python Package Index [Alternative]:: | ||
|
||
$ pip install aiscot | ||
|
||
|
||
Install from this source tree:: | ||
Install from this source tree [Developer]:: | ||
|
||
$ git clone https://github.com/ampledata/aiscot.git | ||
$ cd aiscot/ | ||
|
@@ -57,44 +59,45 @@ Install from this source tree:: | |
Usage | ||
===== | ||
|
||
The `aiscot` daemon has several runtime arguments:: | ||
|
||
$ aiscot -h | ||
usage: aiscot [-h] [-c CONFIG_FILE] [-d] [-U COT_URL] [-P AIS_PORT] [-S COT_STALE] [-F FILTER_CONFIG] [-K KNOWN_CRAFT] | ||
AISCOT can be configured with a INI-style configuration file, or using | ||
environmental variables. | ||
|
||
optional arguments: | ||
Command-line options: | ||
-h, --help show this help message and exit | ||
-c CONFIG_FILE, --CONFIG_FILE CONFIG_FILE | ||
-d, --DEBUG Enable DEBUG logging | ||
-U COT_URL, --COT_URL COT_URL | ||
URL to CoT Destination. Must be a URL, e.g. tcp:1.2.3.4:1234 or tls:...:1234, etc. | ||
-P AIS_PORT, --AIS_PORT AIS_PORT | ||
AIS UDP Listen Port. | ||
-S COT_STALE, --COT_STALE COT_STALE | ||
CoT Stale period, in seconds | ||
-F FILTER_CONFIG, --FILTER_CONFIG FILTER_CONFIG | ||
FILTER_CONFIG | ||
-K KNOWN_CRAFT, --KNOWN_CRAFT KNOWN_CRAFT | ||
KNOWN_CRAFT | ||
|
||
See example-config.ini for example configuration. | ||
|
||
Configuration options: | ||
COT_URL : `str` | ||
URL to CoT Destination. Must be a URL, e.g. tcp:1.2.3.4:1234 or tls:...:1234, etc. | ||
AIS_PORT : `int` | ||
AIS UDP Listen Port. | ||
COT_STALE : `int` | ||
CoT Stale period, in seconds. Default 3600 seconds (1 hour). | ||
KNOWN_CRAFT : `str` | ||
Known Craft hints file. CSV file containing callsign/marker hints. | ||
|
||
See example-config.ini in the source tree for example configuration. | ||
|
||
|
||
Source | ||
====== | ||
Github: https://github.com/ampledata/aiscot | ||
|
||
|
||
Author | ||
====== | ||
Greg Albrecht W2GMD [email protected] | ||
|
||
http://ampledata.org/ | ||
|
||
|
||
Copyright | ||
========= | ||
|
||
* aiscot Copyright 2021 Greg Albrecht, Inc. | ||
* aiscot Copyright 2022 Greg Albrecht | ||
* pyAISm.py Copyright 2016 Pierre Payen | ||
|
||
|
||
License | ||
======= | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters