Simplify, simplify, simplify! -- Henry David Thoreau

Author: wb2osz

conf/generic.conf

@@ -1,6 +1,6 @@
 %C%#############################################################
 %C%#                                                           #
-%C%#               Configuration file for Dire Wolf            #
+%C%#        Sample configuration file for Dire Wolf            #
 %C%#                                                           #
 %L%#                   Linux version                           #
 %W%#                   Windows version                         #
@@ -14,7 +14,7 @@
 %R%	It would be a maintenance burden to keep most of
 %R%	two different versions in sync.
 %R%	This common source is now used to generate the
-%R%	two different variations while having only a single
+%R%	three different variations while having only a single
 %R%	copy of the common parts.
 %R%
 %R%	The first column contains one of the following:
@@ -38,6 +38,10 @@
 %M%# /usr/local/share/doc/direwolf/ or /usr/share/doc/direwolf/
 %M%# Concise "man" pages are also available for Mac OSX.
 %C%#
+%C%# Recommended Reading for everyone:
+%C%# "Understanding APRS Packets"  in https://github.com/wb2osz/aprsspec
+%C%#
+%C%#
 %C%# Questions???  Join the discussion forum:  https://groups.io/g/direwolf
 %C%#
 %C%#
@@ -90,7 +94,7 @@
 %C%#############################################################
 %C%#                                                           #
 %C%#               FIRST AUDIO DEVICE PROPERTIES               #
-%C%#               (Channel 0 + 1 if in stereo)                #
+%C%#               (Channel 0 or 0 + 1 if in stereo)           #
 %C%#                                                           #
 %C%#############################################################
 %C%
@@ -121,11 +125,12 @@
 %W%#	 *    4: Speakers (Realtek High Definiti   (channels 0 & 1)
 %W%#	      5: Realtek Digital Output (Realtek
 %W%#
-%W%# Example: To use the microphone and speaker connections on the
-%W%# system board, either of these forms can be used:
+%W%# It is recommended that you use a unique substring of the device description.
+%W%# For example, use "High" or "Realtek High Def" for the built in sound system.
+%W%# Use "USB", or a longer string to distinguish amount multiple devices for a USB audio.
+%W%# You can also use numbers but you are asking for trouble.  Device numbers can change.
 %W%
-%W%#ADEVICE High
-%W%#ADEVICE  3 4
+%W%#ADEVICE USB
 %W%
 %W%
 %W%# Example: To use the USB Audio, use a command like this with
@@ -158,16 +163,6 @@
 %L%
 %L%# ADEVICE  plughw:1,0
 %L%
-%L%# You can also use "-" or "stdin" to pipe stdout from
-%L%# some other application such as a software defined radio.
-%L%# "stdin" is not an audio device.  Don't use this unless you
-%L%# understand what this means.  Read the User Guide.
-%L%# You can also specify "UDP:" and an optional port for input.
-%L%# Something different must be specified for output.
-%L%
-%L%# ADEVICE stdin plughw:1,0
-%L%# ADEVICE UDP:7355 default
-%L%
 %R% ---------- Mac ----------
 %R%
 %M%# Macintosh Operating System uses portaudio driver for audio
@@ -182,44 +177,9 @@
 %M%
 %M%# ADEVICE  "USB Audio Codec:6"  "USB Audio Codec:5"
 %M%#
-%M%#
-%M%# You can also use "-" or "stdin" to pipe stdout from
-%M%# some other application such as a software defined radio.
-%M%# "stdin" is not an audio device.  Don't use this unless you
-%M%# understand what this means.  Read the User Guide.
-%M%# You can also specify "UDP:" and an optional port for input.
-%M%# Something different must be specified for output.
 %M%
-%M%# ADEVICE UDP:7355 default
-%M%#
-%C%
-%C%#
-%C%# Number of audio channels for this souncard:  1 (mono) or 2 (stereo).
-%C%# 1 is the default so there is no need to specify it.
-%C%#
-%C%
-%C%#ACHANNELS 2
-%C%
-%C%
-%C%#############################################################
-%C%#                                                           #
-%C%#               SECOND AUDIO DEVICE PROPERTIES              #
-%C%#               (Channel 2 + 3 if in stereo)                #
-%C%#                                                           #
-%C%#############################################################
-%C%
-%C%#ADEVICE1  ...
-%C%
-%C%
-%C%#############################################################
-%C%#                                                           #
-%C%#               THIRD AUDIO DEVICE PROPERTIES               #
-%C%#               (Channel 4 + 5 if in stereo)                #
-%C%#                                                           #
-%C%#############################################################
-%C%
-%C%#ADEVICE2  ...
-%C%
+%C%# Many more details and examples can be found in: 
+%C%# https://github.com/wb2osz/direwolf-doc/blob/main/Radio-Interface-Guide.pdf
 %C%
 %C%#############################################################
 %C%#                                                           #
@@ -230,11 +190,6 @@
 %C%CHANNEL 0
 %C%
 %C%#
-%C%# The following MYCALL, MODEM, PTT, etc. configuration items
-%C%# apply to the most recent CHANNEL.
-%C%#
-%C%
-%C%#
 %C%# Station identifier for this channel.
 %C%# Multiple channels can have the same or different names.
 %C%#
@@ -259,20 +214,14 @@
 %C%# In most cases you can just specify the speed.  Examples:
 %C%#
 %C%
-%C%MODEM 1200
+%C%#MODEM 300
 %C%#MODEM 9600
 %C%
 %C%#
 %C%# Many options are available for great flexibility.
 %C%# See User Guide for details.
 %C%#
 %C%
-%C%#
-%C%# Uncomment line below to enable the DTMF decoder for this channel.
-%C%#
-%C%
-%C%#DTMF
-%C%
 %C%# Push to Talk (PTT) can be confusing because there are so many different cases.
 %C%# https://github.com/wb2osz/direwolf-doc/blob/main/Radio-Interface-Guide.pdf
 %C%# goes into detail about the various options.
@@ -291,59 +240,10 @@
 %W%
 %W%#PTT CM108
 %W%%C%#
-%C%# The transmitter Push to Talk (PTT) control can be wired to a serial port
-%C%# with a suitable interface circuit.  DON'T connect it directly!
-%C%#
-%C%# For the PTT command, specify the device and either RTS or DTR.
-%C%# RTS or DTR may be preceded by "-" to invert the signal.
-%C%# Both can be used for interfaces that want them driven with opposite polarity.
-%C%#
-%L%# COM1 can be used instead of /dev/ttyS0, COM2 for /dev/ttyS1, and so on.
-%L%#
-%C%
-%C%#PTT COM1 RTS
-%C%#PTT COM1 RTS -DTR
-%L%#PTT /dev/ttyUSB0 RTS
-%L%#PTT /dev/ttyUSB0 RTS -DTR
-%C%
-%L%#
-%L%# On Linux, you can also use general purpose I/O pins if
-%L%# your system is configured for user access to them.
-%L%# This would apply mostly to microprocessor boards, not a regular PC.
-%L%# See separate Raspberry Pi document for more details.
-%L%# The number may be preceded by "-" to invert the signal.
-%L%#
-%L%
-%L%#PTT GPIO 25
-%L%
-%C%# The Data Carrier Detect (DCD) signal can be sent to most of the same places
-%C%# as the PTT signal.  This could be used to light up an LED like a normal TNC.
-%C%
-%C%#DCD COM1 -DTR
-%L%#DCD GPIO 24
-%C%
-%C%
-%C%#############################################################
-%C%#                                                           #
-%C%#               CHANNEL 1 PROPERTIES                        #
-%C%#                                                           #
-%C%#############################################################
 %C%
-%C%#CHANNEL 1
-%C%
-%C%#
-%C%# Specify MYCALL, MODEM, PTT, etc. configuration items for
-%C%# CHANNEL 1.   Repeat for any other channels.
-%C%
-%C%
-%C%#############################################################
-%C%#                                                           #
-%C%#               TEXT TO SPEECH COMMAND FILE                 #
-%C%#                                                           #
-%C%#############################################################
-%C%
-%W%#SPEECH dwespeak.bat
-%L%#SPEECH dwespeak.sh
+%C%# There are other possibilities such as serial port RTS, Raspberry Pi GPIO pins,
+%C%# and hamlib for CAT control.   For more details see:
+%C%# https://github.com/wb2osz/direwolf-doc/blob/main/Radio-Interface-Guide.pdf
 %C%
 %C%
 %C%#############################################################
@@ -361,38 +261,6 @@
 %W%#	- KISS TNC via serial port
 %L%#	- KISS TNC via pseudo terminal   (-p command line option)
 %C%#
-%C%
-%C%AGWPORT 8000
-%C%KISSPORT 8001
-%C%
-%W%#
-%W%# Some applications are designed to operate with only a physical
-%W%# TNC attached to a serial port.  For these, we provide a virtual serial
-%W%# port that appears to be connected to a TNC.
-%W%#
-%W%# Take a look at the User Guide for instructions to set up
-%W%# two virtual serial ports named COM3 and COM4 connected by
-%W%# a null modem.
-%W%#
-%W%# Using the  configuration described, Dire Wolf will connect to
-%W%# COM3 and the client application will use COM4.
-%W%#
-%W%# Uncomment following line to use this feature.
-%W%
-%W%#NULLMODEM COM3
-%W%
-%W%
-%C%#
-%C%# It is sometimes possible to recover frames with a bad FCS.
-%C%# This is not a global setting.
-%C%# It applies only the the most recent CHANNEL specified.
-%C%#
-%C%#	0 - Don't try to repair.  (default)
-%C%#	1 - Attempt to fix single bit error.
-%C%#
-%C%
-%C%#FIX_BITS 0
-%C%
 %C%#
 %C%#############################################################
 %C%#                                                           #
@@ -410,16 +278,10 @@
 %C%# Each has a series of keywords and values for options.
 %C%# See User Guide for details.
 %C%#
-%C%# Example:
-%C%#
-%C%# This results in a broadcast once every 10 minutes.
-%C%# Every half hour, it can travel via one digipeater hop.
-%C%# The others are kept local.
+%C%# Example:  PLEASE change the latitude and longitude.  
 %C%#
 %C%
-%C%#PBEACON delay=1  every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA" via=WIDE1-1
-%C%#PBEACON delay=11 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA"
-%C%#PBEACON delay=21 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA"
+%C%#PBEACON overlay=S symbol="digi" lat=42^37.14N long=071^20.83W power=50 height=20 gain=4 comment="Chelmsford MA"
 %C%
 %C%#
 %C%# Did you know that APRS comments and messages can contain UTF-8 characters, not only plain ASCII?
@@ -428,29 +290,6 @@
 %C%#PBEACON delay=11 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W comment=" Did you know that APRS comments and messages can contain UTF-8 characters?   \xce\xa1\xce\xb1\xce\xb4\xce\xb9\xce\xbf\xce\xb5\xcf\x81\xce\xb1\xcf\x83\xce\xb9\xcf\x84\xce\xb5\xcf\x87\xce\xbd\xce\xb9\xcf\x83\xce\xbc\xcf\x8c\xcf\x82"
 %C%#PBEACON delay=21 every=30 overlay=S symbol="digi" lat=42^37.14N long=071^20.83W comment=" Did you know that APRS comments and messages can contain UTF-8 characters?   \xe3\x82\xa2\xe3\x83\x9e\xe3\x83\x81\xe3\x83\xa5\xe3\x82\xa2\xe7\x84\xa1\xe7\xb7\x9a"
 %C%#
-%C%# With UTM coordinates instead of latitude and longitude.
-%C%
-%C%#PBEACON delay=1 every=10 overlay=S symbol="digi" zone=19T easting=307477 northing=4720178
-%C%
-%C%
-%C%#
-%C%# When the destination field is set to "SPEECH" the information part is
-%C%# converted to speech rather than transmitted as a data frame.
-%C%#
-%C%
-%C%#CBEACON dest="SPEECH" info="Club meeting tonight at 7 pm."
-%C%
-%C%# Similar for Morse code.  If SSID is specified, it is multiplied
-%C%# by 2 to get speed in words per minute (WPM).
-%C%
-%C%#CBEACON dest="MORSE-6" info="de MYCALL"
-%C%
-%C%
-%C%#
-%C%# Modify for your particular situation before removing
-%C%# the # comment character from the beginning of appropriate lines above.
-%C%#
-%C%
 %C%
 %C%#############################################################
 %C%#                                                           #
@@ -497,29 +336,12 @@
 %C%# That's all you need for a receive only IGate which relays
 %C%# messages from the local radio channel to the global servers.
 %C%
-%C%# Some might want to send an IGate client position directly to a server
-%C%# without sending it over the air and relying on someone else to
-%C%# forward it to an IGate server.  This is done by using sendto=IG rather
-%C%# than a radio channel number. Overlay R for receive only, T for two way.
-%C%# There is no need to send it as often as you would over the radio.
-%C%
-%C%#PBEACON sendto=IG delay=0:30 every=60:00 symbol="igate" overlay=R lat=42^37.14N long=071^20.83W
-%C%#PBEACON sendto=IG delay=0:30 every=60:00 symbol="igate" overlay=T lat=42^37.14N long=071^20.83W
-%C%
-%C%
-%C%# To relay messages from the Internet to radio, you need to add
+%C%# To relay APRS "messages" from the Internet to radio, you need to add
 %C%# one more option with the transmit channel number and a VIA path.
 %C%
 %C%#IGTXVIA 0 WIDE1-1,WIDE2-1
 %C%
-%C%
-%C%# Finally, we don't want to flood the radio channel.
-%C%# The IGate function will limit the number of packets transmitted
-%C%# during 1 minute and 5 minute intervals.   If a limit would
-%C%# be exceeded, the packet is dropped and message is displayed in red.
-%C%# This might be low for APRS Thursday when there is abnormally high activity.
-%C%
-%C%IGTXLIMIT 6 10
+%C%# For more information see Successful-IGate-Operation.pdf.
 %C%
 %C%
 %C%#############################################################