aprsd-nearest-plugin 0.1.1
Amateur radio APRS plugin that files closest repeaters.

============================
APRSD Nearest station plugin
============================


.. image:: https://img.shields.io/pypi/v/aprsd_nearest_plugin.svg
        :target: https://pypi.python.org/pypi/aprsd_nearest_plugin

.. image:: https://img.shields.io/travis/hemna/aprsd_nearest_plugin.svg
        :target: https://travis-ci.com/hemna/aprsd_nearest_plugin

.. image:: https://readthedocs.org/projects/aprsd-nearest-plugin/badge/?version=latest
        :target: https://aprsd-nearest-plugin.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status


.. image:: https://pyup.io/repos/github/hemna/aprsd_nearest_plugin/shield.svg
     :target: https://pyup.io/repos/github/hemna/aprsd_nearest_plugin/
     :alt: Updates

.. contents:: :local:

Message Plugin for the python APRSD daemon to find nearest HAM repeaters


* Free software: Apache Software License 2.0
* Documentation: https://aprsd-nearest-plugin.readthedocs.io.



Features
--------

* This uses the haminfo API service to request the closest repeaters
  to GPS coordinates of a HAM callsign that is reporting beacons on the APRS-IS
  network.
* For more information on the haminfo service look here: https://github.com/hemna/haminfo
* This plugin allows filter on HAM radio frequency band, as well as capabilities
  of the repeaters.
* Defaults to the 2m frequency band

Usage Format
------------
This is the message format accepted.  [] denotes optional.
See: examples_

Format:

* <n[earest]> [Num Stations] [Band] [Filters]


Command parts
=============

* <n[earest]> - The command that this plugin requires to be used. The full command name is 'nearest', but a simple 'n' works.
* [Num Stations]  - The number of stations to return. Default is 1.
* [Band] - The fequency Band to use. Default is 2m. See: frequencies_
* [Filters] - One or more filters in the format of +[capability] See: capabilities_


.. _examples:

Example Usage
-------------
* 'nearest 2m' - Find the closest 2m station to my last APRS beacon
* 'n' - Same as above.
* 'nearest 2 2m'  - the 2 closest 2meter band stations to my last APRS beacon
* 'n 2 2m' - Same as above.
* 'n 70cm' - The closest 70cm station to my last APRS Beacon.
* 'n +echolink' - The closest echolink repeater to my last APRS Beacon.
* 'n +echo' - The closest echolink repeater to my last APRS Beacon.
* 'n +dstar' - find the closest repeater that supports dstar


.. _frequencies:

List of Frequency bands supported
---------------------------------
* 160m - 160 Meters (1.8-2.0 MHz)
* 80m - 80 Meters (3.5-4.0 MHz)
* 60m - 60 Meters (5 MHz)
* 40m - 40 Meters (7.0 - 7.3 MHz)
* 30m - 30 Meters(10.1 - 10.15 MHz)
* 20m - 20 Meters(14.0 - 14.35 MHz)
* 17m - 17 Meters(18.068 - 18.168 MHz)
* 15m - 15 Meters(21.0 - 21.45 MHz)
* 12m - 12 Meters(24.89 - 24.99 MHz)
* 10m - 10 Meters(28 - 29.7 MHz)
* 6m  - 6 Meters(50 - 54 MHz)
* 2m  - 2 Meters(144 - 148 MHz)  -- DEFAULT
* 1.25m - 1.25 Meters(222 - 225 MHz)
* 70cm - 70 Centimeters(420 - 450 MHz)
* 33cm - 33 Centimeters(902 - 928 MHz)
* 23cm - 23 Centimeters(1240 - 1300 MHz)
* 13cm - 13 Centimeters(2300 - 2310 and 2390 - 2450 MHz)
* 9cm  - 9 centimeters(3300-3500 MHz)
* 5cm  - 5 Centimeters(5650.0 - 5925.0 MHz)
* 3cm  - 3 Centimeters(10000.000 - 10500.000 MHz )


.. _capabilities:

List of capabilities supported
------------------------------
These are the capabilities that can be used as a filter in the command string:

* allstar
* ares
* dmr
* dstar
* echolink
* echo - Same as above (echolink)
* irlp
* races
* skywarn
* wires


Requirements
------------
This is a plugin to the APRSD (https://pypi.org/project/aprsd/) message daemon.


Installation
------------
``pip install aprsd-nearest-plugin``


APRSD Configuration settings
----------------------------
You must add this plugin to the list of plugins enabled in your aprsd.yml
config file.

::

  aprsd:
     enabled_plugins:
        - aprsd_nearest_plugin.aprsd_nearest_plugin.NearestPlugin

  services:
    haminfo:
        base_url: <URL to the haminfo API> - http://192.168.1.22:8081
        apiKey: <The haminfo apikey to use>

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage