IRCDDB OPENDV Files

###############################################################################
#                                                                             #
#                             G2_link+ - v.1.03     		              #
#                             =================			              #
#                                                                             #
###############################################################################


Document Content
================

- License informations

- Descriptive 

- Installation on Voyage Linux 

- useful Commands 

- G2_link configuration 

- Radio commands 

###############################################################################

License informations
====================

## G2_link+ is under GNU GENERAL PUBLIC LICENSE (see the COPYING.txt file for more details)
#

## get_gwy_list_tcp is not an open source software therefore the GNU GENERAL PUBLIC LICENSE is not applicable
#

## dvtool_send is under GNU GENERAL PUBLIC LICENSE (see the COPYING.txt file for more details)
#

## dvtool_send_text is under GNU GENERAL PUBLIC LICENSE (see the COPYING.txt file for more details)
#

## G2link_test is under GNU GENERAL PUBLIC LICENSE (see the COPYING.txt file for more details)
#

##############################################################################

Descriptive
============

#	g2_link
#	`------ doc
#	`------ scripts
#		`------ sounds
#	 		|     `-----fr
#	 		|     `-----us
#	`------ src
#	 	|     `----- dvtools
#	 	|     `----- g2link_test
#		|     `----- g2_link
#	`------ var


## G2_link + is a modified version of G2_link of KI4LKF
#
# G2_link allows establishing bidirectional fixed links 
# to gateways based on the programs series G2_ircddb and G2_ircddb +
#
#
## This program uses the following ports:
#
# 
- Communication with G2_IRCDDB ou G2_IRCDDB+
#
# UDP Port: 18997 
#
- DV transmission of IRCDDB
#
# 
- Communication with Ref(UStrust Reflectors),DNGL(DV-Dongles or Hot-spot)
# You not need redirect this port if g2_ircddb it is on the same machine that g2_link
#
# UDP Port: 20001
# It is imperative to redirect this port on your router to the machine that executes g2_link
#
- Communication with XRF(IRCDDB Reflectors)
#
# UDP Port: 30001
# It is imperative to redirect this port on your router to the machine that executes g2_link
#
- communication with DCS(XREFLECTOR Reflectors)
#
# UDP Port: 3051
# It is imperative to redirect this port on your router to the machine that executes g2_link
#

              
               -------------                        
               ¦DV IRCDDB  ¦ 
               ¦Port:40000 ¦
               -------------
   ------------     ¦       -------------  
   ¦IRC Server¦     ¦       ¦APRS Server¦  
   ¦Port:9007 ¦     ¦       ¦Port:14580 ¦  
   ------------     ¦       -------------  
              \     ¦       /               
            ------------------	                  ------------
            ¦		     ¦    Port: 18997     ¦	     ¦
            ¦   G2_IRCDDB+   ¦------------------->¦ G2_link+ ¦
            ¦		     ¦    Port: 40000     ¦	     ¦
            ¦  		     ¦<-------------------¦	     ¦
            ------------------                    ------------
             ¦^     ¦^     ¦^                       /  ¦   \
             ¦¦     ¦¦     ¦¦                      /   ¦    \
             v¦     ¦¦     v¦                     /    ¦     \
  ----------------  ¦¦   ----------------        /     ¦      \
  ¦RPTR mod.A    ¦  ¦¦   ¦RPTR mod.C    ¦       / ------------ \
  ¦IN Port:19998 ¦  ¦¦   ¦IN Port:20000 ¦      /  ¦   XRF:   ¦  \
  ¦OUT Port:19000¦  ¦¦   ¦OUT Port:19000¦     /   ¦Port:30001¦   \
  ----------------  v¦   ----------------    /    ------------    \
             ----------------               /                      \
             ¦RPTR mod.B    ¦         ------------             ------------
             ¦IN Port:19999 ¦         ¦REF/DNGL: ¦             ¦   DCS:   ¦
             ¦OUT Port:19000¦         ¦Port:20001¦             ¦Port:30051¦
             ----------------         ------------             ------------
                                                         
###############################################################################


Installation step by step on Voyage Linux 
=========================================

## Remount the disk on read/write mode ##
#
# root@voyage:~# remountrw
#

## Creating the source folder (if it does not exist) ##
#
# root@voyage:~# mkdir /root/dl_ircddb
#

## Download sources ##
#
- Last version Linux of g2_link+
#
# root@voyage:~# cd /root/dl_ircddb
# ** i386 Voyage
# root@voyage:~/dl_ircddb# wget http://sourceforge.net/projects/ircddbplus/files/gateway/linux/i386/g2-link-plus-v1.03-i386.zip
# root@voyage:~/dl_ircddb# unzip g2-link-plus-v1.013-i386.zip -d /root/g2_link
# ** Raspberry
# root@voyage:~/dl_ircddb# wget http://sourceforge.net/projects/ircddbplus/files/gateway/linux/ARM (Raspberry)/g2-link-plus-v1.03-arm.zip
# root@voyage:~/dl_ircddb# unzip g2-link-plus-v1.03-arm.zip -d /root/g2_link
# root@voyage:~/dl_ircddb# cd
#

## Lunch the installation script ##
#
# root@voyage:~# cd g2_link/scripts/
# root@voyage:~/g2_link# make install
#

## Automatic upgrade of the gateways registery ##     
# 
# root@voyage:~/g2_link# cd scripts
# root@voyage:~/g2_link/scripts/# nano gwy_list.cron.sh 
#
# Complete the following values:
# 
# OWNER= (Call-sign of your gateway, without module letter for example: OWNER=AB9CDE)
#
# login_call= (Sys-op call-sign for example: login_call=XX0XXX)
#
# Press Ctrl X then Y to save and close
# 

## Configure the "LX" command (Manual upgrade of the gateways registery by radio) ##
#
# root@voyage:~/g2_link# nano exec_L.ch
#
# Complete the following values:
#
# OWNER= (Call-sign of your gateway, without module letter for example: OWNER=AB9CDE)
#
# Press Ctrl X then Y to save and close
#

## Configure the g2_link.cfg file ##
#
# Open the configuration file:
#
# root@voyage:~/g2_link/scripts/# cd ..
# root@voyage:~/g2_link# nano g2_link.cfg
#
# Complete the values with your informations
#
# Empty values by default have a 
# sign at the beginning of the line 
# to prevent the program from starting and create errors
# 
# List of essential values to complete:
#
# LOGIN_CALL="Call-sign registred on UStrust" (usually the call-sign of the sysop)
#
# OWNER="Call-sign of your gateway" (without module letter for example: OWNER=AB9CDE)
#
# ADMIN="Administrators call-signs" (usually the call-sign of the sysop)
#
# ADMIN_EXEC="call-sign authorized to execute the scripts" (usually the call-sign of the sysop or users if you restrict the rights)
#
# LINK_UNLINK_USER="call-signs of authorized users to link/unlink the gateway" (usually the call-sign of the sysop or users if you restrict the rights)
#
# Once the values are completed remove the # sign at the beginning of the line, otherwise the program will not start
#
# Example:
#          #LOGIN_CALL=       (inactive value)
#          LOGIN_CALL=AB9CDE  (value properly completed and activated) 
# 
# You can find the complete list of possible adjustment on the section "G2_link Configuration"
#
# Once the values are completed and configured, press Ctrl X then Y to save and close
#
# root@voyage:~/g2_link# remountro (Remount the disk on read-only mode)
#

## End of installation ##
#
# Now you can manually start services (see "useful Commands")
# or reboot the PC (services starts at boot time) 
#

## "Warning if you want make modification after reboot, you need remount the disk on read/write mode with the following command "remountrw" ##
# 

###############################################################################


Useful Commands
================

## Start, Stop or restart g2_link service ##
#
# root@voyage:~/# service g2_link start    (start the service)
# root@voyage:~/# service g2_link stop     (stop the service)
# root@voyage:~/# service g2_link restart  (restart the service)
# 
 
## Start, Stop the g2_link_gwys service  (auto-update of gateways registery)
#
# root@voyage:~/# remountrw (to do before one of next steps)
#
# root@voyage:~/# service g2_link_gwys start    (start the service)
# root@voyage:~/# service g2_link_gwys stop     (stop the service)
# root@voyage:~/# service g2_link_gwys restart  (restart the service)
# 
# root@voyage:~/# remountro (to do after one of previous steps)
#

## Enable or disable the automatic Start of g2_link service ##
#
# root@voyage:~/# update-rc.d -f g2_link defaults  (automatically start the service at boot time)
# root@voyage:~/# update-rc.d -f g2_link remove    (Manual lunch)
#

## Display the g2_link log in real-time (Ctrl C for go-out) ##
#
# root@voyage:~/# tail -f /var/log/g2_link
#

## Manual archiving the g2_link log ##
#
# root@voyage:~/# logrotate -f  /etc/logrotate.conf
#

## For debugging the g2_link log ##
#
# root@voyage:~/g2_link# logrotate -d /etc/logrotate.conf
#

###############################################################################


G2_link Configuration
=====================

## Rules to respect ##
#
# No space before or after the sign =
# Enter call-signs in uppercase
# If there is a # sign in front of a useful value, remove it
# Do not remove comment lines they do not slow down the program
# Do not change the file structure as in case of update it is more difficult to see where there are changes
# Always make a copy of the configuration file before modifying
# Before make modifications you need remount the disk on read/write mode with the following command "remountrw"
# After make modifications you need remount the disk on read-only mode with the following command "remountro"

### Configurable values ###

## LOGIN_CALL (must to complete)
# 
# Indicatif utiliser pour se connecter aux REF ou relais UStrust
# Must imperatively be register on UStrust (usually the sysop call-sign)
# Must be in uppercase
# Example: LOGIN_CALL=XX0YYY
#

## ONLY_ADMIN_LOGIN ##
#
# Can limit the access to your gateway by DNGL and Hot-Spot 
#
# Two posibilities
# N = no restriction on connection (default value)
# Y = only call-signs defined in the ADMIN values can connect ypur gateway (DNGL or Hot-Spot)
# Example: ONLY_ADMIN_LOGIN=N
#

## ADMIN (must to complete) ##
#
# Administrators call-signs 
# "Warning at least one of the values ??"ADMIN" must be completed and not having # sign in front whatever ONLY_ADMIN_LOGIN value status"
#
# Example: ADMIN=YY0YYY
#

## ONLY_ADMIN_EXEC ##
#
# If you want only the users defined on ADMIN_EXEC can execute the scripts
#
# Two posibilities
# N = no restriction to execute the scripts (default value)
# Y = Only the users defined on ADMIN_EXEC can execute the scripts
# Example: ONLY_ADMIN_EXEC=N
#

## ADMIN_EXEC (must to complete) ##
#
# Call-signs of authorized users to execute the scripts
# "Warning at least one of the values ??"ADMIN_EXEC" must be completed and not having # sign in front whatever ONLY_ADMIN_EXEC value status"
#
# Exemple: ADMIN_EXEC=YY0YYY
#

## ONLY_LINK_UNLINK ##
#
# Two posibilities
# N = no restriction to link or unlink your gateway (default value)
# Y = Only the users defined on LINK_UNLINK_USER can link or unlink your gateway 
# Example: ONLY_LINK_UNLINK=N
#

## LINK_UNLINK_USER (must to complete) ##
#
# Call-signs of authorized users to link or unlink your gateway
# "Warning at least one of the values ??"LINK_UNLINK_USER" must be completed and not having # sign in front whatever ONLY_LINK_UNLINK value status"
#
# Example: LINK_UNLINK_USER=YY0YYY
#

## OWNER (must to complete) ##
#
# Call-sign of your gateway (whitout module letter)
#
# Example: OWNER=YY0YYY
#

## RMT_XRF_REF_DCS_PORT_IP ##
# 
# IP for connecting the XRF/REF/DCS
# "Do not modified" Default value 0.0.0.0
#

## RMT_XRF_PORT ##
#
# Communication port for the XRF
# "Do not modified" Default value 30001
#

## RMT_REF_PORT ##
# Communication port for the REF
# "Do not modified" Default value 20001
#

## RMT_DCS_PORT
#
# Communication port for the DCS
# "Do not modified" Default value30051 
#

## MY_G2_LINK_IP ##
#
# G2_link IP to change only if g2_ircddb running on another pc
# In this case, set the IP address of the pc that running g2_link
# Default value 127.0.0.1
#

## MY_G2_LINK_PORT ##
#
# Communication port with g2_ircddb "Not modified"
# Default value 18997
#

## TO_G2_EXTERNAL_IP ##
#
# G2_link external IP "Not modified" If you enter a different value "g2_lh" no longer works
# Default value 0.0.0.0
#

## TO_G2_EXTERNAL_PORT ##  
#                             
# G2_link external port "Not modified"
# Default value 40000
#

## QSO_DETAILS ##                                                 
#
# Two posibilities
# N = Do NOT log g2_link QSO details (default value)
# Y = log g2_link QSO details (for debbuging)
# Example: QSO_DETAILS=N
#

## GWYS ##
#
# Location of the directory containing the repertory of gateways (gwys.txt) "Do not modified"
# Default value: GWYS=/root/g2_link/var/gwys.txt
#

## STATUS_FILE ##
#
# Location of the directory containing the link status and DNGL/Hot-Spot linked "Do not modified"
#
# Default value:
# STATUS_FILE=/tmp/RPT_STATUS.txt
#

## ANNOUNCE ##
#
# Vocal anouncement of link status
#
# Two posibilities
# N = Vocal anounce disabled (no message linked, unlinked ...)
# Y = Vocal anounce enabled (default value)
# Example: ANNOUNCE=Y
#

## TIMEOUT_ANNOUCE ##
#
# Abort delay for sending back the anounce (value in seconds)
# when you sending a command "I" or link/unlink                                  
# we push briefly on the PTT button and as soon as you release the button
# g2_link send the  announce corresponding to the command,
# but if you hold the PTT button longer than the value "TIMEOUT_ANNOUCE"
# g2_link not send the announcement to avoid any conflict of DV if the user has
# Forgot to put "CQCQCQ" in the radio "Ur"
#
# The value is in seconds "5" in the following example:
# TIMEOUT_ANNOUCE=5
# Default value: 5
#

## ANNOUCE_DIR ##
#
# Location of the directory containing the voices files 
# 
# Two posibilities
#
# Annouce in French 
# ANNOUNCE_DIR=/root/g2_link/sounds/fr
# 
# Annouce in English(US) (Default value)
# ANNOUNCE_DIR=/root/g2_link/sounds/us
#

## SCRIPTS_DIR ##
#
# Location of the directory containing the scripts (files exec_L.sh par ex.) "Do not modified"
# 
# Default value
# 
# SCRIPTS_DIR=/root/g2_link/scripts
#

## RPTR_ACK ##
#
# Sending back the gateway name and link status informations after the end of transmissions
# g2_link can send back "ACK" after get receive one transmission with the gateway name (whitout module letter)
# and the link status informations (linked to "gateway linked name) or unlinked).
# Nevertheless it is better not to activate the "ACK" and use the relay module "RPTR eg."
# The "ACK" g2 link does not indicate as a relay and does not send configuration information for your radio
# This is why you see RX instead of RPT? on your screen before the relay name
#
# The "ACK" from "RPTR" this signal as a relay and send the name of the relay and the module letter 
# He also sending configuration information to the radio, and automatically corrects the values RPT1, RPT2
# of radios, if the relay is not memorized or bad values ??are inputted.
#
# If you set "RPTR_ACK = Y" in "g2_link.cfg", you must define "RPTR_ACK = N" in "rptr.cfg" file
# or if you set "RPTR_ACK = N" in "g2_link.cfg", you must define "RPTR_ACK = Y" in "rptr.cfg" file
#
# Two posibilities
#
# N = No ACK (recommended default value)
# Y = Sending ACK
# Example:
# RPTR_ACK=N
#

## DELAY_BETWEEN ##
#
# Delay in milliseconds between data packets "Do not modified"
#
# Example:
# DELAY_BETWEEN=20
# Default value: 20
#
 
## MAX_DONGLES ##
#
# Maximum number of Hot-Spot or DNGL can connect to your gateway simultaneously
#
# Example:
# MAX_DONGLES=5
# Default value: 5
#
 
## DEFAULT_LINK A ##
#
# Automatic connection of module A of your gateway to the reflector or repeater defined on "DEFAULT_LINK_A" value
# 
# g2_link will connect the gateway "module A" at startup and after manual unlink or automatic unlink
# to the reflector or repeater defined on "DEFAULT_LINK_A" value
# 
# Example:
# DEFAULT_LINK_A=XRF333A
# Default value: "blank"
# 	                	                

## DEFAULT_LINK B ##
#
# Automatic connection of module B of your gateway to the reflector or repeater defined on "DEFAULT_LINK_B" value
# 
# g2_link will connect the gateway "module B" at startup and after manual unlink or automatic unlink
# to the reflector or repeater defined on "DEFAULT_LINK_B" value
# 
# Example:
# DEFAULT_LINK_B=XRF333A
# Default value: "blank"
# 

## DEFAULT_LINK C ##
#
# Automatic connection of module C of your gateway to the reflector or repeater defined on "DEFAULT_LINK_C" value
#
# g2_link will connect the gateway "module C" at startup and after manual unlink or automatic unlink
# to the reflector or repeater defined on "DEFAULT_LINK_C" value
# 
# Example:
# DEFAULT_LINK_C=XRF333A
# Default value: "blank"
# 	                	 

## CMD_L_TIMER_A ##
#
# Time before automatic link to the reflector or repeater defined in "DEFAULT_LINK_A" value
# automatic link occurs after a period defined in the "CMD_L_TIMER_A" value after manual or automatic unlink
#
# This timer allows you to send a "command connection" has another reflector or relay that defined in "DEFAULT_LINK_A"
# The countdown reset if you send "erroneous command" to leave again the time to send another command
#
# "The value is in seconds"
#
# Example:
# CMD_L_TIMER_A=60
# Default value: 60
#

## CMD_L_TIMER_B ##
#
# Time before automatic link to the reflector or repeater defined in "DEFAULT_LINK_B" value
# automatic link occurs after a period defined in the "CMD_L_TIMER_B" value after manual or automatic unlink
#
# This timer allows you to send a "command connection" has another reflector or relay that defined in "DEFAULT_LINK_B"
# The countdown reset if you send "erroneous command" to leave again the time to send another command
#
# "The value is in seconds"
#
# Example:
# CMD_L_TIMER_A=60
# Default value: 60
#

## CMD_L_TIMER_C ##
#
# Time before automatic link to the reflector or repeater defined in "DEFAULT_LINK_C" value
# automatic link occurs after a period defined in the "CMD_L_TIMER_C" value after manual or automatic unlink
# 
# This timer allows you to send a "command connection" has another reflector or relay that defined in "DEFAULT_LINK_C"
# The countdown reset if you send "erroneous command" to leave again the time to send another command
#
# "The value is in seconds"
#
# Example:
# CMD_L_TIMER_A=60
# Default value: 60
#

## RF_INACTIVITY_TIMER_A ##
#
# Delay of inactivity (no radio traffics on your side) after which, if the gateway "module A" is linked
# to another reflector or repeater as defined in the "DEFAULT_LINK_A" value will be automatically unlink 
#
# After automatic unlink "RF_INACTIVITY_TIMER_A" g2_link will link to the reflector or relay defined in the "DEFAULT_LINK_A" value
#
# "The value is in seconds"
#
# Example:
# RF_INACTIVITY_TIMER_A=300
# Default value: 300
#

## RF_INACTIVITY_TIMER_B ##
#
# Delay of inactivity (no radio traffics on your side) after which, if the gateway "module B" is linked
# to another reflector or repeater as defined in the "DEFAULT_LINK_B" value will be automatically unlink 
#
# After automatic unlink "RF_INACTIVITY_TIMER_B" g2_link will link to the reflector or relay defined in the "DEFAULT_LINK_B" value
#
# "The value is in seconds"
#
# Example:
# RF_INACTIVITY_TIMER_A=300
# Default value: 300
#

## RF_INACTIVITY_TIMER_C ##
#
# Delay of inactivity (no radio traffics on your side) after which, if the gateway "module C" is linked
# to another reflector or repeater as defined in the "DEFAULT_LINK_C" value will be automatically unlink 
#
# After automatic unlink "RF_INACTIVITY_TIMER_C" g2_link will link to the reflector or relay defined in the "DEFAULT_LINK_C" value
#
# "The value is in seconds"
#
# Example:
# RF_INACTIVITY_TIMER_A=300
# Default value: 300
#


###############################################################################


Radio commands (managed by g2_link)
======================================
#
- Command list acting on g2 link 
#

## Command "CQCQCQ" in the UR of your radio ##
#
# Command Format: the text CQCQCQ in the first 6 positions.
#
# Action: transmission is broadcast on local repeater and on linked gateways or DNGL/Hot-spot
#
# Activation: Push and hold the PTT button ...speak... 
#

## Command "I" (INFO) in the UR of your radio ##
#
# Command Format:  "I" Letter in uppercase only in 8th position
#
# Action: Voice information anounce of the connection status of your gateway and the name of the reflector or relay linked by textual information.
#
# Activation: A short press on the PTT button
#

## Command "U" (UNLINK) in the UR of your radio ##
# 
# Command Format: "U" Letter in uppercase only in 8th position
#
# Action: Unlink your "gateway" from the relay or reflector to which it is linked (Not unlink "repeaters" or "hot spot" that would linked to your gateway)
#
# Activation: A short press on the PTT button
#

## Command "L" (LINK) in the UR of your radio ##
#
# Command Format: Repeater name or reflector name from the first position followed by the module letter in 7th position and the letter L in 8th position eg. XRF333AL or HB9AR_BL
#
# Action: creates a permanent connection to another repeater or reflector.
#
# Activation: A short press on the PTT button
#

## Command "E" (ECHO-TEST) in the UR of your radio ##
#
# Command Format: "E" Letter in uppercase only in 8th position
#
# Action: Echo-test, g2_link records then you return your voice as soon as you release the PTT button, as long as you keep the command "E" in your UR.
#
# Activation: Push and hold the PTT button ...speak... 

## Command "F" (Reload CFG) ##
#
# Command Format: "F" Letter in uppercase only in 8th position
#
# Action: reloads the g2_link configuration "For example after the sending the command "LX "(update the gateways directory) must be sent the "F"command to load changes on g2_link
#
# Activation: A short press on the PTT button
#

## Command "X" (scripts launcher) ##
#
# Format: "X" Letter in uppercase in 7th position and the lettre (A to Z) corresponding to the script you want to execute 
# 
# Example: _ _ _ _ _ _ A X  in the UR of your radio
#        
# The scripts must be placed in this folder : /g2_link/scripts
# 
# Scripts must be named in the following example: exec_A.sh to exec_Z.sh
#                                                      
# After having created a new script, do not forget to add execute permission with the following command: root@voyage:~/g2_link/scripts# chmod +x exec_A.sh
#
# "Warning: the exec_L.sh script is already created , it serves to update the gateways directory"
# 
# Action: launch the script asks
#
# Activation: A short press on the PTT button
#


############### 73 ################

# README FILE 1.03 10.1.2013

# writed by HB9ESA based on the process of F1SMF