Documentation updates.

This commit is contained in:
WB2OSZ 2017-04-26 18:11:24 -04:00
parent 9d2fbdd3f7
commit 60fe31c6fc
3 changed files with 48 additions and 21 deletions

View File

@ -2,11 +2,10 @@
# Revision History # # Revision History #
## Version 1.4 -- Beta Test-- April 2017 ## ## Version 1.4 -- April 2017 ##
**This is beta test quality. If no significant issues are reported this will be the version 1.4 release.**
### New Features (since 1.3): ### ### New Features: ###
- AX.25 v2.2 connected mode. See chapter 10 of User Guide for details. - AX.25 v2.2 connected mode. See chapter 10 of User Guide for details.
@ -29,6 +28,7 @@
- $PMGNWPL - Magellan, more complete for stationary objects. - $PMGNWPL - Magellan, more complete for stationary objects.
- $PKWDWPL - Kenwood with APRS style symbol but missing comment. - $PKWDWPL - Kenwood with APRS style symbol but missing comment.
- DTMF tones can be sent by putting "DTMF" in the destination address, similar to the way that Morse Code is sent. - DTMF tones can be sent by putting "DTMF" in the destination address, similar to the way that Morse Code is sent.
- Take advantage of new 'gpio' group and new /sys/class/gpio ownership in Raspbian Jessie. - Take advantage of new 'gpio' group and new /sys/class/gpio ownership in Raspbian Jessie.
@ -39,7 +39,7 @@
### Bugs Fixed (since 1.3): ### ### Bugs Fixed: ###
- The transmitter (PTT control) was being turned off too soon when sending Morse Code. - The transmitter (PTT control) was being turned off too soon when sending Morse Code.

View File

@ -3,24 +3,24 @@
### Decoded Information from Radio Emissions for Windows Or Linux Fans ### ### Decoded Information from Radio Emissions for Windows Or Linux Fans ###
In the early days of Amateur Packet Radio, it was necessary to use a “Terminal Node Controller” (TNC) with specialized hardware. Those days are gone. You can now get better results at lower cost by connecting your radio to the “soundcard” interface of a computer and using software to decode the signals. In the early days of Amateur Packet Radio, it was necessary to use an expensive “Terminal Node Controller” (TNC) with specialized hardware. Those days are gone. You can now get better results at lower cost by connecting your radio to the “soundcard” interface of a computer and using software to decode the signals.
Dire Wolf is a software "soundcard" modem/TNC and [APRS](http://www.aprs.org/) encoder/decoder. It can be used stand-alone to observe APRS traffic, as a digipeater, [APRStt](http://www.aprs.org/aprstt.html) gateway, or Internet Gateway (IGate). It can also be used as a virtual TNC for other applications such as [APRSIS32](http://aprsisce.wikidot.com/), [UI-View32](http://www.ui-view.net/), [Xastir](http://xastir.org/index.php/Main_Page), [APRS-TW](http://aprstw.blandranch.net/), [YAAC](http://www.ka2ddo.org/ka2ddo/YAAC.html), [UISS](http://users.belgacom.net/hamradio/uiss.htm), [Linux AX25](http://www.linux-ax25.org/wiki/Main_Page), [SARTrack](http://www.sartrack.co.nz/index.html), [RMS Express](http://www.winlink.org/RMSExpress), [BPQ32](http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html), [Outpost PM](http://www.outpostpm.org/) and many others. Dire Wolf is a software "soundcard" modem/TNC and [APRS](http://www.aprs.org/) encoder/decoder. It can be used stand-alone to observe APRS traffic, as a digipeater, [APRStt](http://www.aprs.org/aprstt.html) gateway, or Internet Gateway (IGate). It can also be used as a virtual TNC for other applications such as [APRSIS32](http://aprsisce.wikidot.com/), [UI-View32](http://www.ui-view.net/), [Xastir](http://xastir.org/index.php/Main_Page), [APRS-TW](http://aprstw.blandranch.net/), [YAAC](http://www.ka2ddo.org/ka2ddo/YAAC.html), [UISS](http://users.belgacom.net/hamradio/uiss.htm), [Linux AX25](http://www.linux-ax25.org/wiki/Main_Page), [SARTrack](http://www.sartrack.co.nz/index.html), [RMS Express](http://www.winlink.org/RMSExpress), [BPQ32](http://www.cantab.net/users/john.wiseman/Documents/BPQ32.html), [Outpost PM](http://www.outpostpm.org/) and many others.
## Features ## ## Features & Benefits ##
- Lower cost, higher performance alternative to hardware TNC. - Lower cost, higher performance alternative to hardware TNC.
Decodes more than 1000 error-free frames from [WA8LMF TNC Test CD](http://wa8lmf.net/TNCtest/). Decodes more than 1000 error-free frames from [WA8LMF TNC Test CD](http://wa8lmf.net/TNCtest/).
- Ideal for building a Raspberry Pi digipeater & IGate. - Ideal for building a Raspberry Pi digipeater & IGate.
- Data rates: 300 AFSK, 1200 AFSK, 2400 QPSK, 4800 8PSK, and 9600/19200/38400 K9NG/G3RUH. - Data rates: 300 AFSK, 1200 AFSK, 2400 QPSK, 4800 8PSK, and 9600/19200/38400 bps K9NG/G3RUH.
- Interface with applications by - Interface with applications by
- [AGW](http://uz7.ho.ua/includes/agwpeapi.htm) network protocol - [AGW](http://uz7.ho.ua/includes/agwpeapi.htm) network protocol
- [KISS](http://www.ax25.net/kiss.aspx) serial port - [KISS](http://www.ax25.net/kiss.aspx) serial port
- [KISS](http://www.ax25.net/kiss.aspx) network protocol - [KISS](http://www.ax25.net/kiss.aspx) TCP network protocol
- Decoding of received information for troubleshooting. - Decoding of received information for troubleshooting.
@ -48,9 +48,16 @@ Decodes more than 1000 error-free frames from [WA8LMF TNC Test CD](http://wa8lmf
- Runs in 3 different environments: - Runs in 3 different environments:
- Microsoft Windows XP or later - Microsoft Windows XP or later
- Linux, regular PC or single board computer such as Raspberry Pi, BeagleBone Black, or cubieboard 2 - Linux, regular PC/laptop or single board computer such as Raspberry Pi, BeagleBone Black, cubieboard 2, or C.H.I.P.
- Mac OS X - Mac OS X
## Documentation ##
[Stable Version](https://github.com/wb2osz/direwolf/tree/master/doc)
[Latest Development Version](https://github.com/wb2osz/direwolf/tree/dev/doc)
## Installation ## ## Installation ##
### Windows ### ### Windows ###
@ -60,18 +67,9 @@ Go to the [**releases** page](https://github.com/wb2osz/direwolf/releases). Do
For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc).
### Linux - Download with web browser ###
Go to the [releases page](https://github.com/wb2osz/direwolf/releases). Chose desired release and download the source as zip or compressed tar file. Unpack the files, with "unzip" or "tar xfz," and then:
cd direwolf-* ### Linux - Using git clone (recommended) ###
make
sudo make install
make install-conf
For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). Special considerations for the Raspberry Pi are found in **Raspberry-Pi-APRS.pdf**
### Linux - Using git clone ###
cd ~ cd ~
git clone https://www.github.com/wb2osz/direwolf git clone https://www.github.com/wb2osz/direwolf
@ -80,7 +78,36 @@ For more details see the **User Guide** in the [**doc** directory](https://githu
sudo make install sudo make install
make install-conf make install-conf
This should give you the most recent stable release. If you want the latest (unstable) development version, use "git checkout dev" instead before the first "make" command. This should give you the most recent stable release. If you want the latest (possibly unstable) development version, use "git checkout dev" before the first "make" command.
For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). Special considerations for the Raspberry Pi are found in **Raspberry-Pi-APRS.pdf**
### Linux - Using apt-get (Debian flavor operating systems) ###
Results will vary depending on your hardware platform and operating system version because it depends on various volunteers who perform the packaging.
sudo apt-get update
apt-cache showpkg direwolf
sudo apt-get install direwolf
### Linux - Using yum (Red Hat flavor operating systems) ###
Results will vary depending on your hardware platform and operating system version because it depends on various volunteers who perform the packaging.
sudo yum check-update
sudo yum list direwolf
sudo yum install direwolf
### Linux - Download source in tar or zip file ###
Go to the [releases page](https://github.com/wb2osz/direwolf/releases). Chose desired release and download the source as zip or compressed tar file. Unpack the files, with "unzip" or "tar xfz," and then:
cd direwolf-*
make
sudo make install
make install-conf
For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). Special considerations for the Raspberry Pi are found in **Raspberry-Pi-APRS.pdf** For more details see the **User Guide** in the [**doc** directory](https://github.com/wb2osz/direwolf/tree/master/doc). Special considerations for the Raspberry Pi are found in **Raspberry-Pi-APRS.pdf**

Binary file not shown.