UG0119 V 3 Fware
UG0119 V 3 Fware
UG0119 V 3 Fware
VoIP Telephones
Configuration Guide:
Firmware version 3
(The previous versions of this manual, for firmware versions 1 & 2, remain available)
VoIP Telephones
Configuration Guide
Firmware version 3
CONFIDENTIAL
The contents of this publication are confidential, are the property of GAI-Tronics, and may not
be reproduced, wholly or in part, without their written permission.
Windows is a trademark of Microsoft Corporation, registered in the United States and other
countries.
All other product and brand names are trademarks of their respective owners.
Software licences and notices are available on the GAI-Tronics website at www.gai-
tronics.co.uk/voipsupport.htm
POLICY
The policy of GAI-Tronics is one of continual development and improvement of products and
we reserve the right therefore to alter specifications without notice.
GAI-Tronics
Brunel Drive
Stretton Park
BURTON-UPON-TRENT
Staffordshire
England
DE13 0BZ
Contents
1. Introduction ................................................................................................................... 5
2. What's new ? ................................................................................................................ 6
2.1 New in Version 3.1.0 .................................................................................................... 6
2.2 New in Version 3........................................................................................................... 6
2.3 New in Version 2........................................................................................................... 6
3. How the product is intended to work ............................................................................ 8
3.1 Operating Sequence..................................................................................................... 8
3.2 Dictionary of terms........................................................................................................ 8
4. Setting up and Configuring the Telephones. .............................................................. 11
4.1 Quick Start .................................................................................................................. 11
4.2 Frequently Asked Questions (FAQs).......................................................................... 12
4.2.1 What network facilities do I need to provide? .................................................... 12
4.2.2 How do I set up dialling and memory lists? ....................................................... 12
4.2.3 Can I set the phone to make calls without a proxy (ie peer-to-peer)?............... 13
4.2.4 How do I set up Real-time alarm reporting via email or syslog? ....................... 13
4.2.5 How can I set up an external beacon to flash when the phone is ringing? ....... 14
4.2.6 How do I set up a door-entry system? ............................................................... 15
4.2.7 How can I use the phone to make paging or PA announcements? .................. 16
5. Web pages in detail .................................................................................................... 16
5.1 Login ........................................................................................................................... 17
5.2 Home Page................................................................................................................. 18
5.3 IP settings ................................................................................................................... 19
5.3.1 Note about Syslog:............................................................................................. 20
5.4 SIP settings................................................................................................................. 21
5.4.1 SIP Info sub-pages: ........................................................................................... 23
5.5 Unit settings ................................................................................................................ 24
5.5.1 Audio Path Test ................................................................................................. 26
5.6 Access settings........................................................................................................... 27
5.7 Serial settings ............................................................................................................. 28
5.8 Email settings ............................................................................................................. 29
5.9 Clock settings ............................................................................................................. 30
5.10 Dialling & Memories ............................................................................................... 31
5.10.1 Memories sub-page ........................................................................................... 32
5.10.2 Memory Lists sub-page...................................................................................... 33
5.10.3 Basic Info sub-page. .......................................................................................... 34
5.11 Key mapping .......................................................................................................... 35
5.11.1 Activating relays using DTMF codes ................................................................. 37
5.12 Current status......................................................................................................... 38
5.13 Audio settings......................................................................................................... 39
5.14 Alarm settings......................................................................................................... 41
5.15 Tone settings.......................................................................................................... 44
5.15.1 Suggested Tone Settings for Various Countries: .............................................. 46
5.16 LED settings ........................................................................................................... 47
5.17 Logic settings ......................................................................................................... 50
5.18 Multicast settings.................................................................................................... 52
6. Configuration File update ........................................................................................... 55
6.1 Configuration File Syntax ........................................................................................... 57
6.2 Configuration File Commands .................................................................................... 58
7. Time Zone Table......................................................................................................... 68
8. Example Configuration File ........................................................................................ 70
9. Command Line Interface ............................................................................................ 79
9.1 CLI Syntax .................................................................................................................. 80
9.2 ACCESS Module Command Line Syntax .................................................................. 81
9.3 ALARMS Module Command Line Syntax .................................................................. 82
9.4 KEY Module Command Line Syntax .......................................................................... 83
9.5 LED Module Command Line Syntax .......................................................................... 83
9.6 DIALPLAN Module Command Line Syntax................................................................ 84
9.7 CLOCK Module Command Line Syntax..................................................................... 85
9.8 AUDIO Module Command Line Syntax...................................................................... 86
1. Introduction
This guide provides information on the operation and configuration of GAI-Tronics' range of
rugged VoIP telephones with firmware version 3, released in May 2014.
There are significant changes to some of the web pages and commands from those in
previous versions. Issue 1, 2 & 3 of this manual will remain available on the GAI-Tronics UK
website (www.gai-tronics.co.uk/voipsupport.htm) as a reference for earlier versions.
The firmware version of each unit is displayed at the bottom of its home web page, and as
part of the welcome message following login via a Telnet or serial connection.
In each case the firmware version is a series of 3 numbers separated by dots (periods). The
main firmware version is the first number. For example:
1.2.13 indicates firmware version 1.
2.1.6 indicates firmware version 2.
3.0.0 indicates firmware version 3.
Upgrading to the latest version is possible in most circumstances, but please note that certain
new features may not be enabled on upgraded phones - contact GAI-Tronics for details.
GAI-Tronics VoIP telephones are available in a variety of model styles, including handset and
hands-free models, but the programming and configuration methods are common to all.
Please note that the features may depend on the model type, and that therefore this guide
may describe features not available on the particular model being configured.
Features of the GAI-Tronics range of VoIP telephones include:
SIP compatible (RFC3261) only
Registration with multiple SIP proxies (new in v2)
Configurable via web pages, serial link or downloading a configuration file
Outgoing cascading call lists
Real-time alarm reporting via email or Syslog
4 auxiliary inputs, 2 volt-free contact outputs (revised in v2)
Remote operation of contacts ("door opening" function)
3 “autoanswer” modes, including paging mode (revised in v2)
Multicast
2. What's new ?
Inbound Call
Relay/LED activation may now be achieved upon an inbound call. This feature may be
enabled by setting the “INBCALL” keyword for the required LED or Relay. See Section 5.16
and Section 5.17.
Multicast
(Only applicable to hands-free products). Multicast allows a single audio stream to be
received by multiple endpoints simultaneously, to achieve multi-point paging or Public
Address functionality over IP. (Requires a multicast compliant SIP server). 8 definable
multicast address ranges, with individual priority levels, for zoning. Assignable relay outputs
and splash tones. See section 5.18.
The unit can be set to automatically refresh its registration at a predetermined interval to
ensure that registration is maintained at all times (or if not raise an alarm).
This provides a high degree of resilience across the network and reduces the possibility of a
single point of failure jeopardising the operation of the whole system.
Page Mode
Auto-answer mode 3 is now explicitly referred to as PAGE MODE to highlight its potential use
as a PA or paging system. Functionally it is unchanged, except for the LED and relay triggers
described above.
Tones played to the user to indicate that dialling is in progress, by imitating DTMF tones used
by analog telephones.
Dial tone
A tone played to the user to indicate that the telephone is ready to dial – ie it is off hook and
waiting for a button to be pressed to initiate a call.
Dialling
Used to describe the process of initiating a call, usually by pressing a memory button or a
series of digit buttons.
DTMF
Standing for “dual tone multi-frequency”, the dialling digit tones produced by a touch-tone
phone. Commonly used for signalling in analogue systems.
Handset phone
Used to denote a telephone from the GAI-Tronics Titan or Commander product ranges, with a
separate handset attached to the main telephone body by a heavy duty flexible cord. No
separate loudspeaker is fitted to these models.
Hands-Free phone
Used to denote a telephone from the GAI-Tronics Help Point or Vandal Resistant product
ranges, with a microphone and speaker integrated into a flat panel. No corded handset is
fitted to these models.
LNR
Standing for “last number redial”, this is a button provided on some models of GAI-Tronics
phone to redial the last manually dialled number.
Memory dial number
On an analogue or cellular phone, memory numbers are pre-stored digit sequences used to
start calls. With VoIP these can also be URI’s rather than numbers, but are still referred to in
the same way.
Mute
A function to temporarily mute the microphone so that the remote party cannot hear. On GAI-
Tronics telephones this function is provided by the "S" button.
NU tone
Number unobtainable tone – used to indicate that a call cannot connect due to the end point
not being recognised.
Off hook
Used to denote the state of a telephone during an active call, or when a call has been
initiated. For a handset phone, off hook usually means that the handset is lifted.
On hook
Used to denote a telephone in the idle state – no call started or answered. A telephone is still
on hook when it is ringing on an incoming call. For a handset phone, on hook usually means
the handset is not lifted. If a call is terminated whilst the handset is still lifted (for example by
the CALL LIMIT timer), the telephone is placed into the on hook state. For a hands-free
phone, on hook means that no ON or WAKE & DIAL button has been pressed following a
terminated call or reset.
Recall
On analogue phones, the Recall button is used to activate exchange signal, usually to
transfer a call. The GAI-Tronics VoIP telephone does not have a recall facility, but the “R”
button (where fitted) can be used to activate an output on a remote phone, for example as a
door release.
Ring tone
A tone played to the user initiating a call to indicate that the call has been placed but not yet
answered. This usually signifies that the remote end is ringing.
Ringing
A loud alert tone made by the telephone indicating that an incoming call is ready to be
answered.
Secrecy (mute)
A function to temporarily mute the microphone so that the remote party cannot hear. On GAI-
Tronics telephones this function is provided by the "S" button.
Sidetone
On handset phones, part of the microphone signal is fed to the earpiece so that the user can
hear his or her own voice during the call. This makes it a more natural experience, and has
been a feature of analogue telephones since their invention. Not used on hands-free phones.
Note:
All the above access methods require you to know the unit's username and password.
All methods, except direct serial link, also require you to know the unit's IP address.
Please ensure these details are recorded securely once set or changed.
All of the telephone's features can be configured using any of the above methods, but the
most complete description of features is contained in the web page section (Section 5).
IMPORTANT: Before enabling DHCP mode, ensure that you have a means by which to
discover the IP address of the telephone allocated by the DHCP server. There is no other way
to access a DHCP mode VoIP telephone over the network without a DHCP server to provide
an IP address.
IMPORTANT: After changing the IP address of the telephone you will need to browse to the
new IP address to access the configuration, instead of the default 192.168.1.2.
With these basic steps the telephone will be able to make and receive calls in most cases.
Check the Current Status page to help diagnose problems - this will show whether or not the
phone is registered and what is happening during calls (refresh the page to see changes).
NOTE:
Make sure each unit is given at least a basic configuration before installing it. All units have
identical settings as factory defaults, so each one must be individually configured to give it a
unique identity on the network. This may be difficult to do after the units are installed.
1
Early models will only accept 48Vdc as an external power supply, later models will accept
24-48Vdc. Units are marked accordingly next to the power terminals - see installation guide
502-20-0115-001 (or 502-20-0133-001 for Auteldac4 VoIP) for details.
2
For Auteldac4 VoIP, PoE can only be supplied on the spare pair (802.3af alternative B) not
the data pairs. See installation guide 502-20-0133-001 for details.
Note that comfort strings have been set to give the user confidence that "dialling" is taking
place when the button is pressed.
Then set up 2 memory lists, one for each button:
Memory list 1 relates to memory button 1, and will dial memories 2, 3 and 4 in cascade.
Memory list 2 is for memory button 2, and will dial memory 1 only.
Note that, in this case, WAKEANDDIAL is set for both - the normal case for help point and
hands-free telephones.
Refer to the Dialling & Memories pages in section 5.10 for more details.
4.2.3 Can I set the phone to make calls without a proxy (ie peer-to-
peer)?
There are two ways of setting the phone to make peer to peer calls.
The first is where there is no proxy server on the system at all. In this case:
1. Set the ENDPOINT field on SIP 1 Info page to ENABLED, but make sure DOMAIN,
PROXY and REGISTRAR are blank. Set ENDPOINT on SIP info 2, 3 and 4 to
DISABLED.
2. Make each entry on the Memories page the address of an endpoint or phone, in the
form [email protected]. Note that the number before the "@" symbol is not normally
significant3 - there just needs to be a number, followed by "@", followed by the IP
address of the end point.4
3. Note that peer-to-peer calls can only be made by using a memory - not by manually
dialling from a numeric keypad. All phones have at least one memory list (the
OFFHOOK list). Refer to section 5.10 for details on setting up memories.
The second way is where one or more proxy servers are in use, but you want to be able to
make a peer-to-peer call if no proxy is available. This is referred to as "failover to peer-to-
peer". In this case:
1. Set the proxy address on one of the 4 SIP info pages (usually the one with the lowest
priority) to be the IP address of an endpoint, in the form 192.168.1.2, but set the
REGISTRAR address to be blank.
2. If all attempts to make calls to higher priority proxies fail, the phone will attempt to
place a call to this IP address as a peer-to-peer entity, regardless of what number is
dialled or what entry is selected from a memory list.
3
Some SIP phones may require this to be their phone number.
4
Note, this could also be a FQDN (fully qualified domain name) if there is a DNS available on
the network
In the example shown below, a syslog message will be generated if the telephone has a cold
reset (ie recovers from a power failure) or has an integrity loop fault (ie the handset has been
detached). In addition, it will send an email to the security office if the handset is detached.
4.2.5 How can I set up an external beacon to flash when the phone is
ringing?
Traditional telephone beacons and sounders, with ring detectors, will not work on VoIP
because there is no ring signal. You will therefore need a powered beacon or sounder
instead, and use the telephone's volt-free contacts to activate it. These beacons or sounders
must be provided with a separate power supply - they cannot be powered from the telephone.
Having connected an external device to an output (say Output 1), the next step is to set the
output to activate it when required.
Enter the keyword "RING" for the relevant output. The example above shows the output set
with a cadence of 10:0, meaning continuously on. This would be suitable for a beacon,
because beacons usually flash (once per second) when permanently energised. It might not
suit a sounder, however, because it would emit a continuous tone, which might not be
recognisable as a phone ringing. For a sounder on its own, the keyword "RINGCADENCE" is
a better option, causing the sounder to be energised in time with the normal phone ringer.
For a beacon and sounder together, it is often best to use a separate output for each as
shown:
In this example, Output 1 is set to activate a flashing beacon, whilst Output 2 is set to activate
a sounder in sync with the cadence of the ring signal (set on the Tone settings page). In both
cases the outputs are energised when the phone is ringing with an incoming call, and de-
energised when the call is answered or disconnected.
Refer to the Logic Settings page (section 5.17) and Tone settings page (section 5.15) for
more details.
To achieve this, connect one of the volt-free outputs on the hands-free telephone (say output
1) to the electronic door release mechanism. Using the Logic settings page, set this output to
PULSE:
Note that the TIMER is set to 3, meaning that the output will remain active for 3 seconds after
being activated. Next, Under Key mapping, set RELAY1PULSECODE to a string of digits that
can be dialled from the Handset unit (see 5.11.1 Activating relays using DTMF codes).
To activate this output from the security office during a call, simply dial the string of digits. So,
for example, if RELAY1PULSECODE were configured to “1234” then the digits to be dialled at
the handset would be “1234”.
Note that each unit must be using a matching DTMF mode (i.e. IN-BAND or RFC 2833). See
5.13 Audio settings.
Refer to the Logic settings page (section 5.17) and the Key mapping page (section 5.11) for
more details.
To control the Display Name of a calling GAI-tronics VoIP telephone, set the ANI field to the
desired value. See 5.5 Unit settings for further details.
Alternatively, configure the Default Answer Mode of the receiving GAI-tronics VoIP telephone
to “PAGE”. This will cause the unit to answer calls in Page Mode by default.
Note page mode is usually implemented using handsfree models (VR and Help Point for
example) but it may also be possible with other models, depending on application. The
integral relays can also be set to activate during a page, and this feature could be used to
trigger an external public address amplifier. Contact GAI-Tronics for details.
Edit button
Navigation
pane Page values
The left hand navigation pane gives direct access to each of the 16 main pages, grouped by
functional headings of Network, Phone functions and Signals & Audio, plus the home page.
Most pages have an "Edit" button that allows the changing of parameters.
Some pages have entry dialog boxes that accept certain predefined values. These values
are listed in the sections below.
Some pages have links to related sub pages.
Each page displays its module name near the top for ease of navigation.
Note that these pages have been developed and tested on Microsoft Internet Explorer (v6).
Screen layout may appear differently using other browsers.
5.1 Login
To access the web pages, navigate to the unit's IP address using a web browser such as
Internet Explorer.
The factory default setting is for static IP addressing, with an address of:
192.168.1.2
Note that the unit's default subnet mask is 255.255.0.0.
The Phone will request a user name and password as shown.
At the bottom of the home page (you may need to scroll down, depending on screen
resolution) there is a list of information about the phone including serial numbers of the unit
and its PCBs, software versions and MAC ID.
5.3 IP settings
The IP settings page is used to display or change various settings for connection to the IP
network.
DHCP: Enables or disables the use of DHCP for the assignment of IP parameters. If this
value is set to OFF the telephone will use the Static IP values. (Values available: ON or OFF,
default value is OFF)
ADDRESS: Sets the static IP Address of the unit. (Default value is 192.168.1.2) Do not enter
a value here if DHCP is set to ON.
MASK: Sets the static sub-net mask. (Default value is 255.255.0.0) Do not enter a value here
if DHCP is set to ON.
GATEWAY: Sets the static default gateway address (Default value is 0.0.0.0). If using
Multicast, this must be valid non-zero value.
DNS1: Sets the IP address of the primary static DNS server. If DHCP is enabled then this
DNS server will not be used. (Default value is 0.0.0.0 )
DNS2: Sets the IP address of the secondary static DNS server for redundancy. If DHCP is
enabled then this DNS server will not be used. (Default value is 0.0.0.0 )
LOCALDOMAIN: Sets the domain name of the telephone on the network, as used by DNS.
May be assigned by DHCP.
WEB: Enables or disables access to the web server (Values available: ON or OFF, default
value is ON)
WEBPORT: Sets the TCP port through which the Telephone Web server can be accessed
(Default Value is 80)
TELNET: Enables or disables access to the telnet server (Values available: ON or OFF,
default value is ON)
TELNETPORT: Sets the TCP port through which the Telephones telnet server can be
accessed (Default Value is 23)
SYSLOG: Sets the destination address for syslog server messages. (Valid values: IP
address or FQDN. Default value: blank)
SYSLOGPORT: Sets the port number to be used for syslog messages. The default value is
514
SYSLOG2: Sets the destination address for a second syslog server for redundancy. (Valid
values: IP address or FQDN. Default value: blank)
SYSLOGPORT2: Sets the port number to be used for syslog messages (second syslog
server). The default value is 514
SYSLOGFACILITY: Sets the SYSLOG message facility level, as per RFC3164. (Default
value: 14)
SYSLOGSEVERITY: Sets the SYSLOG message severity level, as per RFC3164. (Default
value: 5)
STUN: Sets the IP address or URL for the STUN server that will be used to resolve STUN
requests. Leaving this field blank will disable the STUN facility. (Default value: blank)
At the bottom of the IP settings page are 2 action buttons, each with an entry box. The entry
boxes will accept either an IP address or FQDN. These buttons provide useful diagnostic
functions:
PING: Sends an ICMP ping to the entered address, providing a results page.
TRACEROUTE: Executes a series of PING messages with varying HOP numbers in order to
determine the routing used to reach the destination address. A results page is displayed.
Note that making changes to the IP section may take up to 45 seconds during which time you
will not be able to access the web page.
LOCALPORT: Configures the port number used for the local SIP signalling socket.
Default value: 5060
PROXYFAILOVERSTATUSES: This field contains a list of SIP error codes that will trigger a
fail over from one proxy to the next. Codes are 3 digits and the wildcard character “x” can be
used (ie 5xx would include any code from 500 to 599 inclusive). Codes are separated by
commas. Maximum field length 79 characters, ie 20 codes. The default list is 5xx, 6xx, 49x,
403, 406, 9xx. Codes are as defined in RFC3261 except 9xx, which is defined as "time-out"
and should always be included in the list.
Note that there are two failover mechanisms: one for proxies (defined here) and a second for
memories (defined in section 5.10.3). If a call fails due to a proxy error, the phone will then try
to place the call to the same number on the next proxy. If the call fails due to an endpoint
problem (for example "busy"), the phone will try the next number in the list, on the current
proxy.
DONTSTARTMEDIAATRING: This setting is not normally required. It can be used to delay
the sending of media packets to end points until the call has been answered. Only required if
problems are encountered with certain types of end point. Default value: OFF.
SENDDTMFLAST: This setting is not normally required. It can be used to reorder the codec
sequence to end points, so that the DTMF codec is sent last. Only required if problems are
encountered with certain types of end point. Default value: OFF
RTPTOS: Sets the value of the TOS/Diffserv field in the UDP packets carrying RTP data. This
value prioritises traffic over the network to provide QoS (Quality of Service) for voice, see
RFC2474. Valid values are 1->63 (Default value = 46)
SINGLEPTIME: Certain endpoints can only accept a single audio packet time regardless of
CODEC (see AUDIO page). This field forces a single packet time to the value set in ms.
Valid values are 0 to 100, where 0 disables the feature allowing codecs to use the packet
times set on the AUDIO page. Default value 0.
SENDMULTIPARTMIME: This option is for future enhancement and should always be set to
‘OFF’. Default value OFF.
NEWBRANCHONAUTHBYE: This is a legacy option that is no longer used, and must always
be set to 'ON'. Default value 'ON'.
HANGUPONREGFAILURE: Enable (set to ‘ON’) to force the VoIP Telephone to go on hook if
registration fails with the current SIP exchange. The VoIP Telephone will not go on hook if
registration is dropped due to a higher priority registrar becoming available on the network.
The current SIP exchange is defined as the exchange that the VoIP Telephone was
registered with at the time of the call. This is usually used to disengage a call in progress if
the VoIP PBX loses connectivity. Disable (set to ‘OFF’) to allow calls to continue when
registration has failed with the current SIP exchange. This feature only applies to SERIAL
registration mode. Default value 'OFF'.
RELAXCANCELMATCH: Enable (set to ‘ON’) to allow received mismatched CANCEL
messages to close down calls. This is usually used if experiencing issues with call tear-down.
Disable (set to ‘OFF) to use proper CANCEL matching rules (SIP RFC 3261). Default value
'OFF'.
MODE: This field sets whether multiple proxies and registrars are used serially or
concurrently. If set to SERIAL the phone will attempt to register with the next priority registrar
if registration with the current one fails. If set to MULTIPLE it will attempt to maintain
registration with all enabled registrars, and will use the priority sequence for outbound call
failover. Default value: SERIAL. When only a single proxy / registrar is enabled, set this
value to SERIAL to ensure any registration failure is detected quickly.
REGTIMEOUT: Sets the Registration timeout value (in seconds) that will be suggested by the
telephone to a Registrar. Following the expiry of this timeout, the telephone will be
deregistered and then automatically attempt to re-register. (Value range: 0 to 232 -1, default
value: 3600) The registration server can ignore or override this suggested time.
REREGTIMEOUT: Sets a period in seconds after which the phone will force a re-registration
period and the server cannot override it. Disabled if set to zero. Default value 0. This field
can be used to ensure that registration is maintained for this particular phone, regardless of
the general settings on the registration server. For example, if this were an emergency
phone, setting this field to 30 would force re-registration every 30 seconds even if the server
normally only refreshes registration once an hour. In this way, if the proxy server fails or
becomes unavailable, the phone can detect it quickly and either attempt to register with the
next server in the priority list (if MODE is set to SERIAL) or direct calls to the next priority
server (if MODE is set to MULTIPLE).
Note that, if the current registrar becomes unavailable, the telephone may not be able to
make a call until it re-registers with the next.
Each of the 4 sub pages is identical, and is used to set parameters for each of 4 possible
proxies.
LOCALID & DOMAIN: together these set the URI (uniform resource identifier) of the phone.
In the example shown above the URI would be sip:[email protected].
These values are used in the To:, From: and Contact: headers, and also in the registration
process with a registrar.
They will accept any alphanumeric string and their default values are both blank.
PROXY: Sets the IP address or the FQDN of the SIP proxy server to be used for
incoming/outgoing calls. Default value: blank
PROXYPORT: Sets the port number on the proxy used for SIP protocol signalling.
Default value: 5060
PRIORITY: Sets the failover sequence between the 4 pages.
REGISTRAR: Sets the address of the Registrar, either as an IP address or FQDN. The
registrar address and the proxy may or may not be the same, but the address for registration
must be set here. Default value: blank
REGISTRARPORT: Sets the port number to send the requests to. Is 5060 by default or if
unspecified.
USERNAME: Sets the username for the registrar authorisation realm. (Default value: blank)
PASSWORD: Sets the password for the registrar authorisation realm. (Default value: blank)
ENDPOINT: Sets whether the subpage is ENABLED or DISABLED. (Default value:
ENABLED for SIP1, all others DISABLED).
Note that the Proxy address could also be that of a peer-to-peer entity, allowing the unit to
make a direct peer-to-peer to connection. This can provide an extra level of resilience,
allowing the unit to fall back to a peer to peer call in the event that all proxy servers become
unavailable.
HOSTNAME: Sets the unit host name. Maximum 15 alphanumeric characters (a-z, A-Z , 0-9).
Default Value is a unique string starting with "GT" and followed by the serial number of the
main circuit board inside the phone (referred to as the "Board serial" on the home page). The
host name identifies the unit on the network, and is also used in email and syslog messages
to identify the source of the message. If using DHCP, this field must be kept unique for each
phone on the system.
UPDATE SERVER: Sets the address of the host running the TFTP server. (Valid values: IP
address or FQDN. Default value: blank)
UPDATE FILE: The name of the update control file on the update server. This name may
contain the macro symbols %m, %h and %i. These symbols are expanded to the MAC
address, host name and IP address respectively. (Default value: blank)
UPDATE INTERVAL: Forces the unit to attempt a file download every X hours where X can
be an integer value between 0 and 1000. A value of 0 disables the periodic update request.
The default value is 1.
HELPSERVER: Sets the default address for the Help web page reached from the link on the
home page. The default value is http://www.gai-tronics.co.uk/voipsupport.htm, but it can be
changed to any appropriate page available on the network.
LAN SPEED: Sets the speed or auto negotiation status for the WAN Ethernet port. Valid
values: 10, 100 or AUTO. Default value: AUTO. If the speed is auto negotiated the duplex
setting has no effect.
LAN DUPLEX: Sets the duplex value for the WAN Ethernet port. Valid values: FULL or HALF.
Default value: FULL.
CONFIGID: Used by the configuration upgrade script to determine if the local configuration is
the same as the one it wants to upgrade to. If this matches the CONFIGVERSION line in the
update control file, no download will take place. Default value: blank.
ANI: Used to control the value of the Display Name field in the SIP INVITE message. Can be
used to trigger alternative answer modes when calling other GAI-Tronics VoIP Telephones.
Default value: "GAIPHONE". Maximum 12 characters.
DEFAULT_ANS_MODE: Sets the default answer mode. This mode will be used to answer a
call when ANSMODE1, ANSMODE2 and PAGEMODE are not triggered. Values available are
RING, PICK-UP, PAGE and STEALTH. RING is normal phone operation, where a button
must be pressed or handset lifted to answer an incoming call. PICK-UP is as described in
ANSMODE2 below. PAGE is as described in PAGEMODE below. STEALTH is as described
in ANSMODE1 below. Default value: ‘RING’.
The next 3 fields set “passwords” that can be used by other SIP endpoints (including GAI-
Tronics VoIP telephones) to activate 3 special auto-answer modes. These fields are usually
used for hands-free telephone variants.
ANSMODE1: Stealth auto-answer mode, where the telephone provides no indication of the
incoming call and immediately auto answers the call. The speaker is muted, and the
microphone gain is enhanced. Sending a DTMF ‘*’ during a call will change the unit to
ANSMODE 2.
ANSMODE2: Sets Intercom auto-answer mode, where the telephone auto answers and
provides normal duplex audio, preceded by an announcement tone.
PAGEMODE: Where the unit auto answers and disables the microphone. A "splash" tone
(tone 9) is emitted from the speaker to alert those nearby of an impending page
announcement. The output level of the speaker is increased to its maximum level.
APTREPORT sets whether or not APT will send reports every time the test passes. Normal
alarms only report if they change state; setting APTREPORT to ON will cause the phone to
send a regular report confirming that it's acoustic components are healthy. By inference this
report also confirms that the phone is powered, running and connected to the network so it
also provides a useful general health check. If the test fails, the phone will not send repeated
reports until at least APTOKCOUNT tests pass again.
APT now will start an APT test within 60 seconds. This button will only start a test if
APTENABLE is set to ON.
USERNAME: Can be up to 30 characters long, and can contain only the alphanumeric
characters a-z, A-Z , 0-9 . The default value is “user”. The Username cannot be blank.
IMPORTANT: The word ‘root’ is a reserved username and must not be used or assigned a
password. Setting a user name of "root" will make it impossible to access the phone, and will
require a reset to factory defaults.
PASSWORD: Can be up to 30 characters long, and can contain only the alphanumeric
characters a-z, A-Z , 0-9 . The default value is "password". Password can be blank if
required.
Note: please make sure to record the user name and password securely. They will be
required to access the phone every time, whether by web page, command line or
configuration file. In the event that the username and password are lost, the unit will
need to be reset to factory defaults. This can be done by holding down a button on the
main circuit board or by a software command. See section 10.
At the bottom of the Access page are a series of counters showing how many unsuccessful
access attempts have been made to this phone, and how many times it has been rebooted.
The counters can be reset using the "Reset counters" button.
The Serial settings page is used to set the speed for communication on the serial port.
Speeds available (from a drop-down list) are: 9600, 19200, 38400, 56700 & 115200 baud.
The default value is 115200.
The other parameters for serial comms are: 8 data bits, 1 stop bit, no parity.
SNTP: Sets the address for the SNTP server to be used, as an IP address or a FQDN.
SNTPINTERVAL: Sets the interval, in minutes, between SNTP update requests. Default is
60.
TIMEZONE: Sets the current time zone for local time from a dropdown list. See section for a
full list of available timezones.
FORMAT: Sets the date format to either UK (DD/MM) or US (MM/DD) style.
The remaining parameters on this page set the behaviour of the internal clock for daylight
savings time (DST). The normal default is for the clock to advance by one hour between the
last Sunday in March and the last Sunday in October, with the changes becoming effective at
2am on each of these days. To achieve this, the settings are:
ADJUST ON
OFFSET +01:00
STARTDAY 0
STARTDOW 1
STARTMONTH 3
STARTWOM 8
STARTTIME 02:00
ENDDAY 0
ENDDOW 1
ENDMONTH 10
ENDWOM 8
ENDTIME 02:00
Where:
ADJUST: Sets whether automatic Daylight Savings Time adjustment is on or off.
OFFSET: If DST is on, sets the offset. Default is +01:00
The remaining 10 parameters on this page set the start and end of the DST period:
The dialling and memory pages are used to set various "dialling" actions - ie how the
telephone initiates calls.
Depending on the keypad layout (see Key mapping page, section 5.11), the telephone may
have a numeric keypad, memory buttons or both.
The numeric keypad is used to enter a number one digit at a time, whereas memory buttons
are used to dial complete, predetermined numbers.
Each memory button is assigned a memory list, consisting of one or more memories.
Calls started from memory buttons automatically divert to the next number in the list if the call
fails, as described below.
Each entry has a MEMORY field, which can be a string of dialable characters or a SIP URI.
Dialable characters are the digits 0-9, and the letters A,B,C and D.
Each entry can also be assigned a COMFORT string, which is a string of digits that will be
played back to the user as DTMF when the call is being set up. This simulates the dialling
digit tones heard on a normal telephone. If these comfort digits are required, the comfort
string must be entered, even if the memory itself is a number.
Note these memories are not assigned directly to memory buttons - they must be called up in
memory lists on the next page.
The telephone can hold up to 11 memory lists (0-10). Each list can be mapped to a button
(for example if the key mapping page shows a button marked MEM1, this will use memory list
1). Refer to the Key mapping page (section 5.11) for the buttons available in this phone. List
0 is the Emergency List and is mapped to a button designated as "Emergency" if fitted.
A list can also be set to activate as soon as the handset is lifted - see the "Basic Info" sub-
page.
Each list can contain up to 20 memory entries, separated by commas. For example if you
wanted the MEM1 button to call memory 1, if that failed to then call memory 5, and if that
failed call memory 10, you would enter "1, 5, 10" in the list box for list 1. When a memory list
in invoked, the telephone will attempt to place a call to each memory in the list in sequence
until a call is successful or it reaches the end of the list.
Each memory can appear in more than one list.
See the "Basic Info" sub-page for valid call fail causes.
Each list can also be set to "Wake and Dial". With this set to ON, the telephone will come off
hook and start to process the list as soon as the appropriate button is pressed. This is
normally set for hands-free telephones and help points without a separate "ON" button, but
can be set for handset phones if required.
Once a call is connected, pressing a memory button will cause DTMF to be sent if the first
entry in its memory list consists of dial-able characters.
OFFHOOK: Sets a memory list number to be invoked when the handset is taken off hook (in
a handset model) or when an "ON" button is pressed (on a hands-free model).
The next 3 parameters govern how the telephone decides whether or not the user has
entered the complete number when dialling manually:
MAXLEN: Sets the maximum number of dialable characters that can be entered manually
before the telephone assumes that the number is complete and starts the call. Range is 1-99,
default value 25.
DIALTIME: Sets the inter-digit timeout value in seconds. Once the user has entered the off
hook state, then failure to receive another digit within the timeout period will result in the call
being initiated with the dialled digits received so far. A value of 0 seconds disables the use of
the inter-digit timeout. The default value is 5 seconds. The maximum is 20 seconds.
TERMINATOR: Sets the dial string terminator character to be either #, * or if omitted (not
used). The default value is blank (not used). If the user dials the selected character the call
setup will be initiated.
CALLLIMIT: sets the maximum time allowed for a call in minutes. The range is 0 – 240 in
minutes. The value 0 disables the timer. The default value is 0. The call is terminated when
this timer expires.
PRECALL: Sets length of time in seconds that a phone will remain in the initial off hook state
generating dial tone without a dialling key being pressed. After this delay the phone will cease
dial tone and enter the on hook state even if the hook switch is off hook. The value 0 disables
this timeout. The default value is 30. Maximum is 60.
CALLFAIL: Sets the length of time that the phone will play tone 1 (dial tone) after the call has
ended. The default value is 30 seconds. The value 0 disables this timeout. Range is 0-30
FAILOVERCAUSES: Comma separated list of cause codes that would allow the phone to try
the next entry in a list of memories. It is in no particular order. The cause codes are as
defined by Q.931 - See table below. The default list is:1,17,18,21,27,38,41,50,88
Note that there are two failover mechanisms: one for memories (defined here) and a second
for proxies (defined in section 5.4). If a call fails due to a proxy problem, the phone will then
try to place the call to the same number on the next proxy. If the call fails due to an endpoint
problem (for example "busy"), the phone will try the next number in the list, on the current
proxy.
REMOTEALERTINGTIMEOUT: sets the maximum length of time in seconds that the phone
will ring on an outgoing call before timing out and returning "Number Unobtainable" (Tone 6)
to the user. A value of 0 disables the timer, meaning it will ring until the caller hangs up or the
remote end refuses the call. Range is 0-600. Default value 0.
LOCALALERTINGTIMEOUT: sets the maximum length of time in seconds that the phone will
ring on an incoming call before timing out and returning a "no answer" result to the caller. A
value of 0 disables the timer, meaning it will ring until the caller stops ringing. Range is 0-600.
Default value 0.
REMOTEALERTINGTIMEOUTCAUSECODE: sets the cause code (from the table above)
that will be entered in the call description record (CDR) if an outgoing call times out without
being answered. Default value 18.
LOCALALERTINGTIMEOUTCAUSECODE: sets the cause code (from the table above) that
will be entered in the call description record (CDR) if an incoming call times out without being
answered. It also sets the failover code that is returned to the calling party. Default value 18,
which will send a failover code of 408 from the table above.
Key Function
0 Dials a ‘0’.
1 Dials a ‘1’.
2 Dials a ‘2’.
3 Dials a ‘3’.
4 Dials a ‘4’.
5 Dials a ‘5’.
6 Dials a ‘6’.
7 Dials a ‘7’.
8 Dials an ‘8’.
9 Dials a ‘9’.
* Dials a ‘*’.
# Dials a ‘#’.
A Dials an ‘A’.
B Dials a ‘B’.
C Dials a ‘C’.
D Dials a ‘D’.
MUTE Toggle action key to silence/enable the transmission of audio from the
unit. Usually assigned to a key marked "S" (for Secrecy)
RECALL Defined below.
LNR Last Number Redial
ONHOOK Clears a call and puts the phone into the on hook state. Usually assigned
to a key marked "OFF"
OFFHOOK Answers a call or puts the phone into the off hook state ready to dial.
Usually assigned to a key marked "ON"
TOGGLEHOOK Toggle action key to take the phone on and off hook.
MEM 1, MEM 2 Attempts to initiate a call using Memory List 1, Memory List 2, etc., to
etc., to MEM 10 Memory List 10.
Key Function
EMERGENCY Overrides any existing call and attempts to initiate a call using Memory List
0. Other keys can be inhibited during an emergency call - see below.
PULSE Activates any output configured with a "PULSE" keyword on the Logic
page (section 5.17). The output(s) will remain active for the duration of the
TIMER setting.
PULSE1 Activates Output 1 if it is configured with a "PULSE" keyword on the Logic
page. The output will remain active for the duration of the TIMER setting.
PULSE2 Activates Output 2 if it is configured with a "PULSE" keyword on the Logic
page. The output will remain active for the duration of the TIMER setting.
VOLUMEUP Increases audio output level (either HANDSETVOLUME or
HANDSFREEVOLUME as appropriate)
VOLUMEDOWN Decreases audio output level (either HANDSETVOLUME or
HANDSFREEVOLUME as appropriate)
VOLUMENEXT Steps the audio output volume to the next level, where the levels are
defined as current volume setting, midway to maximum, and maximum. A
further press will loop the volume back to current. Affects either
HANDSETVOLUME or HANDSFREEVOLUME as appropriate
GAINUP Increases HANDSETGAIN or HANDSFREEGAIN as appropriate.
GAINDOWN Decreases HANDSETGAIN or HANDSFREEGAIN as appropriate.
NOEFFECT Key is disabled.
Note that the input status reflects the settings on the Logic page (section 5.17). If the input is
set to detect "NONE", the status will report as Disabled. If the input is set to detect either ON
or OFF (or both), the status will report as follows:
Closed OFF ON
Open ON OFF
Example: 6,5,4 would set the order of preference to be G.723.1 ACELP followed by G.723.1
MP-MLQ followed by G.729. None of the other codecs would be included.
NOTE: If codecs 5 & 6 are both used, they must be next to one another in the list.
SAMPLE: Sets the sample period for the G711, G722 and G 729 codecs to be either 10 or
20ms (individually). Default setting is 20ms.
NOTE: the sample size cannot be bigger than the packet size (packet size = frames per
packet x frame period). Normally the packet size will be at least 20ms, but if you have set a
low packet size (see below), you may need to set the sample period to 10ms.
FRAMES: sets the number of audio sample periods or “frames” per IP packet.
Default values:
G.723.1 = 1. Each frame is 30ms (20 or 24 bytes), range is 1-4 frames
G.729 = 2. Each frame is 10ms (10 bytes), range is 2-10 frames.
G.711 = 20. Each frame is 1ms (8 bytes), range is 10-100 frames.
Increasing the number of frames per packet allows the bandwidth used on the IP connection
to be minimised, but increases transmission delay.
Decreasing the number of frames per packet reduces transmission delay but increases the
bandwidth used.
Note: the packet size (frame size x frames per packet) must be greater than the sample size
(see above). Make sure the SAMPLE size and FRAMES value for each codec are set
accordingly.
VAD: Enables or disables the use of Voice Activity Detection. This command is only valid for
G723 and G729 Codec settings. The default value is OFF. Note that when using the G729
codec, VAD must be set to on.
DTMF: Sets the transmission of DTMF digits to be either in band or out of band. The default
setting is out of band, when DTMF is transmitted using RFC 2833.
DTMFPT: Sets the payload type parameter in the RTP packets when sending DTMF tones
'out-of-band' according to RFC2833. The default value is 96, but should be changed to 101
when using Cisco CallManager™.
DTMFPLAYBACK: sets whether DTMF tones are heard in the earpiece when digit buttons 0-
9, * or # are pressed. Default value OFF.
HANDSETVOLUME: If the telephone is a handset model, this parameter sets the handset
earpiece volume. The range is 1-9 and the default value is 8. If the telephone is a hands-free
model, this setting has no effect.
HANDSFREEVOLUME: If the telephone is a hands-free model, this parameter sets the
speaker volume. The range is 1-12 and the default value is 3. If the telephone is a handset
model, this setting has no effect.
LINEVOLUME: This parameter is for future enhancements and has no effect.
Note: these volume settings set the starting volume within the available range. If the
telephone has a volume control button or buttons, these will only act up to the extents of the
range. In other words if the volume is set to its maximum on the web page, a “VOLUMEUP”
button will have no effect.
RINGERVOLUME: This parameter sets the ringer volume for both handset and hands-free
models. The range is 1-12 and the default value is 10.
HANDSETGAIN: If the telephone is a handset model, this parameter sets the handset
microphone gain. The range is 1-8 and the default value is 6. If the telephone is a hands-free
model, this setting has no effect.
HANDSFREEGAIN: If the telephone is a hands-free model, this parameter sets the
microphone gain. The range is 1-8 and the default value is 3. If the telephone is a handset
model, this setting has no effect.
LINEGAIN: This parameter is for future enhancements and has no effect.
JITTERMIN: Minimum size of dynamic jitter buffer. Range is 30-120. Default value is 30.
JITTERMAX: Maximum size of dynamic jitter buffer. Range is 30-120. Default value is 60.
SIDETONE: Sets whether sidetone is on or off. Default setting is ON for handset models,
OFF for hands-free models.
SIDETONELEVEL: If sidetone is set to ON, this parameter sets its level. Range is 0-255,
default value 127. Take care when setting this level to ensure it is neither too high nor too low
for safe and acceptable performance.
ONTIME: assigns alarm activation De-bounce Period to a specific alarm number. The alarm
event must be present at the start and at the end of the de-bounce Period before the alarm
status will be signalled using e-mail or syslog messaging (If enabled).
The period is specified in seconds and can take a value of 0 – 30,000. A value of 0 indicates
that there is no de-bounce period for this alarm type and a message will be generated
immediately the alarm event is detected.
OFFTIME: assigns an alarm removal De-bounce Period to a specific alarm number. The
alarm event must be absent at the start and at the end of the de-bounce period before the
alarm clearance will be signalled using e-mail or syslog messaging (if enabled).
The period is specified in seconds and can take a value of 0 – 30,000. A value of 0 indicates
that there is no de-bounce period for this alarm type and a message will be generated
immediately the alarm event is detected.
SYSLOG: enables or disables SYSLOG reporting for the selected alarm. Syslog settings are
on the IP setting page (section 5.3).
MAIL: enables or disables SMTP reporting for the selected alarm number. SMTP settings
are on the Email settings page (section 5.8).
MSG: Replaces the default text message ALARM <alarm_number> with the text entered
(maximum 40 characters). The status <on/off> is appended to the end of the text. If the MSG
value is blank, the default message is reinstated.
The message sent (for both mail and syslog reports), takes the form:
HOSTNAME COUNT TIME MSG ON/OFF
Where
HOSTNAME is from the Unit settings page (section 5.5).
COUNT is a volatile event counter (modulus 10000)
TIME is the event time and date from the unit's clock
MSG is the message set by the MSG field above. If no message has been set, the
default is "ALARM x" where x is the number shown against the alarms below.
ON/OFF is either the word ON or OFF according to the state of the alarm.
The History page displays a list of recent alarms (since last reset).
The "Edit" button on this page has no function.
The telephone can generate 8 tone signals, usually set to emulate those used by normal
analogue phones:
Tone 1 - Dial: after taking the phone off hook but before dialling
Tone 2 - Stutter Dial: reserved for future use
Tone 3 - Ring: when a call has been placed but not yet answered
Tone 4 - Busy: when the called party is engaged
Tone 5 - Congestion: when the call cannot connect due to network congestion
Tone 6 - Number Unobtainable: when the call cannot connect due to the endpoint not being
recognised
Tone 7 - Ring Signal: announcing an incoming call.
Tone 8 – Register Fail: When a call cannot be made due to registration failure
Tone 9 - Splash 1: Announcing an incoming PAGE call
Tone 10 - Splash 2 MRTP: Announcing an incoming multicast
Each tone can be configured by setting a tone frequency (ie the note), and the cadence (ie
the timing pattern). These are normally set to simulate exchange tones common to the
phone's location, but may be configured for any purpose, for example to give distinctive ring
tones to differentiate between phones mounted close together. A table of typical tones used
in various countries is included below, and the make up of the tones is explained as follows:
Frequency
Frequency No. Tone.
1 400 Hz
2 425 Hz
3 440 Hz
4 350 Hz + 450 Hz
5 400 Hz + 450 Hz
6 480 Hz + 620 Hz
7 20 Hz + 675 Hz
8 20 Hz + 1000 Hz
9 20 Hz + 1350Hz
10 30 Hz + 2575 Hz
11 2970Hz alternating with 3380Hz at 30Hz and maxed gains
12 220Hz
13 440Hz
Frequencies 1 to 6 are commonly used for call progress, whilst 7 to 10 are usually used for
ring signals.
For example dial tone in the UK is a compound tone of 350+450 Hz, corresponding to
frequency No.4.
Cadence
The telephone sets the cadence of a tone using ON and OFF times. To allow for most
regional tone patterns there are 3 pairs of ON and OFF times - an initial pair, which is played
once only, and 2 subsequent pairs that are repeated one after the other until the tone stops.
(See diagram below).
Repeat
Start
ON and OFF times are entered in units of 25ms (ie 1s is entered as 40) and are in the range
0 - 600.
To create a continuous tone, set any one of the ON times to a value (say 80), and all the
other ON and OFF times to 0.
NU 6 2 0 0 40 4 0 0
Ring signal 7 10 0 0 40 160 0 0
Register Fail 8 4 0 0 78 2 0 0
Note that the ring signal frequency is not specified by any regulations or customs. Frequency
10 is shown in the examples above, but any could be used according to preference.
Splash tones are not country specific so are not shown above.
The ON and OFF keywords must be used on their own. The other keywords (indicated by a +
symbol in the table above), can be combined and entered in any order, separated by a plus
(+) character. For example to set an LED to flash when an incoming call is ringing, and
illuminate steadily when the call is connected enter RING+CONNECT.
TIMER: Sets the timer value for the PULSE command in seconds. Default value is 3. The
minimum is 0 & the maximum is 3600.
CADENCE: Sets the cadence for those keyword commands that require it. The cadence is
entered as two numbers separated by a colon (:) character, representing the on and off times
in tenths of a second. For example to set a cadence of 1 second on, half a second off, enter
10:5.
At the bottom of the page is a mode entry box with a MODE button. The box offers 3 choices
from a drop-down menu. These preset the functions of LED1 and LED2 to mimic existing
analogue telephone models:
HELPPOINT: Sets LED1 to RING+HOOK, LED2 to OFF
DDA: Sets LED1 to HOOK+RINGOUT, and LED2 to CONNECT+RING.
OFF: Sets LED1 & LED2 both OFF
Clicking the MODE button has the effect of applying and saving the mode settings.
TIMER and CADENCE settings are not affected by the MODE (ie they must be set
independently).
Inputs
The 4 auxiliary inputs are activated by connecting the relevant input terminal to a common
terminal via a volt-free contact. See installation guide 502-20-0115-001 for connection details
and electrical limits. If the contact is open the input is normally deemed to be ON, and if the
contact is closed it is deemed to be OFF. The sense can be inverted, see below:
The auxiliary inputs can be configured to report their status to a remote site using two
methods: -
Syslog output over TCP
SMTP mail message
For each input, the following parameters can be set:
DETECT: Specifies if an input will report being set to its ON condition only (ON), its OFF
condition only (OFF), on either event (ON+OFF) or not at all (NONE). The ON and OFF
states are affected by the SENSE setting below.
SENSE: If set to NORMAL, a contact closure will report as OFF. If set to INVERT, a contact
closure will report as ON. Default is NORMAL
SYSLOG: enables or disables SYSLOG reporting for the selected input. Syslog settings are
on the IP setting page (section 5.3).
MAIL: enables or disables SMTP reporting for the selected input. SMTP settings are on the
Email settings page (section 5.8).
MSG: Replaces the default text message Aux_in <input_number> with the text entered
(maximum 40 characters). The status <on/off> is appended to the end of the text. If the MSG
value is blank, the default message is reinstated.
The message sent (for both mail and syslog reports), takes the form:
HOSTNAME COUNT TIME MSG ON/OFF
Where
Outputs
The 2 outputs are both volt-free contacts, but their ratings differ. See installation guide 502-
20-0115-001 for connection details and electrical limits.
Each output has 3 parameter entry fields:
GENERATE: This field sets the function of the output by the use of the following keywords:
The ON and OFF keywords must be used on their own. The other keywords (indicated by a +
symbol in the table above), can be combined and entered in any order, separated by a plus
(+) character. For example to set an output to pulse when an incoming call is ringing, and be
on steadily when the call is connected enter RING+CONNECT.
TIMER: Sets the timer value for the PULSE command in seconds. Default value is 3. The
minimum is 0 & the maximum is 3600.
CADENCE: Sets the cadence for those keyword commands that require it. The cadence is
entered as two numbers separated by a colon (:) character, representing the on and off times
in tenths of a second. For example to set a cadence of 1 second on, half a second off, enter
10:5.
TIMEOUT: sets an enforced delay (in seconds) between one Multicast session ending and
another beginning. Range 1-120. Default 120
SPEAKERVOLUME: sets the speaker volume during a multicast. Volume will revert to the
setting on the AUDIO page when the multicast session has ended. Range is 1 to 10, default
value 3.
Override level: sets the override level (between 0 and 8) for normal phone calls with respect
to the priority level set against multicast calls defined below. 1 is highest priority, 8 is lowest.
0 means no priority and will not override any multicast. For example, if override level is set to
5, a voice call will override a multicast having a priority of 6, but not one having a priority of 4.
If a voice call and a multicast have the same priority level the multicast will take precedence.
If an incoming call is made to a phone whilst a higher priority multicast is in progress, the
caller may hear the multicast audio but a speech call will not be connected to the phone until
the multicast has ended.
Note: Emergency calls started from the phone (ie using a button designated as an
Emergency button) will always override any normal or multicast call, regardless of priority or
override level.
TONE: sets if tone 10 (TONES page) is ENABLED or DISABLED during this multicast.
5. In summary, configuration file updates are achieved using 2 files: an update control file
and a configuration file.
6. When the firmware (and kernel if required) need to be updated, the update control file is
expanded to its full form, for example:
USERNAME=user
PASSWORD=password
CONFIGVERSION=18but7
CONFIGFILE=VoIP3.cfg
SERVER=192.168.1.6
VERSION=1.1.11
ROOTFS=incaip.root.jffs2
USERFS=incaip.usrlocal.jffs2
KERNEL=1
KERNELFILE=uImage_quiet
KERNELMD5=ad785ffb47ccd95224f8844addc7ec05
ROOTFSMD5=f5d417c3b94a8b34e2c6afecfc985128
USERFSMD5=d5c978f26d351a9428d9c390fbb5e1ed
Where:
SERVER is the address from which the firmware and kernel files are downloaded.
VERSION is the version of the firmware code available.
ROOTFS & USERFS are filenames of the 2 files required to upgrade the firmware.
KERNEL is a flag that decides whether the kernel needs updating for this version of code.
(1 – needed, 0 – not needed)
KERNELFILE is the kernel file to upgrade to.
The xxxMD5 lines are the MD5 sums of the padded files to be upgraded to. This is to
ensure the integrity of the files.
7. If firmware or kernel upgrades are necessary, the files will be supplied by Gai-Tronics
together with the appropriate xxxMD5 codes.
8. All filenames used in this process, ie the FILE field on the UNIT page, and the
CONFIGFILE, ROOTFS, USERFS and KERNELFILE names in the update control file,
can contain the predefined macros %h (hostname), %i (IP address) or %m (MAC
address) or any combination of them in the filename string. Eg: ‘update.cfg%m’ would
expand to ‘update.cfg0001df123456’ (for a MAC address of 0001df123456).
Each configuration file need only contain the sections required to be changed. Within each
section, only the parameters to be changed need to be included. Sections (and parameters
within each section) can be in any order. A configuration file will incrementally patch the
existing configuration
All section headers are enclosed within square brackets and followed by comment character
or a Carriage return / Line feed character combination.
[Section Name]cr/lf
Comments can be placed within the file by preceding the comment with the // symbol
combination and ending the line with a carriage return / line feed combination
Individual module configuration lines are made up of a configuration item identifier followed by
the = sign, and then any configuration values or parameters.
The Item Identifier can consist of one or more words before the equals sign, the configuration
values or parameters follow the = character and are separated by spaces or tab characters.
The line is ended by a comment character combination (//) or a cr/lf combination.
The table below lists the valid section names, the valid Item Identifiers within that section and
the allowable values that can be assigned to each item identifier. In some cases a fuller
description of the various options is contained in the section on the relevant web page above.
Configuration lines that are not understood will be ignored and processing will continue at the
next line. Configuration lines that are in the wrong section will be ignored, and processing of
the rest of the file will continue at the next line.
Commands will be read and actioned as the parser proceeds down the file. If a subsequent
command contradicts an earlier command, then the later command will be acted upon and
the earlier command overridden.
For Example:-
[ALARMS]
ALARM=1 ON //initial command is actioned
ALARM=1 ON+OFF // subsequent command is actioned overriding previous command
Multiple values for the same item identifier are permitted on the same line, and are separated
by space, comma or tab characters.
Example:-
[AUDIO]
CODEC=1,4,6 // Selects preferences as G.711 A-law, G.729 &
// G.723.1 ACELP in that order
An example configuration file is included in Section 8, showing entries in each section. This
example (or parts of it) can be used as a basis to construct files as required.
UTC/GMT
Abbreviation Time Zone Name Cities
Offset
IDL (International Date Line),
IDL GMT-12:00 IDLW (International Date Line west)
Eniwetok
UTC/GMT
Abbreviation Time Zone Name Cities
Offset
CCT (China Coast Time),
HST (Hong Kong Standard Time), Beijing,
HST GMT+08:00 USSR-zone7, Hong Kong
WADT (West Australian Daylight Time)
JST (Japan Standard Time/Tokyo),
Tokyo,
JST GMT+09:00 KST (Korean Standard Time),
Seoul
SSR-zone8
SAST (South Australian Standard Time),
CAST GMT +09:30 CAST (Central Australian Standard Darwin
Time)
GST (Guam Standard Time),
Brisbane,
EAST GMT+10:00 USSR-zone9,
Guam
EAST (East Australian Standard Time)
USSR-zone10, Solomon
EADT GMT+11:00 EADT (East Australian Daylight Time) Islands
NZT (New Zealand Time/Auckland),
NZST GMT+12:00 NZST (New Zealand Standard Time), Auckland
IDLE (International Date Line East)
The file below is an example configuration file for a hands-free phone. The key features of the
phone are:
2 button handsfree with an emergency button (dials 888) and an information button (dials
three alternative end points in cascade).
Output 1 activates a beacon when the unit is making or receiving a call.
Output 2 activates a door release on command from another telephone
Call tones are set to UK patterns
Alarms 2, 3, 4 & 8 report via SYSLOG
Alarm 6 (stuck button) reports via email
Input 1 is configured as a vandal alarm and also reports via email
[ACCESS]
PASSWORD=password
USERNAME=user
[MULTICAST]
ADDRESS=1 224.0.1.75:1000
ADDRESS=2 224.0.1.75:2000
ADDRESS=3 224.0.1.75:3000
ADDRESS=4 224.0.1.75:4000
ADDRESS=5 224.0.1.75:5000
ADDRESS=6 224.0.1.75:6000
ADDRESS=7 224.0.1.75:7000
ADDRESS=8 224.0.1.75:8000
FILTER=1 0.0.0.0:255.255.255.255
FILTER=2 0.0.0.0:255.255.255.255
FILTER=3 0.0.0.0:255.255.255.255
FILTER=4 0.0.0.0:255.255.255.255
FILTER=5 0.0.0.0:255.255.255.255
FILTER=6 0.0.0.0:255.255.255.255
FILTER=7 0.0.0.0:255.255.255.255
FILTER=8 0.0.0.0:255.255.255.255
OUTPUT1=1 DISABLED
OUTPUT1=2 DISABLED
OUTPUT1=3 DISABLED
OUTPUT1=4 DISABLED
OUTPUT1=5 DISABLED
OUTPUT1=6 DISABLED
OUTPUT1=7 DISABLED
OUTPUT1=8 DISABLED
OUTPUT2=1 DISABLED
OUTPUT2=2 ENABLED
OUTPUT2=3 ENABLED
OUTPUT2=4 ENABLED
OUTPUT2=5 ENABLED
OUTPUT2=6 ENABLED
OUTPUT2=7 ENABLED
OUTPUT2=8 ENABLED
OVERRIDE=4
PRIORITY=1 1
PRIORITY=2 2
PRIORITY=3 3
PRIORITY=4 4
PRIORITY=5 5
PRIORITY=6 6
PRIORITY=7 7
PRIORITY=8 8
SPEAKERVOLUME=6
TIMEOUT=1
TONE=1 ENABLED
TONE=2 ENABLED
TONE=3 ENABLED
TONE=4 ENABLED
TONE=5 ENABLED
TONE=6 ENABLED
TONE=7 ENABLED
TONE=8 ENABLED
[ALARMS]
ALARM1=REPORT NONE
ALARM1=ONTIME 2
ALARM1=OFFTIME 2
ALARM1=SYSLOG OFF
ALARM1=MAIL OFF
ALARM1=MSG Integ Loop Fail
ALARM2=REPORT ON
ALARM2=ONTIME 0
ALARM2=OFFTIME 0
ALARM2=SYSLOG ON
ALARM2=MAIL OFF
ALARM2=MSG Config Error
ALARM3=REPORT ON
ALARM3=ONTIME 0
ALARM3=OFFTIME 0
ALARM3=SYSLOG ON
ALARM3=MAIL OFF
ALARM3=MSG Cold Reset
ALARM4=REPORT ON
ALARM4=ONTIME 0
ALARM4=OFFTIME 0
ALARM4=SYSLOG ON
ALARM4=MAIL OFF
ALARM4=MSG Warm Reset
ALARM5=REPORT NONE
ALARM5=ONTIME 300
ALARM5=OFFTIME 0
ALARM5=SYSLOG OFF
ALARM5=MAIL OFF
ALARM5=MSG
ALARM6=REPORT ON
ALARM6=ONTIME 10
ALARM6=OFFTIME 2
ALARM6=SYSLOG OFF
ALARM6=MAIL ON
ALARM6=MSG Stuck Key
ALARM7=REPORT OFF
ALARM7=ONTIME 120
ALARM7=OFFTIME 2
ALARM7=SYSLOG OFF
ALARM7=MAIL OFF
ALARM7=MSG Left Off Hook
ALARM8=REPORT ON
ALARM8=ONTIME 360
ALARM8=OFFTIME 0
ALARM8=SYSLOG ON
ALARM8=MAIL OFF
ALARM8=MSG Registration Fail
ALARM9=REPORT NONE
ALARM9=ONTIME 0
ALARM9=OFFTIME 0
ALARM9=SYSLOG OFF
ALARM9=MAIL OFF
ALARM9=MSG
ALARM10=REPORT NONE
ALARM10=ONTIME 0
ALARM10=OFFTIME 0
ALARM10=SYSLOG OFF
ALARM10=MAIL OFF
ALARM10=MSG
ALARM11=REPORT NONE
ALARM11=ONTIME 0
ALARM11=OFFTIME 0
ALARM11=SYSLOG OFF
ALARM11=MAIL OFF
ALARM11=MSG
ALARM12=REPORT NONE
ALARM12=ONTIME 0
ALARM12=OFFTIME 0
ALARM12=SYSLOG OFF
ALARM12=MAIL OFF
ALARM12=MSG
ALARM13=REPORT NONE
ALARM13=ONTIME 0
ALARM13=OFFTIME 0
ALARM13=SYSLOG OFF
ALARM13=MAIL OFF
ALARM13=MSG
ALARM14=REPORT NONE
ALARM14=ONTIME 0
ALARM14=OFFTIME 0
ALARM14=SYSLOG OFF
ALARM14=MAIL OFF
ALARM14=MSG
ALARM15=REPORT NONE
ALARM15=ONTIME 0
ALARM15=OFFTIME 0
ALARM15=SYSLOG OFF
ALARM15=MAIL OFF
ALARM15=MSG
ALARM16=REPORT NONE
ALARM16=ONTIME 0
ALARM16=OFFTIME 0
ALARM16=SYSLOG OFF
ALARM16=MAIL OFF
ALARM16=MSG
ALARM17=REPORT NONE
ALARM17=ONTIME 0
ALARM17=OFFTIME 0
ALARM17=SYSLOG OFF
ALARM17=MAIL OFF
ALARM17=MSG
ALARM18=REPORT NONE
ALARM18=ONTIME 0
ALARM18=OFFTIME 0
ALARM18=SYSLOG OFF
ALARM18=MAIL OFF
ALARM18=MSG
ALARM19=REPORT NONE
ALARM19=ONTIME 0
ALARM19=OFFTIME 0
ALARM19=SYSLOG OFF
ALARM19=MAIL OFF
ALARM19=MSG
ALARM20=REPORT NONE
ALARM20=ONTIME 0
ALARM20=OFFTIME 0
ALARM20=SYSLOG OFF
ALARM20=MAIL OFF
ALARM20=MSG
[AUDIO]
CODEC=4,2,1,5,6,3
DTMF=RFC2833
DTMFPT=96
FRAMES=G711 20
FRAMES=G722 20
FRAMES=G729 2
FRAMES=G7231 1
HANDSETGAIN=6
HANDSETVOLUME=3
HANDSFREEGAIN=6
HANDSFREEVOLUME=10
JITTERMAX=60
JITTERMIN=30
LINEGAIN=3
LINEVOLUME=3
RINGERVOLUME=10
SAMPLE=G711 20
SAMPLE=G722 20
SAMPLE=G729 20
SIDETONE=OFF
SIDETONELEVEL=127
VAD=OFF
[CLOCK]
DST=ADJUST OFF
DST=OFFSET +01:00
DST=STARTDAY 0
DST=STARTDOW 1
DST=STARTMONTH 3
DST=STARTWOM 8
DST=STARTTIME 02:00
DST=ENDDAY 0
DST=ENDDOW 1
DST=ENDMONTH 10
DST=ENDWOM 8
DST=ENDTIME 02:00
FORMAT=DD/MM
SNTP=ntp2b.mcc.ac.uk
SNTPINTERVAL=60
TIMEZONE=+00:00: GMT Greenwich Mean/WET Western Eu/UT Universal
[DIALPLAN]
CALLFAIL=5
CALLLIMIT=0
DIALTIME=5
FAILOVERCAUSES=1,17,21,27,38,41,50,88
LIST=0 1
LIST=1 2, 3, 4
LIST=2 2
LIST=3 3
LIST=4 4
LIST=5 5
LIST=6 6
LIST=7 7
LIST=8 8
LIST=9 9
LIST=10 10
MEMORY=1 888
MEMORY=2 sip:[email protected]
MEMORY=3 sip:[email protected]
MEMORY=4 [email protected]
MEMORY=5
MEMORY=6
MEMORY=7
MEMORY=8
MEMORY=9
MEMORY=10
MEMORY=11
MEMORY=12
MEMORY=13
MEMORY=14
MEMORY=15
MEMORY=16
MEMORY=17
MEMORY=18
MEMORY=19
MEMORY=20
COMFORT=1 888
COMFORT=2 223344
COMFORT=3 223344
COMFORT=4 223344
COMFORT=5
COMFORT=6
COMFORT=7
COMFORT=8
COMFORT=9
COMFORT=10
COMFORT=11
COMFORT=12
COMFORT=13
COMFORT=14
COMFORT=15
COMFORT=16
COMFORT=17
COMFORT=18
COMFORT=19
COMFORT=20
WAKEANDDIAL=0 OFF
WAKEANDDIAL=1 ON
WAKEANDDIAL=2 ON
WAKEANDDIAL=3 ON
WAKEANDDIAL=4 OFF
WAKEANDDIAL=5 OFF
WAKEANDDIAL=6 OFF
WAKEANDDIAL=7 OFF
WAKEANDDIAL=8 OFF
WAKEANDDIAL=9 OFF
WAKEANDDIAL=10 OFF
LOCALALERTINGTIMEOUT=0
LOCALALERTINGTIMEOUTCAUSECODE=18
MAXLEN=25
OFFHOOK=
PRECALL=30
REMOTEALERTINGTIMEOUT=0
REMOTEALERTINGTIMEOUTCAUSECODE=18
TERMINATOR=
[IP]
ADDRESS=192.168.1.2
DHCP=OFF
DNS1=0.0.0.0
DNS2=0.0.0.0
GATEWAY=0.0.0.0
LOCALDOMAIN=mydomain.com
MASK=255.255.0.0
STUN=
SYSLOG=192.168.1.25
SYSLOG2=192.168.1.26
SYSLOGFACILITY=14
SYSLOGPORT=514
SYSLOGPORT2=514
SYSLOGSEVERITY=5
TELNET=ON
TELNETPORT=23
WEB=ON
WEBPORT=80
[KEY]
INHIBIT=MEMORY
RECALL=
[LED]
LED1=GENERATE HOOK+RING+RINGOUT
LED1=TIMER 3
LED1=CADENCE 2:1
LED2=GENERATE OFF
LED2=TIMER 3
LED2=CADENCE 10:0
LED3=GENERATE OFF
LED3=TIMER 3
LED3=CADENCE 10:0
[LOCAL]
SPEED=115200
[LOGIC]
INPUT1=DETECT ON
INPUT1=SENSE NORMAL
INPUT1=SYSLOG OFF
INPUT1=MAIL ON
INPUT1=MSG Tamper Alarm
INPUT2=DETECT NONE
INPUT2=SENSE INVERT
INPUT2=SYSLOG OFF
INPUT2=MAIL OFF
INPUT2=MSG
INPUT3=DETECT NONE
INPUT3=SENSE INVERT
INPUT3=SYSLOG OFF
INPUT3=MAIL OFF
INPUT3=MSG
INPUT4=DETECT NONE
INPUT4=SENSE INVERT
INPUT4=SYSLOG OFF
INPUT4=MAIL OFF
INPUT4=MSG
OUTPUT1=TIMER 3
OUTPUT1=CADENCE 10:0
OUTPUT1=GENERATE RING+INUSE
OUTPUT2=TIMER 3
OUTPUT2=CADENCE 10:0
OUTPUT2=GENERATE PULSE
[SIP]
HANGUPONREGFAILURE=OFF
RELAXCANCELMATCH=OFF
LOCALPORT=5060
PROXYFAILOVERSTATUSES=5xx,6xx,49x,403,406,9xx
DONTSTARTMEDIAATRING=OFF
SENDDTMFLAST=OFF
RTPTOS=46
SINGLEPTIME=0
MODE=SERIAL
REGTIMEOUT=3600
REREGTIMEOUT=0
LOCALID=1 12345
DOMAIN=1
PROXY=1
PROXYPORT=1 5060
REGISTRAR=1
REGISTRARPORT=1 5060
USERNAME=1
PASSWORD=1
PRIORITY=1 1
ENDPOINT=1 ENABLED
LOCALID=2
DOMAIN=2
PROXY=2
PROXYPORT=2 5060
REGISTRAR=2
REGISTRARPORT=2 5060
USERNAME=2
PASSWORD=2
PRIORITY=2 2
ENDPOINT=2 DISABLED
LOCALID=3
DOMAIN=3
PROXY=3
PROXYPORT=3 5060
REGISTRAR=3
REGISTRARPORT=3 5060
USERNAME=3
PASSWORD=3
PRIORITY=3 3
ENDPOINT=3 DISABLED
LOCALID=4
DOMAIN=4
PROXY=4
PROXYPORT=4 5060
REGISTRAR=4
REGISTRARPORT=4 5060
USERNAME=4
PASSWORD=4
PRIORITY=4 4
ENDPOINT=4 DISABLED
[SMTP]
CCADDRESS=
FROMADDRESS=
SERVER1=
SERVER2=
SMTP=OFF
SUBJECT=
TOADDRESS=
[TONES]
TONE1=FREQ 4
TONE1=ON1 0
TONE1=OFF1 0
TONE1=ON2 80
TONE1=OFF2 0
TONE1=ON3 0
TONE1=OFF3 0
TONE2=FREQ 4
TONE2=ON1 0
TONE2=OFF1 0
TONE2=ON2 16
TONE2=OFF2 4
TONE2=ON3 0
TONE2=OFF3 0
TONE3=FREQ 5
TONE3=ON1 0
TONE3=OFF1 0
TONE3=ON2 16
TONE3=OFF2 8
TONE3=ON3 16
TONE3=OFF3 80
TONE4=FREQ 1
TONE4=ON1 0
TONE4=OFF1 0
TONE4=ON2 15
TONE4=OFF2 15
TONE4=ON3 0
TONE4=OFF3 0
TONE5=FREQ 1
TONE5=ON1 0
TONE5=OFF1 0
TONE5=ON2 16
TONE5=OFF2 14
TONE5=ON3 9
TONE5=OFF3 21
TONE6=FREQ 1
TONE6=ON1 0
TONE6=OFF1 0
TONE6=ON2 80
TONE6=OFF2 0
TONE6=ON3 0
TONE6=OFF3 0
TONE7=FREQ 8
TONE7=ON1 0
TONE7=OFF1 0
TONE7=ON2 16
TONE7=OFF2 8
TONE7=ON3 16
TONE7=OFF3 80
TONE8=FREQ 1
TONE8=ON1 0
TONE8=OFF1 0
TONE8=ON2 78
TONE8=OFF2 2
TONE8=ON3 0
TONE8=OFF3 0
[UNIT]
ANI=GAIPHONE
ANSMODE1=
ANSMODE2=
PAGEMODE=
CONFIGID=900-20-6602-201a4
HELPSERVER=http://www.gai-tronics.co.uk/voipsupport.htm
HOSTNAME=UNNAMED
LAN=SPEED AUTO
LAN=DUPLEX FULL
UPDATE=SERVER
UPDATE=FILE
UPDATE=INTERVAL 1
APTCOUNT=1
APTOKCOUNT=1
APTREPORT=ON
APTTIME=0:0,24
This section describes the syntax required for CLI commands. Generally, the CLI commands
match those used in configuration files. Therefore the feature descriptions listed below may
be abbreviated. For fuller descriptions refer to the sections on the relevant web pages or
configuration file syntax.
Generally speaking, the CLI is not the preferred access method, but it may offer advantages
in certain circumstances. In particular it offers a method of accessing the telephone and
discovering the IP address if it has been lost. (Password security is maintained).
To start a CLI session via serial link, connect a standard RS232 serial cable between the
telephone and a PC serial port, and connect using a terminal program such as
HyperTerminal. The default port settings are 115200 baud, 8 data bits, 1 stop bit, no parity.
Note that the speed can be changed (See the Serial Settings web page section).
A CLI session can also be started by entering “Telnet 192.168.1.2” from a command prompt
on a computer that can see the telephone on the network (substitute the IP address if it has
been changed).
The behaviour of the CLI is the same regardless of the access method, and its first response
is to request the USERNAME and PASSWORD.
At log in, the following information is displayed (the values presented here are examples):
Welcome <username>
Welcome to the GAI Tronics SIP Phone CLI.
Board type: a
Board serial: b
Daughter type: c
Daughter serial: d
Unit type: e
Unit serial: f
MAC address: 00:01:df:65:43:21
2.1.7
2.1.7 GAICLI
2.1.7 GAIUISERVER
2.1.7 GAIPHONE
2.1.7 GAIGW
2.1.7 CONFIGACTIVATOR
The Command Line interface will provide a Command Line Prompt as shown below: -
[UNIT IDENTIFIER]>>
The unit identifier is a configuration option that provides a user configurable name up to a
maximum of 32 characters that can be used to identify the unit. By default the Unit identifier
is set to "UNNAMED".
The command line interface syntax consists of three parts, a module name, an action verb
and a variable set of action parameters. Each command is terminated by a carriage return.
[Module Name] < Action Verb > < Parameter List > [CR]
Although each module name or action verb may consist of several letters, only sufficient
letters to uniquely identify the module name or action verb are required. For example to enter
the module name LOCAL, only three characters LOC are required to differentiate it from the
module name LOGIC.
The module names are the same as the section names listed in section 6.1.
If a module name is entered without an action verb to follow, the command line focus enters
the module name given, for example the command: -
UNIT [CR]
Will cause the command line interface focus to enter the UNIT module, and the Command
line prompt will change to:
[UNIT IDENTIFIER]>>UNIT>>
When the Command line focus is within a specific module, then only the action verbs specific
to that module will be effective. To return focus to the highest level, use:
EXIT [CR]
A list of all the commands applicable to the current module can be obtained by:
HELP [CR]
Some commands allow multiple parameters. For example to set both KEY SET INHIBIT
DIGIT and KEY SET INHIBIT MEMORY, enter them together in one command by placing a +
sign between the parameters, as KEY SET INHIBIT DIGIT + MEMORY. Entering KEY SET
INHIBIT DIGIT and KEY SET INHIBIT MEMORY separately would cause the last entered
command to overwrite the earlier one.
Command parameters that can be combined in this way are indicated by a + sign following
their definition.
HISTORY[CR]
The history list is accessed using the up and down arrows on your keyboard.
In all of the following actions where the action is SET, the SET can be replaced with SHOW
along with the first parameter to display the individual configuration information.
Action Parameters
Comment
Verb 1 2
Sets the user name used in local or remote access to
be “UserName”. UserName can be up to 30
characters long, and can contain only the
alphanumeric characters a-z, A-Z , 0-9 . The default
value is “user”. The Username cannot be blank.
USERNAME UserName
IMPORTANT: The word ‘root’ is a reserved
username and must not be used or assigned a
password. Setting a user name of "root" will make it
SET
impossible to access the phone, and will require a
reset to factory defaults.
Sets the password used in local or remote access to
be “Password”. <Password> can be up to 30
PASSWORD <Password> characters long, and can contain only the
alphanumeric characters a-z, A-Z , 0-9 . The default
value is password.
Note: please make sure to record the user name and password securely. They will be
required to access the phone every time whether by web page, command line or
configuration file.
In the event that the username and password are lost, the unit will need to be reset to
factory defaults. This can be done by holding down a button on the main circuit board
or by a software command. See section 10.
Action Parameters
Comment
Verb 1 2 3
This command specifies if an alarm will be generated on
[ ON | OFF| assertion of an alarm condition only (ON) , on removal of the
REPORT
NONE] alarm condition only (OFF) or on either event (ON+OFF) or
not at all (NONE)
This command assigns alarm activation De-bounce Period to a
specific alarm number. The alarm event must be present at the
start and at the end of the de-bounce Period before the alarm
status will be signalled using e-mail or syslog messaging (If
ONTIME [0- 30000] enabled).
The period is specified in seconds and can take a value of 0 –
30,000. A value of 0 indicates that there is no de-bounce
period for this alarm type and a message will be generated
immediately the alarm event is detected.
This command assigns an alarm removal De-bounce Period to
a specific alarm number. The alarm event must be absent at
the start and at the end of the de-bounce period before the
ALARM[1- alarm clearance will be signalled using e-mail or syslog
SET
20] OFFTIME [0-30000] messaging (if enabled).
The period is specified in seconds and can take a value of 0 –
30,000. A value of 0 indicates that there is no de-bounce
period for this alarm type and a message will be generated
immediately the alarm event is detected.
This command replaces the default text message ALARM
∆<alarm_number> with the text entered as Parameter 3.
The text is delineated by Quote marks and is a maximum of 40
MSG “text”
characters. The status <on/off> is appended to the end of the
text. If the “text” value is blank , the default message is
reinstated.
This command enables or disables SYSLOG reporting for the
[ ON |
SYSLOG selected alarm number. This command will also set STATUS
OFF]
reporting if not already applied.
This command enables or disables SMTP reporting for the
[ ON |
MAIL selected alarm number. This command will also set STATUS
OFF ]
reporting if not already applied.
This command displays the current settings of the alarm
module. It also shows status information for the alarms.
An alarm can be :-
a) ON - the alarm is in the up condition
SHOW ALL b) OFF – the alarm is in the down condition
c) PENDING ON – the alarm has occurred but not
reached the end its de-bounce period
d) PENDING OFF- the alarm has been cleared but not
yet been signalled
Action Parameters
Comment
Verb 1 2
This command sets the destination unit IP
address and output number for a relay contact
that will be operated when the RECALL key is
RECALL xxx.xxx.xxx.xxx pressed. The command will be sent using an
extension to the proprietary protocol defined
for passing logic states.
(No implemented in first release)
If this parameter is set then all digit keys will
DIGIT +
be disabled during an emergency call.
If this parameter is set then all memory keys
MEMORY +
will be disabled during an emergency call.
INHIBIT If this parameter is set then any key will
CLEAR + capable of initiating a call clear be disabled
during an emergency call.
SET This command clears all key inhibit settings (
NONE
DEFAULT VALUE)
RELAY1ONCODE These codes set relays OUTPUT1 and
OUTPUT2 to activate on receipt of a matching
RELAY2ONCODE string of DTMF characters from the remote
party during a call. Outputs can be set to turn
RELAY1OFFCODE
ON, OFF or to PULSE for a fixed duration
XXXX[XX]
RELAY2OFFCODE below. Strings must be min 4 max 6
characters. Valid characters are 0-9, A-D, *,#.
RELAY1PULSECODE Blank disables. Default value blank.
RELAY2PULSECODE
RELAY1PULSELEN Duration in seconds that an output will remain
1-60 ON following receipt of a
RELAY2PULSELEN RELAYxPULSECODE. Range 1-60.
This command shows the current settings of
SHOW ALL the RECALL and INHIBIT settings and lists the
key map settings.
Action Parameters
Comment
Verb 1 2 3
HELPPOINT
MODE DDA
OFF
OFF
PULSE +
MUTE +
RING +
INBCALL +
CALL +
CONNECT + Refer to web page section for function
GENERATE
HOOK + descriptions
SET LED [1|2|3] INUSE +
RINGCADENCE +
PAGE +
REGISTERED +
EMERGENCY +
ON
TIMER XX
CADENCE ON:OFF
Shows the current settings of all the LED
SHOW ALL parameters
Action Parameters
Comment
Verb 1 2 3
This command lists the current settings of the memory dial
locations 1 – 20 and also lists the order of use of lists 1-10 and
SHOW ALL
the emergency list It also displays the values for the other
variables that can be configured in this module.
Action Parameters
Comment
Verb 1 2 3
Sets the IP address of the SNTP server to be
xxx.xxx.xxx.xxx
xxx.xxx.xxx.xxx or resolves the FQDN using DNS to
SNTP or
locate the host from which the phone obtains time
FQDN
data.
This command sets the current time zone for local
TIMEZONE XXXX time where XXXX is an abbreviation selected from
the time zone abbreviations in section 7.
Sets the format of the date to be either US style
FORMAT [US | UK]
MM/DD or UK style DD/MM. Default value is UK.
This command determines if the unit’s clock will
ADJUST ON/OFF automatically adjust to daylight saving time. The
default value is OFF
This command sets the value of the offset from the
SET current clock time applied when the DST period
OFFSET +/-HH:MM starts. Valid values for HH are 00 – 12 and for MM
they are 00 – 59. The default value is +01:00 ( 1
hour)
STARTDAY [0 – 31] If DST is active, these commands define when it
DST STARTDOW [1-7] starts and ends. Refer to Clock Settings web page
STARTMONTH [1-12] section for detailed explanation. The example file in
STARTWOM [1-6 | 8] Section 8 lists the commands to set DST to be active
ENDDAY [1-31] between 2am on the last Sunday in March until 2am
ENDDOW [1-7] on the last Sunday in October.
ENDMONTH [1-12]
ENDWOM [1-6 | 8]
STARTTIME HH:MM
ENDTIME HH:MM
Action Parameters
Comment
Verb 1 2
This command sets the order of preference that will be
used in the SDP by the phone, where A B C D E and F
CODEC A,B,C,D,E,F can have the values 1 -6 that corresponds to the CODECS
listed in the Audio web page section above.
Note VAD must be set to ON when using G.729 Codec.
10
G711
20
10 Set the sample period in ms. See 5.13
SAMPLE G722
20
10
G729
20
G7231 This command sets the number of audio sample periods or
| G722 “frames” per IP packet . See 5.13
FRAMES X
|G729
|G711
This command enables or disables the use of Voice
Activity Detection. This command is only valid for G723
VAD [ON | OFF ] and G729 Codec settings.
SET Note VAD must be set to ON when using G.729 Codec.
The default value is ON.
This command sets the transmission of DTMF digits to be
[ INBAND |
DTMF either in band or out of band. The default setting is
RFC2833 ]
OUTBAND, DTMF is transmitted using RFC 2833
Sets the payload type parameter in the RTP packets when
sending DTMF tones 'out-of-band' according to RFC2833.
DTMFPT [96-127]
The default value is 96, but should be changed to 101 for
compatibility when using Cisco CallManager™.
sets whether DTMF tones are heard in the earpiece when
DTMFPLAYBACK [ON|OFF]
digit buttons 0-9, * or # are pressed. Default value OFF.
HANDSETGAIN These commands specify the various gains and volumes.
HANDSETVOLUME Refer to Audio settings web page section for definitions
LINEGAIN and acceptable value ranges.
LINEVOLUME
XX
RINGERVOLUME
HANDSFREEGAIN
HANDSFREEVOLUME
SHOW ALL Lists all the configuration settings for the Audio module
Action Parameters
Comment
Verb 1 2 3
This command sets the frequency (or frequency pair)
[1-10] referenced in parameter 3 for the Tone
FREQ [1-13]
referenced in parameter 1. See Tone Settings web
page section (5.15) for detailed explanation.
SET
TONE[1-10] This command sets up the timing for the cadence
period referenced in parameter 2 with the value X
[ON1 | ON2 | ON3 | where X is an integer value between 0 and 600 that is
X
OFF1 | OFF2 | OFF3] equivalent to the period’s time in 25ms increments.
See Tone Settings web page section (5.15) for
detailed explanation.
This command displays the current settings of all the
SHOW ALL
tone parameters.
This command sets the pulse timer value for Volt free contact
output 1 or 2 to be XX. XX is specified in seconds and can
TIMER XX have a value in the range 0 -3600. Default value is 3 seconds.
Action Parameters
Comment
Verb 1 2 3
Sets the IP address of the primary SMTP server to be
xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx or uses the FQDN to resolve the IP
or address through DNS. E-mail will be sent on assertion
FQDN of an alarm condition via the primary server if
SERVER1
configured.
or
SERVER2 Sets the IP address of the secondary SMTP server to
xxx.xxx.xxx.xxx be xxx.xxx.xxx.xxx or uses the FQDN to resolve the IP
or address through DNS. E-mail will be sent on assertion
FQDN of an alarm condition via the secondary server if
configured.
SET TOADDRESS Sets the To: Address
CCADDRESS [email protected] Sets the CC: Address
FROMADDRESS Sets the FROM: Address
Set the contents of the subject field to be “SubjectText”.
The Subject Text field can be up to 50 characters in
SUBJECT “SubjectText”
length, and can contain any printable character except
double quotes.
OFF This command disables the sending of SMTP alerts
This command enables the sending of SMTP alerts if
ON the above server settings and addresses are
configured
SHOW ALL
Action Parameters
Comment
Verb 1 2 3
This command shows the current call status, the state
SHOW ALL of all auxiliary inputs and logic outputs, and the
registration status of the 4 SIP proxies and registrars
Action Parameters
Comment
Verb 1 2 3
sets an enforced delay (in seconds) between one
TIMEOUT [1-120] Multicast session ending and another beginning.
Range 1-120. Default 120
sets the speaker volume during a multicast. Volume
SPEAKERV will revert to the setting on the AUDIO page when the
1-10
OLUME multicast session has ended. Range is 1 to 10, default
value 3.
OVERRIDE 0-8 Priority level. See section 5.18.
ADDRESS xxx.xxx.xxx.xxx:pppp Multicast address, must include multicast port.
Sets a range of acceptable multicast source IP
SET addresses. The phone will only accept a multicast if
FILTER xxx.xxx.xxx.xxx:xxx.xxx.xxx.xxx the source is within this IP address range. The format
is 2 IP addresses separated by a colon. The default
is 0.0.0.0:255.255.255.255
PRIORITY [1-8] [0-8] Priority level. See section 5.18.
sets if OUTPUT1 is ENABLED or DISABLED during
OUTPUT1
this multicast
sets if OUTPUT2 is ENABLED or DISABLED during
OUTPUT2 [ENABLED | DISABLED]
this multicast
sets if tone 10 (TONES page) is ENABLED or
TONE
DISABLED during this multicast.
SHOW ALL
IMPORTANT: This function will overwrite ALL previously configured fields with the values
that were set at factory time. This may mean that the unit will cease to function properly until it
is reconfigured.
Reset
button
NOTE: on Titan and handsfree telephones the main PCB is covered by a plastic backbox
secured by 4 screws. Carefully remove the screws and backbox to expose the circuit boards
underneath.
With the unit powered up (heartbeat flashing), hold the reset button in for 5 seconds, then
release.
The unit will reboot and all configuration settings will revert to factory defaults.
Password : "password"
IP address ; 192.168.1.2 (static)
Net mask : 255.255.0.0
Units upgraded to v3 in the field will normally not have this function enabled. Units originally
shipped with v1 or v2 must be returned to factory to have this function enabled.
For Titan and handsfree telephones, carefully replace the backbox replacing the 4 screws.
On Titan models, when replacing the backbox, take care to seat the cables correctly in their
channels as shown.
ADDITIONAL HOOK
SWITCH CABLE
(CHANNEL 4)
OPTIONAL
RINGER CABLE
(CHANNEL 3)
HOOK SWITCH CABLE
HANDSET CABLE (CHANNEL 2)
(CHANNEL 1)
11. Troubleshooting
This is a list of the more common problems and solutions. If your problem is not shown here
check the website for more recent updates, or contact GAI-Tronics for support.
Module License
u-boot GPL V2
Linux kernel GPL V2
Busybox GPL V2
Opal/PWLib Mozilla Public License V1.1
Modutils GPL V2
MTD GPL V2
NTP David L. Mills Copyright Notice
These licence and copyright notices are available in full from our website at
www.gai-tronics.co.uk/voipsupport.htm