updated docs

pull/5/head
Tom Early 8 years ago
parent 2e77ba3815
commit 35eec883f8

@ -35,8 +35,9 @@ sudo apt-get upgrade
sudo apt-get install make g++ unzip git libconfig++-dev sudo apt-get install make g++ unzip git libconfig++-dev
If you are building a QnetGateway + MMDVMHost system, please use the instructions If you are building a QnetGateway + MMDVMHost system, please use the instructions
in the MMDVM.README file. If you are building a QnetGateway for a DVAP or a in the MMDVM.README file. If you are building a QnetGateway for an Icom repeater,
DVRPTR_V1 read on... use the qn.icom.cfg configuration file as a starting point for your configuration.
If you are building a QnetGateway for a DVAP or a DVRPTR_V1 read on...
git clone git://github.com/n7tae/QnetGateway.git git clone git://github.com/n7tae/QnetGateway.git
@ -44,20 +45,28 @@ This will create a QnetGateway directory with everything you need to build a dva
dvrptr ircddb gateway. dvrptr ircddb gateway.
The first thing to do is change to the build directory with "cd QnetGateway" and then The first thing to do is change to the build directory with "cd QnetGateway" and then
type "make" to build all the QnetGateway executables. If you need DTMFS then also choose a target to make. There are targets for each of the supported devices:
execute "make g2link_test". . "make icom" will build all programs needed for the Icom repeater.
. "make dvap" will build all programs needed for the DVAP Dongle.
Next, create your qn.cfg configuration file. There are two example for you to look . "make dvrptr" will build all programs needed for the DVRPTR_V1.
. "make mmdvm" will build all programs needed for MMDVMHost support. (You need
to download and build MMDVMHost separately, see the MMDVM.README file for more info.
. "make" will build all the QnetGateway executables.
Next, create your qn.cfg configuration file. There are three example for you to look
at: at:
. qn.everything.cfg contains all parameter with lengthly comments about what . qn.everything.cfg contains all parameter with lengthly comments about what
each parameter does. The definitions that are commented out are defined with each parameter does. The definitions that are commented out are defined with
their default value. their default value.
. qn.dvap.cfg is the simplest possible configuration for a 2m DVAP. If you have . qn.dvap.cfg is the simplest possible configuration for a 2m DVAP. If you have
a 70cm DVAP rename the module to "b" and change the frequency. a 70cm DVAP rename the module to "b" and change the frequency.
. qn.icom.cfg is the starting place for configuring an Icom repeater. Please note
that QnetGateway doesn't support the 23cm data only module in the Icom repeater
stack.
Remeber the everything file contain detailed comments about all of the values you Remeber the everything file or the icom file contain detailed comments about all of
can set. Just read through it and edit accordingly. In the end you will need the values you can set. Just read through it and edit accordingly. In the end you will
a configuration file called "qn.cfg". need a configuration file called "qn.cfg".
Additional information about the configuration as well as other important and Additional information about the configuration as well as other important and
useful features are also in the CONFIGURING file. useful features are also in the CONFIGURING file.
@ -79,38 +88,36 @@ problem"!
There are MANY OTHER gateways to which you can connect. Executing get_gwys_list.sh There are MANY OTHER gateways to which you can connect. Executing get_gwys_list.sh
will download a HUGE list of reflectors and gateways from www.va3uv.com with port will download a HUGE list of reflectors and gateways from www.va3uv.com with port
address that may need port-forwarding to your sytem. I have provided anotherscript, address that may need port-forwarding to your sytem.
'get_reflectors.sh' that will download the same list from va3uv.com, but filter it
so that it only contains DCS x-reflectors (DCSXXX), DStar reflectors (REFXXX) and
X-reflectors (XRFXXX) and it will put all x-reflectors on port 20001 so you
probably won't need any port-forwarding on your home router.
There is another script, reflist.sh, that will download REF, XRF and DCS reflectors There is another script, reflist.sh, that will download REF, XRF and DCS reflectors
from another source. This is probably the preferred method to getting a gwys.txt from another source. This is probably the preferred method to getting a gwys.txt
file. file. This source is extremely up-to-date.
Based on the above discussion, execute either "./reflist.sh" or "./get_gwy_list.sh".
Based on the above discussion, execute either "./reflist.sh", "./get_reflectors.sh" or If you plan on using DTMF, you need to copy "qndtmf.sh" to "qndtmf". This is the
"./get_gwy_list.sh". file that interprets dtmf command and executes them. As supplied, it parses the
DTMF string and executes a QnetRemote command to perform linking and unlinking
and other useful tasks. It is a /bin/bash script so you can modify it! You can
change the commands or create new commands.
If you plan on using DTMFS, you can also edit proc_qnlinktest to add new You are now ready to install your QnetGateway system. If you are installing an
dtmfs commands. MMDVM-based system, follow the instructions in MMDVM.README.
Then install your system. you have two choices, either DVAP or DVRPTR_V1 by To install either DVAP or DVRPTR_V1, type "sudo make installdvap" or "sudo make
typing "sudo make installdvap" or "sudo make installdvrptr", respectively. installdvrptr", respectively. If you are installing on an Icom repeater, type
This should get you up and running. It will take a few minutes for QnetGateway "sudo make installicom". This should get you up and running. It will take a few
to get fully connected to the IRCDDB network. minutes for QnetGateway to get fully connected to the IRCDDB network.
Finally, if you want/need DTMFS, type "sudo make installdtmfs". Finally, if you want/need DTMFS, type "sudo make installdtmfs".
The service scripts in /lib/systemd/system and everything else in /usr/local: The service scripts in /lib/systemd/system and everything else in /usr/local:
The executables will be in /usr/local/bin and the qn.cfg file and other data The executables will be in /usr/local/bin and the qn.cfg file and other data
will be in /usr/local/etc. will be in /usr/local/etc. Please note that the qn.cfg file and the gwys.txt
file are actually symbolic links and point back to the files you created in
If you find that you need to modify the configuration file, remember that the the build directory. So if you want modify them later, modify the files in the
installed systems read the /usr/local/etc/qn.cfg file, NOT THE ONE IN YOUR build directory.
BUILD DIRECTORY. To keep them synced, it is good admin practice to modify the
qn.cfg file in your build directory and then do a "sudo make uninstall<dvap or
dvrptr>" followed by an "sudo make install<dvap or dvrptr>.
If you are having trouble connecting, use journalctl to view the log output If you are having trouble connecting, use journalctl to view the log output
of each process. "sudo journalctl -u <service name> will show the log from that of each process. "sudo journalctl -u <service name> will show the log from that
@ -118,21 +125,18 @@ service. The QnetGateway service is qngateway, QnetLink is qnlink, QnetDVAP is
qndvap and QnetDVRPTR is qndvrptr. qndvap and QnetDVRPTR is qndvrptr.
The beginning of each log file will report the values of all the configuration The beginning of each log file will report the values of all the configuration
parameters (even the ones you didn't specify in qm.cfg) and after that parameters (even the ones you didn't specify in qn.cfg) and after that
you will see the verbose reports of what each service is doing. These logs are you will see the verbose reports of what each service is doing. These logs are
invaluable for traking down problems with your qn.cfg file. You can see in real invaluable for traking down problems with your qn.cfg file. You can see in real
time what is being added to the logs during operation appending "-f" to the time what is being added to the logs during operation appending "-f" to the
journalctl command. journalctl command.
You can clean up the build directory of intermediate *.o files with "make clean" You can clean up the build directory of intermediate *.o files, *.d file and the
or, you can remove the intermediate *.o files and binary executables with "make executables with "make clean".
realclean". Note that "make realclean" only removes the binary files from your
build directory and not the copies you installed into /usr/local/bin with the
"sudo make install..." command.
If you want to uninstall everything return to the build directory and type either If you want to uninstall everything return to the build directory and type
"sudo make unistalldvap" or "sudo make uninstalldvrptr" and possibly "sudo make "sudo make unistalldvap", "sudo make uninstalldvrptr" or "sudo make uninstallicom"
uninstalldtmfs". This will shutdown the services and remove the service scripts and possibly "sudo make uninstalldtmfs". This will shutdown the services and
and everything from /usr/local. remove the service scripts and everything from /usr/local.
Tom Early, n7tae (at) arrl (dot) net Tom Early, n7tae (at) arrl (dot) net

@ -1,7 +1,7 @@
QnetGateway QnetGateway
=========== ===========
The QnetGateway is an D-Star IRCDDB gateway application that supports MMDVMHost (and all of its supported repeater modems) as well as the DVAP Dongle and the DVRPTR_V1. It is *incredibly easy* to build and install the system. The QnetGateway is an D-Star IRCDDB gateway application that supports MMDVMHost (and all of its supported repeater modems) as well as the DVAP Dongle, the DVRPTR_V1 and now the Icom repeater. It is *incredibly easy* to build and install the system.
For building a QnetGateway + MMDVMHost system, see the MMDVM.README file. To build QnetGateway that uses a DVAP Dongle or DVRPTR V1, see the BUILDING file. For building a QnetGateway + MMDVMHost system, see the MMDVM.README file. To build QnetGateway that uses a DVAP Dongle or DVRPTR V1, see the BUILDING file.

Loading…
Cancel
Save

Powered by TurnKey Linux.