KB8PMY
/
QnetGateway
mirror of https://github.com/n7tae/QnetGateway.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More doucmentation changes

Browse Source
pull/12/head
Tom Early 7 years ago
parent b7590b5b49
commit 6c4996e580
6 changed files with 58 additions and 76 deletions
Show Stats Download Patch File Download Diff File

18
DTMF+REMOTE+VOICE.README
Unescape View File

@ -52,26 +52,26 @@ to a moule configured on you gateway. It has a simple interface, like
QnetRemote. To get started, open a shell on your system and type "qnvoice": QnetRemote. To get started, open a shell on your system and type "qnvoice":
pi@raspberrypi:~ $ qnvoice pi@raspberrypi:~ $ qnvoice
Usage: qnvoice <module> <mycall> <dvtoolFile> Usage: qnvoice <module> <mycall> <dat_file>
Where... Where...
module is one of your modules module is one of your modules
mycall is your personal callsign mycall is your personal callsign
dvtoolFile is a dvtool file dat_file is a .dat voice file file
Please note that <module> and <mycall> are not case sensitive, but Please note that <module> and <mycall> are not case sensitive, but
<dvtoolFile> is. <dat_file> is.
So what's a DVTool file? All the voice prompts delivered with QnetGateway, So what's a .dat voice file? All the voice prompts delivered with QnetGateway,
in the QnetGateway/announce directory and DVTool files. And, you can in the QnetGateway/announce directory are .dat files. And, you can
easily create your own! easily create your own!
To make your own DVTool file, just put " S0" in your radio's YourCall To make your own .dat voice file file, just put " S0" in your radio's
and key up and talk. You will be making a "voice mail" DVTool file: YourCall and key up and talk. You will be making a "voice mail" .dat file:
/tmp/X_voicemail.dat, where X is the module on which you are transmitting. /tmp/X_voicemail.dat, where X is the module on which you are transmitting.
Once you have created it, you can move it out of the /tmp directory and Once you have created it, you can move it out of the /tmp directory and
rename it. Then you can use it in a qnvoice command. You can also replace rename it. Then you can use it in a qnvoice command. You can also replace
all of the standard voice messsages with your own. If you want to do this all of the standard voice messages with your own. If you want to do this
put your versions in a directory outside of the build directoy and make put your versions in a directory outside of the build directory and make
a small script that will copy your messages over the existing, installed a small script that will copy your messages over the existing, installed
messages: messages:

102
MMDVM.README
Unescape View File

@ -16,92 +16,68 @@ disable the serial0 console in the /boot/cmdline.txt file: Remove the reference
"console=serial0,115200" in this file. You should also disable bluetooth by adding: "console=serial0,115200" in this file. You should also disable bluetooth by adding:
"dtoverlay=pi3-disable-bt" (without the quotes) to the end of the /boot/config.txt. "dtoverlay=pi3-disable-bt" (without the quotes) to the end of the /boot/config.txt.
1) Install the only external library you need: sudo apt-get install libconfig++-dev In your home directory...
Yeah! No wxWidgets!
Now in your home directory... 1) Clone the MMDVMHost repository: git clone git://github.com/g4klx/MMDVMHost.git
2) Clone the MMDVMHost repository: git clone git://github.com/g4klx/MMDVMHost.git 2) cd into the MMDVMHost directory and compile: make
3) cd into the MMDVMHost directory and compile: make
If you're system has multiple processors, use: make -jx If you're system has multiple processors, use: make -jx
where x is the number of processors on you system. where x is the number of processors on you system.
To tell how many processors you have: cat /proc/cpuinfo | grep processor | wc -l To tell how many processors you have: cat /proc/cpuinfo | grep processor | wc -l
4) Copy the ini file template: cp MMDVM.ini MMDVM.qn 3) Copy the ini file template: cp MMDVM.ini MMDVM.qn
5) Edit the MMDVM.qn file. Set your Callsign and Id. Turn off duplex. Enable an 4) Edit the MMDVM.qn file. Set your Callsign and Id. Turn off duplex. Enable an
external display, if you have one. Set the Frequency(s). Set the Latitude and external display, if you have one. Set the Frequency(s). Set the Latitude and
other location info if you want. Change the log levels. I use DisplayLevel=2 other location info if you want. Change the log levels. I use DisplayLevel=2
and FileLevel=0. Set the Port on your modem. Disable all services except for and FileLevel=0. Set the Port on your modem. Disable all services except for
D-Star (at least for now). Very important: Set the [D-Star] Module. For UHF D-Star (at least for now). Very important: Set the [D-Star] Module. For UHF
use B and for VHF use C. use B and for VHF use C.
6) Let's test it! Start it: ./MMDVMHost MMDVM.qn 5) Let's test it! Start it: ./MMDVMHost MMDVM.qn
7) Key your radio and see if the MMDVMHost responds with an acknowledgement. Then 6) Key your radio and see if the MMDVMHost responds with an acknowledgment. Then
you'll know that everything on the MMDVM side is fine. you'll know that everything on the MMDVM side is fine.
8) Stop the MMDVMHost with a Control-C and edit the MMDVM.qn file again. Change 7) Stop the MMDVMHost with a Control-C and edit the MMDVM.qn file again. Change
the [D-Star] AckReply=0 the [D-Star] AckReply=0
You won't/don't want this reply from MMDVMhost. You want the acknowledgement You won't/don't want this reply from MMDVMhost. You want the acknowledgment
from QnetGateway, it's more informative. from QnetGateway, it's more informative.
We'll come back to MMDVMHost later, but for now let's work on the QnetGateway. We'll come back to MMDVMHost later, but for now let's work on the QnetGateway.
9) cd back to the home directory and clone the QnetGateway: 8) cd back to the home directory and clone the QnetGateway. Type:
git clone git://github.com/n7tae/QnetGateway.git git clone git://github.com/n7tae/QnetGateway.git
10) Get into the build directory: cd QnetGateway 9) Get into the build directory. Type: cd QnetGateway
11) Then compile: make 10) You need a configuration file called qn.cfg for QnetGateway. Start the
don't forget the -j option! configuration script: ./qnconfig
This script will allow you to change any configuration parameter from its
12) You need a configuration file called qn.cfg for QnetGateway. A good, nearly default value. At a minimum, you need to set your login callsign in the ircddb
working config file is qn.mmdvm.cfg. Copy it to qn.cfg and edit it. section and define at least one module. If you want to use the legacy,
If you are planning on linking to a Trust DPlus (REF) reflector or repeater, closed-source D-Plus reflectors and repeaters, be sure to enable it in the
please look over the "dplus" section to enable this. You need to already be D-Plus menu. Be sure to write out your configruation file after you have entered
registered (www.dstargateway.org) to do this. all your changes, then you can exit the configuration script.
13) You need a gwys.txt file for all the systems to which you may wish to link. 11) Next, your ready to install your software. For that, start the administration
If you want to be able to link to repeaters: ./get_gwy_list.sh script. Type: ./qnadmin
If you are only interested in linking to reflectors: ./reflist.sh First you want to create you gwys.txt file. This file contains a list of
This will download and format your gwys.txt file. reflectors and repeaters you might like to link. Got into the gwys.txt menu
If the reflector(s) or repeater(s) you use most often are not present in the creation sub-menu with "gw" and select one of three different methods to
gwys.txt file, you can add them manually, using the same syntax as the existing generate a gwys.txt file. You can add and/or delete records manually in
entries, at the end of the file. this sub-menu. Return to the main menu because your now ready to build and
If you find you can no longer connect to a system, it may be because its IP install your system. Install your configured system with "is". This will
address has changed. You can execute either script again, copy it to compile and install everything that you have configured.
/usr/local/etc, and then: either reboot you system, or put " F" in your
URField and key your radio, or: sudo systemctl restart qnlink 12) You also need to install your MMDVMHost with "im".
14) We have a gwys.txt file and a qn.cfg in the build directory, so we are ready
to install and start the three QnetGateway services: sudo make install
15) Now it's time to start the MMDVMHost service. You'll do this from the
QnetGateway directory you are aleady in: sudo make installmmdvm
This command will fail if it can't find both MMDVMHost and MMDVM.qn
in the ../MMDVMHost directory.
You should be up and running now! Congratulations! <Fireworks!> You should be up and running now! Congratulations! <Fireworks!>
16) You can see the log of any of the 4 services that make up the QnetGateway + 13) There are many additional things that can be done in the administration menu.
MMDVMHost system: Enter the log menu with "l" and from there you can view logs from each
sudo journalctl -u qngateway -f running process.
sudo journalctl -u qnlink -f
sudo journalctl -u qnrelay -f 14) DTMF is _not_ enabled by default if you want it, type "id" in the main menu.
sudo journalctl -u mmdvm -f
15) Build and start other MMDVMHost services...
You can do all four of these in one terminal window (that you can detach from!)
by using "screen": sudo apt-get install screen
If you don't know how to use screen: http://aperiodic.net/screen/quick_reference
Being able to detach from a screen session is very useful, especially if you are
operating "headless"!
17) DTMF is _not_ enabled by default if you want it, you need to do two things:
First, create a working DTMF script. In the build directory: cp qndtmf.sh qndtmf
Then, install the DTMF service: sudo make installdtmf
You should be good to go, The DTMF command "00" should announce the linked
status of you module. See DTMF+REMOTE.README for more information.
18) Build and start other MMDVMHost services...

4
OPERATING
Unescape View File

@ -234,6 +234,10 @@ band to a remote reflector. QnetLink software is used by our QnetGateway
Before we begin, there are some dat files included that are the voice Before we begin, there are some dat files included that are the voice
prompts used by QnetGateway and QnetLink: prompts used by QnetGateway and QnetLink:
rebooting.dat
baddtmfcmd.dat
gatewayrestart.dat
shutdown.dat
connected2network.dat connected2network.dat
notincache.dat notincache.dat
gatewaynotfound.dat gatewaynotfound.dat

7
README.md
Unescape View File

@ -1,11 +1,11 @@
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, the DVRPTR_V1 and now the Icom repeater. 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. It is *incredibly easy* to build and install the system.
The Qnet Gateway program now includes support for Icom's new Terminal mode. Access Point mode is still having some performance issues and we will be working on this. For more information, please read the ITAP.README file. The Qnet Gateway program now includes support for Icom's new Terminal mode. Access Point mode is still having some performance issues and we will be working on this. For more information, please read the ITAP.README 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. To build QnetGateway for an Icom Repeater Stack, switch to another branch after cloning the repository: For building a QnetGateway + MMDVMHost system, see the MMDVM.README file. To build QnetGateway that uses a DVAP Dongle or DVRPTR V1, see the CONFIG+INSTALL file. To build QnetGateway for an Icom Repeater Stack, switch to another branch after cloning the repository:
``` ```
git checkout lastudp git checkout lastudp
@ -21,11 +21,12 @@ Then look to the MMDVM.README or the BUILDING file for more information.
QnetGateway includes a "remote control" program, called `qnremote`. After you build and install the system, type `qnremote` for a prompt on how to use it. Using this and cron, it's possible to setup schedules where you system will automatically link up to a reflector, or subscribe to a Routing Group. For More information, see DTMF+REMOTE.README. QnetGateway includes a "remote control" program, called `qnremote`. After you build and install the system, type `qnremote` for a prompt on how to use it. Using this and cron, it's possible to setup schedules where you system will automatically link up to a reflector, or subscribe to a Routing Group. For More information, see DTMF+REMOTE.README.
For other details of interesting things QnetGatway can do, see the CONFIGURING file. For example, with QnetGateway, you can execute up to 36 different Linux scripts from you radio. Two scripts are include: For other details of interesting things QnetGatway can do, see the OPERATING file. For example, with QnetGateway, you can execute up to 36 different Linux scripts from you radio. Two scripts are include:
``` ```
YourCall = " HX" will halt your system. YourCall = " HX" will halt your system.
YourCall = " RX" will reboot your system. YourCall = " RX" will reboot your system.
YourCall - " GX" will restart QnetGateway
``` ```
QnetGateway is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. QnetGateway is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details. QnetGateway is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. QnetGateway is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.

2
defaults
Unescape View File

@ -156,7 +156,7 @@ dplus_authorize_d=false # set to true if you want to use the closed-source D
dplus_ref_login_d='' # for logging into REF reflectors, if empty, ircddb_login will be used dplus_ref_login_d='' # for logging into REF reflectors, if empty, ircddb_login will be used
dplus_use_reflectors_d=true # set to false if you are not going to link to DPlus reflectors dplus_use_reflectors_d=true # set to false if you are not going to link to DPlus reflectors
dplus_use_repeaters_d=true # set to false if you are not going to link to DPlus repeaters dplus_use_repeaters_d=true # set to false if you are not going to link to DPlus repeaters
dplus_priority_d=false # set to true if you want DPlus reflector read after gwys.txt dplus_priority_d=true # set to true if you want DPlus reflector read after gwys.txt
########################################################################################################################## ##########################################################################################################################
# #

1
qndtmf.sh
Unescape View File

@ -13,6 +13,7 @@
# Example: *00103 will link local module to REF001 C # Example: *00103 will link local module to REF001 C
# Example: 0 or 00 will report status of the link, " I" # Example: 0 or 00 will report status of the link, " I"
# Example: ##08 will execute the exec_H.sh script (shutdown the system) # Example: ##08 will execute the exec_H.sh script (shutdown the system)
# Please note that scripts exec_[0-9].sh are not accessible from DTMF.
# We set this to spaces, it will be set later # We set this to spaces, it will be set later

Write Preview
Loading…
Cancel
Save

Powered by TurnKey Linux.