Metadata-Version: 2.1
Name: aiscot
Version: 3.1.0
Summary: AIS Cursor-on-Target Gateway.
Home-page: https://github.com/ampledata/aiscot
Author: Greg Albrecht
Author-email: oss@undef.net
License: Apache License, Version 2.0
Description: aiscot - AIS Cursor-on-Target Gateway.
        ****************************************
        **IF YOU HAVE AN URGENT OPERATIONAL NEED**: Email ops@undef.net or call/sms +1-415-598-8226
        
        .. image:: docs/screenshot-1601068921-25.png
           :alt: Screenshot of AIS points in ATAK-Div Developer Edition.
           :target: docs/screenshot-1601068921.png
        
        
        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.
        
        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
        ==========================
        
        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!
        
        Installation
        ============
        
        
        The AIS to Cursor on Target Gateway is provided by a command-line tool
        called `aiscot`, which can be installed several ways.
        
        Installing as a Debian/Ubuntu Package::
        
            $ 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::
        
            $ pip install aiscot
        
        
        Install from this source tree::
        
            $ git clone https://github.com/ampledata/aiscot.git
            $ cd aiscot/
            $ python setup.py aiscot
        
        
        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]
        
            optional arguments:
              -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.
        
        Source
        ======
        Github: https://github.com/ampledata/aiscot
        
        Author
        ======
        Greg Albrecht W2GMD oss@undef.net
        
        http://ampledata.org/
        
        Copyright
        =========
        
        * aiscot Copyright 2021 Orion Labs, Inc.
        * pyAISm.py Copyright 2016 Pierre Payen
        
        License
        =======
        
        * aiscot is licensed under the Apache License, Version 2.0. See LICENSE for details.
        * pyAISm.py is licensed under the MIT License. See aiscot/pyAISm.py for details.
        
Keywords: Sailing,AIS,Cursor on Target,ATAK,TAK,CoT
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: Apache Software License
Description-Content-Type: text/x-rst
