aprsd/README.rst

=====
APRSD
=====

.. image:: https://github.com/craigerl/aprsd/workflows/python/badge.svg
    :target: https://github.com/craigerl/aprsd/actions

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://black.readthedocs.io/en/stable/

.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
    :target: https://timothycrosley.github.io/isort/

.. contents:: :local:

Listen on amateur radio aprs-is network for messages and respond to them.
You must have an amateur radio callsign to use this software.  APRSD gets
messages for the configured HAM callsign, and sends those messages to a
list of plugins for processing.   There are a set of core plugins that
provide responding to messages to check email, get location, ping,
time of day, get weather, and fortune telling as well as version information
of aprsd itself.

Typical use case
================

Ham radio operator using an APRS enabled HAM radio sends a message to check
the weather.  an APRS message is sent, and then picked up by APRSD.  The
APRS packet is decoded, and the message is sent through the list of plugins
for processing.   The WeatherPlugin picks up the message, fetches the weather
for the area around the user who sent the request, and then responds with
the weather conditions in that area.



APRSD Capabilities
------------------

* server - The main aprsd server processor.  Send/Rx APRS messages to HAM callsign
* send-message - use aprsd to send a command/message to aprsd server.  Used for development testing
* sample-config - generate a sample aprsd.yml config file for use/editing
* bash completion generation.  Uses python click bash completion to generate completion code for your .bashrc/.zshrc


List of core server plugins
===========================

Plugins function by specifying a regex that is searched for in the APRS message.
If it matches, the plugin runs.  IF the regex doesn't match, the plugin is skipped.

* EmailPlugin - Check email and reply with contents.  Have to configure IMAP and SMTP settings in aprs.yml
* FortunePlugin - Replies with old unix fortune random fortune!
* LocationPlugin - Checks location of ham operator
* PingPlugin - Sends pong with timestamp
* TimePlugin - Current time of day
* WeatherPlugin - Get weather conditions for current location of HAM callsign
* VersionPlugin - Reports the version information for aprsd


Current messages this will respond to:
======================================

::

  APRS messages:
   l(ocation) [callsign]  = descriptive current location of your radio
                            8 Miles E Auburn CA 1673' 39.92150,-120.93950 0.1h ago
   w(eather)              = weather forecast for your radio's current position
                            58F(58F/46F) Partly Cloudy. Tonight, Heavy Rain.
   t(ime)                 = respond with the current time
   f(ortune)              = respond with a short fortune
   -email_addr email text = send an email, say "mapme" to send a current position/map
   -2                     = resend the last 2 emails from your imap inbox to this radio
   p(ing)                 = respond with Pong!/time
   anything else          = respond with usage


Meanwhile this code will monitor a single imap mailbox and forward email
to your BASECALLSIGN over the air.  Only radios using the BASECALLSIGN are allowed
to send email, so consider this security risk before using this (or Amatuer radio in
general).  Email is single user at this time.

There are additional parameters in the code (sorry), so be sure to set your
email server, and associated logins, passwords.  search for "yourdomain",
"password".  Search for "shortcuts" to setup email aliases as well.


Installation:
-------------

  pip install aprsd

Example usage:
==============

  aprsd -h

Help
====
::

    └─[$] > aprsd -h
    Usage: aprsd [OPTIONS] COMMAND [ARGS]...

      Shell completion for click-completion-command Available shell types:
      bash         Bourne again shell   fish         Friendly interactive shell
      powershell   Windows PowerShell   zsh          Z shell Default type: auto

    Options:
      --version   Show the version and exit.
      -h, --help  Show this message and exit.

    Commands:
      install        Install the click-completion-command completion
      sample-config  This dumps the config to stdout.
      send-message   Send a message to a callsign via APRS_IS.
      server         Start the aprsd server process.
      show           Show the click-completion-command completion code


Commands
--------

sample-config
=============
This command outputs a sample config yml formatted block that you can edit
and use to pass in to aprsd with -c.

  aprsd sample-config

Output
======
::

    └─[$] > aprsd sample-config

    aprs:
      host: rotate.aprs.net
      logfile: /tmp/arsd.log
      login: someusername
      password: somepassword
      port: 14580
    aprsd:
      enabled_plugins:
      - aprsd.plugin.EmailPlugin
      - aprsd.plugin.FortunePlugin
      - aprsd.plugin.LocationPlugin
      - aprsd.plugin.PingPlugin
      - aprsd.plugin.TimePlugin
      - aprsd.plugin.WeatherPlugin
      - aprsd.plugin.VersionPlugin
      plugin_dir: ~/.config/aprsd/plugins
    ham:
      callsign: KFART
    imap:
      host: imap.gmail.com
      login: imapuser
      password: something here too
      port: 993
      use_ssl: true
    shortcuts:
      aa: 5551239999@vtext.com
      cl: craiglamparter@somedomain.org
      wb: 555309@vtext.com
    smtp:
      host: imap.gmail.com
      login: something
      password: some lame password
      port: 465
      use_ssl: false


server
======

This is the main server command that will listen to APRS-IS servers and
look for incomming commands to the callsign configured in the config file

::

    └─[$] > aprsd server --help
    Usage: aprsd server [OPTIONS]

      Start the aprsd server process.

    Options:
      --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
                                      The log level to use for aprsd.log
                                      [default: DEBUG]

      --quiet                         Don't log to stdout
      --disable-validation            Disable email shortcut validation.  Bad
                                      email addresses can result in broken email
                                      responses!!

      -c, --config TEXT               The aprsd config file to use for options.
                                      [default: ~/.config/aprsd/aprsd.yml]

      -h, --help                      Show this message and exit.
    (.venv3) ┌─[waboring@dl360-1] - [~/devel/aprsd] - [Sun Dec 20, 12:32] -
    └─[$] <git:(master*)> aprsd server
    Load config
    [12/20/2020 12:33:03 PM] [MainThread  ] [INFO ] APRSD Started version: 1.0.2
    [12/20/2020 12:33:03 PM] [MainThread  ] [INFO ] Checking IMAP configuration
    [12/20/2020 12:33:04 PM] [MainThread  ] [INFO ] Checking SMTP configuration


send-message
============

This command is typically used for development to send another aprsd instance
test messages

::

    └─[$] > aprsd send-message -h
    Usage: aprsd send-message [OPTIONS] TOCALLSIGN [COMMAND]...

      Send a message to a callsign via APRS_IS.

    Options:
      --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
                                      The log level to use for aprsd.log
                                      [default: DEBUG]

      --quiet                         Don't log to stdout
      -c, --config TEXT               The aprsd config file to use for options.
                                      [default: ~/.config/aprsd/aprsd.yml]

      --aprs-login TEXT               What callsign to send the message from.
                                      [env var: APRS_LOGIN]

      --aprs-password TEXT            the APRS-IS password for APRS_LOGIN  [env
                                      var: APRS_PASSWORD]

      -h, --help                      Show this message and exit.

Example output:
---------------


SEND EMAIL (radio to smtp server)
=================================

::

    Received message______________
    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :-user@host.com test new shortcuts global, radio to pc{29
    From        : KM6XXX
    Message     : -user@host.com test new shortcuts global, radio to pc
    Msg number  : 29

    Sending Email_________________
    To          : user@host.com
    Subject     : KM6XXX
    Body        : test new shortcuts global, radio to pc

    Sending ack __________________ Tx(3)
    Raw         : KM6XXX-9>APRS::KM6XXX   :ack29
    To          : KM6XXX
    Ack number  : 29


RECEIVE EMAIL (imap server to radio)
====================================

::

    Sending message_______________ 6(Tx3)
    Raw         : KM6XXX-9>APRS::KM6XXX   :-somebody@gmail.com email from internet to radio{6
    To          : KM6XXX
    Message     : -somebody@gmail.com email from internet to radio

    Received message______________
    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack6
    From        : KM6XXX
    Message     : ack6
    Msg number  : 0


WEATHER
=======

::

    Received message______________
    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :weather{27
    From        : KM6XXX
    Message     : weather
    Msg number  : 27

    Sending message_______________ 6(Tx3)
    Raw         : KM6XXX-9>APRS::KM6XXX   :58F(58F/46F) Partly cloudy. Tonight, Heavy Rain.{6
    To          : KM6XXX
    Message     : 58F(58F/46F) Party Cloudy. Tonight, Heavy Rain.

    Sending ack __________________ Tx(3)
    Raw         : KM6XXX-9>APRS::KM6XXX   :ack27
    To          : KM6XXX
    Ack number  : 27

    Received message______________
    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack6
    From        : KM6XXX
    Message     : ack6
    Msg number  : 0


LOCATION
========

::

    Received message______________
    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :location{28
    From        : KM6XXX
    Message     : location
    Msg number  : 28

    Sending message_______________ 7(Tx3)
    Raw         : KM6XXX-9>APRS::KM6XXX   :8 Miles NE Auburn CA 1673' 39.91150,-120.93450 0.1h ago{7
    To          : KM6XXX
    Message     : 8 Miles E Auburn CA 1673' 38.91150,-120.93450 0.1h ago

    Sending ack __________________ Tx(3)
    Raw         : KM6XXX-9>APRS::KM6XXX   :ack28
    To          : KM6XXX
    Ack number  : 28

    Received message______________
    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack7
    From        : KM6XXX
    Message     : ack7
    Msg number  : 0

AND... ping, fortune, time.....


Development
===========

* git clone git@github.com:craigerl/aprsd.git
* cd aprsd
* virtualenv .venv
* source .venv/bin/activate
* pip install -e .
* pre-commit install

Workflow
--------

While working aprsd, The workflow is as follows

* Edit code, save file
* run tox -epep8
* run tox -efmt
* run tox -p
* git commit  ( This will run the pre-commit hooks which does checks too )


Release
-------

To do release to pypi:

* Tag release with

   git tag -v1.XX -m "New release"

* push release tag up

  git push origin master --tags

* Build dist and wheel

  python setup.py sdist bdist_wheel

* Verify build is valid for pypi (need twine installed )

  pip install twine
  twine check dist/*

* Once twine is happy, upload release to pypi

  twine upload dist/*


Docker Container
----------------

Building
--------

There are 2 versions of the container Dockerfile that can be used.
The main Dockerfile, which is for building the official release container
based off of the pip install version of aprsd and the Dockerfile-dev,
which is used for building a container based off of a git branch of
the repo.

Official Build
--------------

 docker build -t hemna6969/aprsd:latest .

Development Build
-----------------

 docker build -t hemna6969/aprsd:latest -f Dockerfile-dev .


Running the container
---------------------

There is a docker-compose.yml file that can be used to run your container.
There are 2 volumes defined that can be used to store your configuration
and the plugins directory:  /config and /plugins

If you want to install plugins at container start time, then use the
environment var in docker-compose.yml specified as APRS_PLUGINS
Provide a csv list of pypi installable plugins.  Then make sure the plugin
python file is in your /plugins volume and the plugin will be installed at
container startup.  The plugin may have dependencies that are required.
The plugin file should be copied to /plugins for loading by aprsd