|Version 1 (modified by sm0svx, 5 years ago)|
SvxLink Server user documentation
This part of the documentation describes how to use the SvxLink Server via the radio interface. SvxLink is controlled by DTMF (Dual Tone Multi Frequency) signalling. All commands to the system ends with the number sign (#). It's like the enter key on a computer. However, the sysop have an option to configure the system to execute commands on squelch close so that the number sign is not needed.
There also is an "anti-flutter" mode of operation. This mode of operation make DTMF detection perform well when the signal is weak or there is mobile flutter present. This mode is activated on a per command basis. To activate, start each command with an "A" (think: Activate Anti-flutter). Enter the digits, replacing duplicate digits with a "B" (11=1B, 111=1B1, 1111=1B1B etc). End with a "C" (think: Conclude). Some examples below.
AC <-- Empty command. Same as just pressing #. A1C <-- Command executed: 1 A12B3C <-- Command executed: 1223 A12B23C <-- Command executed: 12223
So what good is this? Well, this way of coding commands will allow digits to be "double detected" without affecting the end result, which can happen if there is mobile flutter present on the received signal. Consider the examples below.
ACCC <-- Empty command. Same as just pressing #. A111C <-- Command executed: 1 A11122BB3CC <-- Command executed: 1223 AA12B2233C <-- Command executed: 12223
Exactly the same result as the first example, even though some digits were detected multiple times.
There is a command timeout of 10 seconds. If no DTMF characters has been received for 10 seconds, the reception buffer will be cleared.
The star key (*) is special. It triggers the node to identify itself. However, identification is only performed if the star is entered as the only DTMF character. If digits are received, before or after, it will be considered to be part of a command.
The "D" key is used to activate a pre programmed macro or short cut. A macro is used to reduce the number of DTMF codes that have to be sent. For example if the macro 5 have been defined to connect to the *ECHOTEST* node only D5# have to be pressed instead of 2#9999#. It is the node sysop that defines the macros. Check with your local node sysop which macros are setup. If you connect to an EchoLink node very often it can be nice to setup a macro for it. Ask your sysop to do that.
The system is built up of a core system that handles the transceiver interface. The core system can then be extended by loading modules that handles a specific voice service. Each module have a unique ID number associated with it. The association is done during the configuration of the system. To activate a module, press its ID number followed by the number sign. The default configuration specifies the Help module as ID 0, so start by activating that module and listen to the help messages (i.e. send 0# or A0C). Go on to test the other modules. When a module is activated, send the 0# command to get help about that module. To exit a module, just send a # (or AC). Description in more detail for the different modules follow below.
The Help Module
The Help module is used to get help about the system as a whole and also help about each specific module. Send the ID number of the module to get help about. As always, end each command with the number sign.
The Parrot Module
The Parrot module plays back everything you say. This can be used as a simplex repeater or just to hear how you sound to the other stations. It also tells you the DTMF digits you press. As always, end all DTMF strings with the number sign. Exit the module by sending just the number sign.
The EchoLink Module
The EchoLink module is used to connect to other EchoLink stations. To connect to another station, just enter the node number ended with a #. To disconnect, press #. To exit the module, press # when not connected.
There are a couple of subcommands that can be used when the EchoLink module has been activated.
- 0 - Play the help message
- 1 - List all connected stations
- 2 - Play local EchoLink node id
- 31 - Connect to a random link or repeater
- 32 - Connect to a random conference
- 4 - Reconnect to the last disconnected station
- 50 - Deactivate listen only mode
- 51 - Activate listen only mode
The "connect by callsign" function will make it possible to connect to a station even if the node number is unknown. Callsigns are mapped to digits by using the following method: ABC=2, DEF=3, GHI=4, JKL=5, MNO=6, PQRS=7, TUV=8, WXYZ=9. The same mapping as on many phones. Letters are mapped to its corresponding digit and digits are of course mapped to their corresponding number. All other characters are mapped to digit 1. A search command start with * and then the callsign code is entered. So if you want to connect to SM0SVX-L you should enter "*76078915#". Since the codes are not unique a list of search hits will be presented to the user to choose from. If the entered code ends with *, a wildcard search will be performed. So if you want to search for all stations starting with SM0 you enter "*760*#".
The TclVoiceMail Module
This module implements a simple voice mail system to be used by the local node users. It is not possible (yet) to send voice mails to users at other nodes. To be able to use the voice mail module you must have a personal login ID and password. Contact your sysop to get these.
When the module is activated (default 3#) you will be prompted to enter your login ID and password. The login ID always is three digits long. The password can be between one to seven digits long. Enter your login ID and password in one sequence like 123456# if your login ID is 123 and your password is 456#. After that, context menus will guide you through using the system. An empty command (#) will abort the current operation.
To start recording a voice mail command 2# is used. The system will then ask you for a recepient. You can combine these two steps by entering the user ID directly after the command. For example if you want to record a voice mail for user 123, send the sequence 2123#.
The recommended way of encoding user IDs is the "phone method". Many phones have letters on the key pad like: 2=ABC, 3=DEF, 4=GHI, 5=JKL, 6=MNO, 7=PQRS, 8=TUV, 9=WXYZ. To encode the callsign SM0SVX, use the three last letters and map them to digits. Then we will get the user ID 789. In case of a collision, add 1. For example AFC and ADB will both map to 232. One possible mapping is then AFC=232 and ADB=233. When using this method to encode user IDs, it will be possible for a user to guess another user's user ID.
It is possible for the sysop to configure an e-mail address for each user. If this has been done, an e-mail will be sent to the user if someone records a new voice mail for him.
To deactivate the module, just press # when the main menu is active.
The DtmfRepeater Module
This module will retransmit all received DTMF digits when active. All received digits will be completely ignored by the SvxLink core. To deactivate the module, press # for at least three seconds.
This module is typically used on a SvxLink repeater to remote control other services via the repeater. The DTMF muting should be enabled so that received DTMF digits are not normally heard on the repeater.