IRCDDB OPENDV Files

ÿþ################################################################################

#                                                                              #

#                            G2_IRCDDB+ - v.1.03    		                   #

#                            ===================         	                   #

#							                                                   #

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





Document Content

================



- License informations

- Descriptive 

- Installation on Voyage Linux 

- useful Commands 

- G2_IRCDDB configuration 

- Radio commands 



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



License informations

====================



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

#



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



Descriptive

============



## G2_IRCDDB+ is a modified version of G2_IRCDDB of KI4LKF

#

# G2_IRCDDB  manages traffic between different modules of this programs series  

# eg. g2_link, rptr or dv_rptr ...

# He also manages the connection with the IRCDDB network and DPRS functions 

# eg. Call-routing, the DPRS beacon of your gateway and radio users 

#

## This program uses the following ports:

#

# 

- Communication with G2_link or G2_link+

#

# UDP Port: 18997 

#

- DV transmission of IRCDDB

#

# UDP Port: 40000

# It is imperative to redirect this port on your router to the machine that executes g2_ircddb

# 

- Communication with IRC Server

#

# UDP Port: 9007

# It is imperative to redirect this port on your router to the machine that executes g2_ircddb

#

- Communication with APRS Server

#

# UDP Port: 14580

# It is imperative to redirect this port on your router to the machine that executes g2_ircddb

#

- communication from RPTR module

#

# UDP Port: 19000

# 

- communication to RPTR modules

#

# UDP Port: module A: 19998 

            module B: 19999 

            module C: 20000 





              

               -------------                        

               ¦DV IRCDDB  ¦ 

               ¦Port:40000 ¦

               -------------

   ------------     ¦       -------------         ------------

   ¦IRC Server¦     ¦       ¦APRS Server¦         ¦DV IRCDDB ¦

   ¦Port:9007 ¦     ¦       ¦Port:14580 ¦         ¦Port:40000¦

   ------------     ¦       -------------         ------------

              \     ¦       /                          ¦

            ------------------	                  ------------

            ¦		         ¦    Port: 18997     ¦	         ¦

            ¦   G2_IRCDDB+   ¦<------------------>¦ G2_link+ ¦

            ¦		         ¦	                  ¦	         ¦

            ¦  		         ¦	                  ¦	         ¦

            ------------------                    ------------

             ¦^     ¦^     ¦^                       /  ¦   \

             ¦¦     ¦¦     ¦¦                      /   ¦    \

             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_ircddb+

#

# **i386 Voyage 

# root@voyage:~# cd /root/dl_ircddb

# root@voyage:~/dl_ircddb# wget //sourceforge.net/projects/ircddbplus/files/gateway/linux/i386/g2_ircddb+/g2-ircddb-plus-v1.03-i386.zip

# root@voyage:~/dl_ircddb# unzip g2-ircddb-plus-v1.03-i386.zip -d /root/g2_ircddb

#

# **ARM Raspbian

# root@voyage:~# cd /root/dl_ircddb

# root@voyage:~/dl_ircddb# wget //sourceforge.net/projects/ircddbplus/files/gateway/linux/arm/g2_ircddb+/g2-ircddb-plus-v1.03-arm.zip

# root@voyage:~/dl_ircddb# unzip g2-ircddb-plus-v1.03-arm.zip -d /root/g2_ircddb

#



## Lunch the installation script ##

#

# root@voyage:~# cd g2_ircddb/scripts

# root@voyage:~/g2_ircddb/scripts# make install

#





## Configure proc_g2_ircddb_dtmfs.sh ##   

# 

# root@voyage:~/g2_ircddb# nano proc_g2_ircddb_dtmfs.sh 

#

# Complete the following values:

# 

# G2_INT_IP=0.0.0.0 (it is the IP of the pc executing g2_link if is the same pc leave 0.0.0.0)

#

# G2_INT_PORT=19000 (g2_link port does not change)

#

# G2= (Call-sign of your gateway, without module letter for example: OWNER=AB9CDE)

#

# Press Ctrl X then Y to save and close

# 



## Configure the g2_ircddb.cfg file ##

#

# Open the configuration file:

#

# root@voyage:~/g2_ircddb# nano g2_ircddb.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:

#

# OWNER="Call-sign of your gateway" (without module letter for example: OWNER=AB9CDE)

#

# IRC_PASS=(IRC server code, received after the registration of the call-sign of your gateway on www.ircddb.net)

#

# Once the values are completed remove the # sign at the beginning of the line, otherwise the program will not start

#

# Example:

#          #OWNER=       (inactive value)

#          OWNER=AB9CDE  (value properly completed and activated) 

# 

# You can find the complete list of possible adjustment on the section "G2_ircddb Configuration"

#

# Once the values are completed and configured, press Ctrl X then Y to save and close

#

# root@voyage:~/g2_ircddb# cd

#

# root@voyage:~/# 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_ircddb service ##

#

# root@voyage:~/# service g2_ircddb start    (start the service)

# root@voyage:~/# service g2_ircddb stop     (stop the service)

# root@voyage:~/# service g2_ircddb restart  (restart the service)

# 

 

## Start, Stop the proc_g2_ircddb_dtmfs service  (DTMFs commands)

#

# root@voyage:~/# service proc_g2_ircddb_dtmfs start    (start the service)

# root@voyage:~/# service proc_g2_ircddb_dtmfs stop     (stop the service)

# root@voyage:~/# service proc_g2_ircddb_dtmfs restart  (restart the service)

# 



## Enable or disable the automatic Start of g2_ircddb service ##

#

# root@voyage:~/# update-rc.d -f g2_ircddb defaults  (automatically start the service at boot time)

# root@voyage:~/# update-rc.d -f g2_ircddb remove    (Manual lunch)

#



## Enable or disable the automatic Start of proc_g2_ircddb_dtmfs service ##

#

# root@voyage:~/# update-rc.d -f proc_g2_ircddb_dtmfs service defaults  (automatically start the service at boot time)

# root@voyage:~/# update-rc.d -f proc_g2_ircddb_dtmfs service    (Manual lunch)

#



## Display the g2_ircddb log in real-time (Ctrl C for go-out) ##

#

# root@voyage:~/# tail -f /var/log/g2_ircddb

#



## Display the proc_g2_ircddb_dtmfs log in real-time (Ctrl C for go-out) ##

#

# root@voyage:~/# tail -f /var/log/proc_g2_ircddb_dtmfs

#



## Manual archiving the g2_ircddb log ##

#

# root@voyage:~/# logrotate -f  /etc/logrotate.conf

#



## For debugging the g2_ircddb log ##

#

# root@voyage:~/# logrotate -d /etc/logrotate.conf

#



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





G2_ircddb 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 ###



## OWNER (must to complete) ##

#

# Call-sign of your gateway (whitout module letter)

#

# Example: OWNER=YY0YYY

#



## PACKAGE_REV ##

#

# PACKAGE_REV value will show on the German IRC status site under the column PACKAGE_REV

# Use the name of your repeater software or anything else you like

# Separate the name from the version using the underscore

#

# PACKAGE_REV=rptr_320 (for example)

#



## SEND_APRS ##

#

# Two posibilities

# N= Not send yours repater gateways GPS position to APRS

# Y= Send yours repater gateways GPS position to APRS

#

# Example: SEND_APRS=N (default value)

#



## RPTR_ID_A ##

#

# This is the GPS position and APRS beacon of your module: A

# 

# For example:

# RPTR_ID_A=46.8495,06.6296,00,DSTAR ircddb.net

#

 

## RPTR_ID_B ##

#

# This is the GPS position and APRS beacon of your module: B

# 

# For example:

# RPTR_ID_B=46.8495,06.6296,00,DSTAR ircddb.net

#



## RPTR_ID_C ##

#

# This is the GPS position and APRS beacon of your module: C

# 

# For example:

# RPTR_ID_C=46.8495,06.6296,00,DSTAR ircddb.net

#



## LOCAL_IRC_IP ##

#

# Which local address on your Linux box will be used

# to report to the remote IRC database server(group2, group1,...)

# For most installations it is 0.0.0.0 (which binds to all local IP addresses)

# If you have more than one ethernet card, then you may set it to a specific local IP

# that is assigned to that specific ethernet card

# If you have one ethernet card, you can use 0.0.0.0

#

# LOCAL_IRC_IP=0.0.0.0 (default value)

#



## SEND_QRGS_MAPS ##

#

# Two posibilities

# N= Not send yours repater gateways GPS position and informations to IRCDDB live 

# Y= Send yours repater gateways GPS position and informations to IRCDDB live 

#

# Example: SEND_QRGS_MAPS=N (default value)

# 



## QTH ##

#

# This is the QTH informations sent to IRCDDB live:

#

# LATITUDE, LONGITUDE, description1, description2, url

#

# For example: QTH=46.8495,06.6296, Geneva,D-Star RPTR , www.ircddb.net

#



## QRG_A ##

#

# This is the QRG informations sent to IRCDDB live:

#

# Frequency, shift, range, antenna's height above ground(agl)

#

# For example: QRG_A=439.5125, 7.6, 40, 49

#



## QRG_B ##

#

# This is the QRG informations sent to IRCDDB live:

#

# Frequency, shift, range, antenna's height above ground(agl)

#

# For example: QRG_B=439.5125, 7.6, 40, 49

#



## QRG_C ##

#

# This is the QRG informations sent to IRCDDB live:

#

# Frequency, shift, range, antenna's height above ground(agl)

#

# For example: QRG_C=439.5125, 7.6, 40, 49

#



## APRS_HOST ##

#

# This is the DNS of the APRS server

#

# You should NOT change the value for APRS_HOST

# Leave it set to:  rotate.aprs.net

# The only time to change it is when you have your own APRS_HOST server

# or when you have a server that is closer to your QTH

#

# For example: APRS_HOST=rotate.aprs.net 

#



## APRS_PORT ##

#

# This is the port of the APRS server

#

# APRS_PORT=14580 (does not change)

#



## APRS_INTERVAL ##

#

# Intervals for sending the APRS beacon of the gateway (value in minutes, not to less than 40 minutes)

#

# For example: APRS_INTERVAL=40 (default value)

#



## APRS_FILTER ##

#

# Definition of the type of APRS informations retransmitted (refer you to the APRS standard filters)

#

# For example: APRS_FILTER=m/200 -p/CW (default value is empty)

#



## G2_EXTERNAL_IP ##

#

# This is the G2_link external IP "Not modified" 

# Default value 0.0.0.0

# 

# For example: G2_EXTERNAL_IP=0.0.0.0

#



## G2_EXTERNAL_PORT ##

#

# This is the G2_link external port "Not modified" 

# Default value 40000 

#

# For example: G2_EXTERNAL_PORT=40000

#



## G2_INTERNAL_IP ##

#

# This is the G2_link internal IP of this Gateway server

# Our local repeater modules will send data here "Not modified"

# Default value 0.0.0.0

# 

# For example: G2_INTERNAL_IP=0.0.0.0

#



## G2_INTERNAL_PORT ##

#

# This is the G2_link internal port of this Gateway server "Not modified"

# Default value 19000

#

# For example: G2_INTERNAL_PORT=19000

#



## TO_G2_LINK_IP ##

#

# This is the IP of the pc running g2_link change if g2_link is running in another pc

# Default value 127.0.0.1

#

# For example: TO_G2_LINK_IP=127.0.0.1

#



## TO_G2_LINK_PORT ##

#

# This is the communication port to g2_link "Not modified"

# Default value 18997

#

# For example: TO_G2_LINK_PORT=18997

#



## TO_RPTR_IP_A ##

#

# This is the IP of the pc running the module A of your repeater

# Default value 127.0.0.1

# 

# For example: TO_RPTR_IP_A=127.0.0.1

#



## TO_RPTR_PORT_A ##

#

# This is the communication port to the module A of your repeater

# Default value 19998

#

# For example: TO_RPTR_PORT_A=19998

#



## TO_RPTR_IP_B ##

#

# This is the IP of the pc running the module B of your repeater

# Default value 127.0.0.1

# 

# For example: TO_RPTR_IP_B=127.0.0.1

#



## TO_RPTR_PORT_B ##

#

# This is the communication port to the module B of your repeater

# Default value 19999

#

# For example: TO_RPTR_PORT_B=19999

#



## TO_RPTR_IP_C ##

#

# This is the IP of the pc running the module C of your repeater

# Default value 127.0.0.1

# 

# For example: TO_RPTR_IP_C=127.0.0.1

#



## TO_RPTR_PORT_C ##

#

# This is the communication port to the module C of your repeater

# Default value 20000

#

# For example: TO_RPTR_PORT_C=20000

#



## ECHOTEST_REC_TIMEOUT ##

#

# Echotest-recording timeout:

# If after 1 second, audio stops coming in for echotest-recording,

# we will stop recording for ECHOTEST

# Default value 1

# 

# For example: ECHOTEST_REC_TIMEOUT=1

#



## VOICEMAIL_REC_TIMEOUT ##

#

# # Voicemail-recording timeout:

# If after 1 second, audio stops coming in for voicemail-recording,

# we will stop recording for voicemail

# Default value 1

#

# For example: VOICEMAIL_REC_TIMEOUT=1

# 



## FROM_REMOTE_G2_TIMEOUT ##

#

# If after 2 seconds, we do not receive any more packets from remote system,

# we will assume that the remote QSO has stopped

# Default value 2

#

# For example: FROM_REMOTE_G2_TIMEOUT=2

#



## FROM_LOCAL_RPTR_TIMEOUT ##

#

# If after 1 second, we do not receive any more packets from

# our local repeater, we will assume that the local RF user has stopped talking

# Default value 1

#

# For example: FROM_LOCAL_RPTR_TIMEOUT=1

#



## QSO_DETAILS ##

#

# If you want log the qso details

#

# Two posibilities

# 

# Y= the QSOs details is loged 

# N= the QSOs details is not loged

#

# For example: QSO_DETAILS=Y (default value)

#



## IRC_DEBUG ##

#

# If you want log more details for IRC communication (using for debuging)

#

# Two posibilities

#

# Y= IRC details are loged

# N= IRC details are not loged 

#

# For example: IRC_DEBUG=N (default value)

#



## DTMF_DEBUG ##

#

# If you want log more details for DTMFs commands (using for debuging)

#

# Two posibilities

#

# Y= DTMFs details are loged

# N= DTMFs details are not loged

#

# For example: DTMF_DEBUG=N (default value)

#



## REGEN_HDR ##

#

# Do you want to re-generate the HEADER if there is a timeout from

# messages arriving from remote systems(reflectors, gateways, ...)

#

# Two posibilities

#

# Y= Header are re-genereated

# N= Header are not re-genereated

#

# For example: REGEN_HDR=Y (default value)

#



## DTMF_DIR ##

#

# This is the location of the temporary file for inbound DTMFs

# Default value /tmp

# 

# For example: DTMF_DIR=/tmp

#



## ECHOTEST_DIR ##

#

# This is the location of the temporary echo-test records

# Default value /tmp

#

# For example: ECHOTEST_DIR=/tmp

#



## PLAY_WAIT ##

#

# This is the delay before starting playback the echo-test records after releasing the PTT button

# Default value 2 (this value is in seconds)

#

# For example: PLAY_WAIT=2

#



## PLAY_DELAY ##

#

# This is the delay between data packets during playback of echo-test records

# Default value 18 (but you can put 20 it'ok)

# 

# For example: PLAY_DELAY=18

#



## IRC_DDB_HOST ##

#

# This is the DNS of the IRC Server

# 

# Two posibilities

#

# group2-irc.ircddb.net (For For US, Canada and North America)

# group1-irc.ircddb.net (For the German and EU)

#

# For example: IRC_DDB_HOST=group2-irc.ircddb.net (default value)

#



## IRC_DDB_PORT ##

#

# This is the IRC server port "Not modified"

# Default value 9007

#

# For example: IRC_DDB_PORT=9007

#



## IRC_PASS (must to complete)## 

#

# This is your ircDDB password given to you by the German ircDDB team

#

# For example: IRC_PASS=123ABC456DEF789GHI

#







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





Radio commands 

==============

#

- Voice mail commands

#



## Store new Voice mail ##

#

# Command Format: "S0" Letter and number in uppercase in 7th and 8th position

#

# Action: Create new voice mail

#

# Activation: Push and hold the PTT button ...speak...

#



## Read voice mail ##

#

# Command Format: "R0" Letter and number in uppercase in 7th and 8th position

#

# Action: Read voice mail

#

# Activation: A short press on the PTT button

#



## Delete voice mail ##

#

# Command Format: "C0" Letter and number in uppercase in 7th and 8th position

#

# Action: Delete voice mail

#

# Activation: A short press on the PTT button

#



#

- Echo-test

#

# Command Format: "E" Letter in uppercase only in 8th position

#

# Action: Echo-test, g2_ircddb 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... 

#



#

- Zone Routing

#

# Command Format: "/" slash sign in first position followed by the gateway call-sign

#

# Action: you are automatically redirected to the requested gateway, as long as you keep the command "/" followed by the gateway call-sign in your UR.

#

# Activation: Push and hold the PTT button ...speak... 

#

# Example: /HB9VD B (Slash sign in first position followed by the gateway call-sign and module letter in 8th position in your UR)

#



#

- Call-sign Routing

#

# Command Format: the station call-sign you want to call in your UR

#

# Action: you are automatically redirected to the last gateway where the requested station is reported, as long as you keep the station call-sign in your UR.

#

# Activation: Push and hold the PTT button ...speak...

#

# Example: F1SMF (just the station "OM" call-sign)

# 



#

- DTMF Command list 

#



## DTMF command "99" (INFO) ##

#

# Command Format: DTMF Tones 99

#

# Action: Voice information anounce of the connection status of your gateway and the name of the reflector or relay linked by textual information.

#

# Activation: send DTMFs 99

#



## DTMF command "73" (UNLINK) ##

# 

# Command Format: DTMF Tones 73

#

# 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: send DTMFs 73

#



## DTMF command "*" "#" and "D" (LINK) ##

#

# Command Format: Tone * for linking a REF. tone # for linking a XRF and tone D for linking a DCS

#

# Action: Establishes a connection to a REF, XRF or DCS.

#

# Activation: send DTMF by following examples

#

# *=REF #=XRF D=DCS followed by gateway number eg. 005 

# and the module letter represented by two digits eg. A=01 B=02 C=03...Z=26

#

# For example: to link the REF005B send the DTMFs tones *00502

#              to link the XRF333A send the DTMFs tones #33301

#              to link the DCS003C send the DTMFs tones D00303

#

#



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

# README FILE 1.03 18.01.2013

# writed by HB9ESA based on the process of F1SMF