File	Date	Author	Commit
CHANGES	2021-10-14	n1uro	[63cf25] Initial commit
COPYING	2021-10-14	n1uro	[63cf25] Initial commit
README.txt	2021-10-14	n1uro	[63cf25] Initial commit
ax25xmpp.conf	2021-10-14	n1uro	[63cf25] Initial commit
ax25xmpp.py	2021-10-14	n1uro	[63cf25] Initial commit
install	2021-10-14	n1uro	[63cf25] Initial commit

Read Me

Welcome to the AX.25 <-> XMPP (Jabber) gateway.

Features
--------

 * Bidirectional chat bridge between AX.25 and Jabber.

 * Integrates with Jabber presence system.  Sets its state description
   to a dscription of the node that you're chatting with.  Indicates
   it's offline when the remote end drops the link.

 * Accepts details on the command line which are then passed to the
   Jabber user at the beginning of the chat.

 * Visually similar to ttylinkd for AX.25 users.

Installation
------------

You will need Python and the xmpppy package.  Debian users can get it
with apt-get install python-xmpp.  Others can find it at
http://xmpppy.sourceforge.net/. The install script by N1URO will attempt to
get this for you on a debian (based) system.

Configuration
-------------

Create a config file somewhere.  It needs only two lines, which should
look like this:

JID=nodealias@example.com
PASSWORD=foobar

You can optionally append a /resource to the JID if you wish.  This
configuration file gives the account that the bridge logs in to; the
command line gives the account it will transmit its messages to. With
changed by YO2LOJ, a /resource by default will be preset by the callsign
of the remote user making the page.

Invocation
----------

You can run ax25xmpp from the shell for testing.  It will attempt to
auto-detect whether to use Unix \n line-endings or AX.25 \r
line-endings.  If it is called from a terminal, it uses \n endings.

The parameters are:

ax25xmpp /path/to/configfile destJID port call nodename [UNIXEOL]

port, call, and nodename are used for display purposes only.  You can
make them up if desired.  If you give UNIXEOL at the end, it will
force it to Unix line endings (as, for instance, called by the node
program).

Example Configuration
---------------------

an ax25d.conf line could be:

default 7 * * * * * -           nobody /usr/local/bin/ax25xmpp.py /usr/local/bin/ax25xmpp.py /etc/ax25/ax25xmpp.conf yourcall@example.com %d %S %R

And a node.conf line could be:

ExtCmd          CHat    1       nobody  /usr/local/bin/ax25xmpp.py /usr/local/bin/ax25xmpp.py /etc/ax25/ax25xmpp.conf yourcall@example.com %t %s %r UNIXEOL

Example Session
---------------

Here is a typescript of an example session.

The user sees:

n1uro-15@n1uro.ampr.org:/uronode6: page
Executing command...
ax25xmpp bridge (c) 2010 John Goerzen, 2003-2008 Alexey Nezhdanov
Updated 2020 Marius Petrescu YO2LOJ and Brian Rogers N1URO
Who would you like to chat with? Ex. n1uro@n1uro.com
n1uro@n1uro.com
Paging n1uro@n1uro.com... If they're online they should respond soon.
Type /ex or .ex on a blank line to exit at anytime.
n1uro@n1uro.com has responded.
<n1uro@n1uro.com>: Good evening
Good evening to you, are you enjoying this bridge?
<n1uro@n1uro.com>: Yes, it's a lot of fun.
ok bye
<n1uro@n1uro.com>: bye.
Connection closed by n1uro@n1uro.com.
End of command.

The user paged sees:

07:50:19 pm
UNIVLE  
Chat request via ipv6 from call n1uro-15 on 0.0.0.0.  Type /ex or .ex to close session. Note: user may be on RF, regulations apply.

07:50:30 pm
n1uro  
Good evening

UNIVLE is now Away. 
07:50:32 pm
 
07:50:47 pm
UNIVLE  
Good evening to you, are you enjoying this bridge?

07:50:55 pm
n1uro  
Yes, it's a lot of fun.

07:51:00 pm
UNIVLE  
ok bye

07:51:04 pm
n1uro  
bye.
.ex

07:51:12 pm
UNIVLE  
Connection closed by you.

UNIVLE is now Offline. 
07:51:15 pm