Zone 1 / zone 21 ex certified hazardous area voip telephone (29 pages)
Summary of Contents for Hubbell GAI-TRONICS 1193
Page 1
GAI-TRONICS A division of Hubbell Ltd VoIP Telephones Configuration Guide: Firmware versions: 1193 Telephones: v1.08 1201 Telephones (Auteldac 6): v1.08 Document Ref: 502-20-0171-001, GAI-ENG-568 Iss 6. Nov 2020.
Page 2
TRADEMARKS and LICENCES All product and brand names are trademarks of their respective owners. Software licences and notices are available on the GAI-Tronics website at www.hubbell.com/gai-tronics/en/voip-support 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 Contents Introduction ......................... 5 Models supported ....................... 6 How the product is intended to work .................. 6 Operating Sequence....................6 Dictionary of terms ..................... 7 Setting up and Configuring the Telephones............... 9 Web Page Structure ....................9 Quick Start .......................
Page 4
GAI-TRONICS Structure of files used in the update process ............70 8.1.1 Update control file ....................70 8.1.2 Configuration file ....................70 8.1.3 Firmware and boot files ..................71 TFTP update process ....................71 8.2.1 TFTP Upgrade Example ..................72 SNMP ..........................
There are significant changes to the configuration commands and web pages from those in first generation products. Configuration guides for previous versions will remain available on the GAI-Tronics UK website (www.hubbell.com/gai-tronics/en/voip-support) as a reference for earlier versions. 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.
GAI-TRONICS Models supported This guide applies to products containing the 999-02-1193-xxx VoIP PCB or the 999-02-1201- xxx Auteldac 6 PCB How the product is intended to work The VoIP telephone has been designed to mimic the behaviour of a traditional, analogue telephone, specifically based on the GAI-Tronics range of rugged telephones, to give continuity where VoIP and analogue units are used in similar situations.
GAI-TRONICS • Call terminates when the called party hangs up or if an ON/OFF button is pressed. Receiving a call (with autoanswer OFF. See below for the behaviour when each different autoanswer mode is enabled) • Ringing heard from speaker •...
Page 8
GAI-TRONICS 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.
GAI-TRONICS Setting up and Configuring the Telephones. Each telephone must be configured for use on the intended network. Most models have memory-dial locations, which will need to be set up. The telephone also has a range of customisable features. All of these can be set up using one of 3 different methods: •...
Page 10
GAI-TRONICS Main pages Position in tree structure Sub pages The list of sub-pages down the left-hand side changes according to the main page selected from the main page bar. The example above shows the Accounts sub-page within the System main page. The current position in the web page structure is shown below the main page bar.
Page 11
GAI-TRONICS Accounts Date/Time Network Configuration DNS Configuration Remote Configuration Access Update Parameters System Phone Maintenance System Identification Fault Log Configuration Input/Output Configuration Audio Path Test VoIP Account Information [1-4] VoIP Accounts VoIP Provider Defaults Audio settings VoIP Parameters RTP Protocol Parameters Configuration Registration Settings SIP Protocol Parameters...
GAI-TRONICS Quick Start The factory defaults will generally be sufficient in most cases, but the following steps must be taken as a minimum: • Provide an Ethernet connection and power (either 24-48Vdc or PoE) • Ensure that a DHCP server is available on the network, and that the IP address allocated to the telephone can be discovered (DHCP is the normal factory default provisioning method).
Page 13
GAI-TRONICS System Accounts phone user name Description: User configuration access name Basic or advanced: Basic Range check: 1 to 15 chars Default value: user Default value differs with model variant? : N Config file parameter name: phone_user_name System Accounts phone user password Description: User password Basic or advanced: Basic...
Page 14
GAI-TRONICS phone time zone Description: Local time zone difference from GMT (in hours) Basic or advanced: Basic Range check: -12 to 13 Default value: 0 Default value differs with model variant? : N Config file parameter name: phone_time_zone System Date/Time phone time zone minutes Description: Sets the current time zone minutes (used in conjunction with phone time zone...
Page 15
GAI-TRONICS Fully qualified domain name (including an optional port number) for the NTP/SNTP timeserver server. Reboot required after update. Basic or advanced: Basic Range check: Default value: Default value differs with model variant? : N Config file parameter name: phone_timeserver_domain_name System Network Configuration net static ip address...
Page 16
GAI-TRONICS Enable use of DHCP for automatic local IP address configuration Basic or advanced: Basic Range check: enabled / disabled Default value: enabled Default value differs with model variant? : Y Config file parameter name: net_isp_dhcp_enable System Network Configuration net isp dhcp discover duration (s) Description: The period of time for which the telephone will continue to try to request an IP address via DHCP.
Page 17
GAI-TRONICS Manually configured IP address of backup domain name server (DNS). Reboot required after update. Basic or advanced: Basic Range check: Default value: 0.0.0.0 Default value differs with model variant? : N Config file parameter name: net_dns_secondary_address System Remote Configuration Access phone web external server enable Description: Enable access to configuration procedures from external IP addresses...
Page 18
GAI-TRONICS Basic or advanced: Basic Range check: Default value: Default value differs with model variant? : N Config file parameter name: phone_update_domain_name System Update Parameters phone update control file Description: Name of the update control file used for TFTP download. See section 8 Basic or advanced: Basic Range check: Default value:...
Page 19
GAI-TRONICS Range check: enabled / disabled Default value: enabled Default value differs with model variant? : N Config file parameter name: phone_configuration_update_on_reset System Update Parameters phone configuration update periodic delay Description: Periodic delay in seconds between configuration update checks Basic or advanced: Basic Range check: Default value: 3600 Default value differs with model variant? : N...
Page 20
Description: Link to tech documentation for the product Basic or advanced: Basic Range check: max 128 chars Default value: https://www.hubbell.com/gai-tronics/en/voip-support Default value differs with model variant? : N Config file parameter name: phone_help_url VoIP Telephone Configuration Guide Page 20 of 78...
Page 21
GAI-TRONICS System Phone Maintenance net syslog enable Description: Control to enable transmission of SYSLOG messages. Used by GAI-Tronics TMA monitoring software, see section 11. Basic or advanced: Basic Range check: enabled / disabled Default value: disabled Default value differs with model variant? : N Config file parameter name: net_syslog_enable System Phone Maintenance...
Page 22
GAI-TRONICS System Phone Maintenance net syslog severity Description: Sets the SYSLOG message severity level, as per RFC3164. Used by GAI- Tronics TMA monitoring software, see section 11. Basic or advanced: Basic Range check: max 11 chars Default value: 5 Default value differs with model variant? : N Config file parameter name: net_syslog_severity System Phone Maintenance...
Page 23
GAI-TRONICS snmp community 2 Description: SNMP community string 2, see section 9 Basic or advanced: Basic Range check: max 64 chars Default value: private Default value differs with model variant? : N Config file parameter name: snmp_community_2 System Phone Maintenance snmp community 2 access Description: Access level for SNMP community 2, see section 9...
Page 24
GAI-TRONICS Communty string for SNMP traps, see section 9. Basic or advanced: Basic Range check: max 63 chars Default value: public Default value differs with model variant? : N Config file parameter name: snmp_trap_community System System Identification phone copyright notice Description: Software copyright notice, Including current firmware version Basic or advanced: Basic...
Page 25
GAI-TRONICS Default value: Default value differs with model variant? : N Config file parameter name: phone_board_type System System Identification phone board serial number Description: Main PCB serial number. Factory assigned. Basic or advanced: Basic Range check: view only Default value: Default value differs with model variant? : N Config file parameter name: phone_board_serial_number System...
Page 26
GAI-TRONICS System System Identification phone firmware revision Description: Read from the last loaded update control file. Used by the phone to control whether a firmware update is needed. See section 8.1.1. Note this may not be the actual firmware version, which is displayed in the copyright notice above. Basic or advanced: Basic Range check: view only Default value:...
Page 27
GAI-TRONICS System System Identification net unique device id Description: Unique device ID including Ethernet MAC used for DHCP and update operations. Factory set, not editable. Basic or advanced: Basic Range check: view only Default value: Default value differs with model variant? : N Config file parameter name: net_unique_device_id System System Identification...
Page 28
GAI-TRONICS snmp system location Description: snmp system location, see section 9 Basic or advanced: Advanced Range check: Default value: Default value differs with model variant? : N Config file parameter name: snmp_system_location System Fault Log Configuration fault status mask Description: Coded representation of diagnostic faults.
Page 29
GAI-TRONICS Prefix to fault log file name. filenames are in the format: prefix + yymmddhhmmss.log. See section 10 Basic or advanced: Basic Range check: max 63 chars Default value: Default value differs with model variant? : N Config file parameter name: fault_log_prefix System Fault Log Configuration fault log ftp server domain...
Page 30
GAI-TRONICS Basic or advanced: Basic Range check: max 63 chars Default value: Default value differs with model variant? : N Config file parameter name: fault_log_ftp_server_password System Fault Log Configuration fault log ftp server folder Description: Folder path on FTP server for fault logs. See section 10 Basic or advanced: Basic Range check: max 127 chars Default value:...
Page 31
GAI-TRONICS Range check: max 127 chars Default value: 0 0 0 0 0 0 0 0 Default value differs with model variant? : Y Config file parameter name: led_relay_map_string System Input/Output Configuration button map string Description: Defines button and input functions. See code explanations, section 4.5.2 Basic or advanced: Basic Range check: max 127 chars Default value: 2m1 2m2 2m3 1c1 1c2 1c3 1c4 1c5 1c6 1c7 1c8 1c9 1c* 1c0 1c#...
Page 32
GAI-TRONICS Range check: enabled / disabled Default value: disabled Default value differs with model variant? : N Config file parameter name: apt_now System Audio Path Test apt time Description: Time of day (24h format hh:mm:ss) to perform an automatic audio path test. See section 6.
Page 33
GAI-TRONICS Default value differs with model variant? : N Config file parameter name: apt_ok_count System Audio Path Test apt low threshold Description: Minimum difference between silence and tone levels to be considered a pass. See section 6. Basic or advanced: Advanced Range check: 1000 to 10000 Default value: 3000 Default value differs with model variant? : N...
Page 34
GAI-TRONICS System Audio Path Test apt output level Description: Test tone level. See section 6. Basic or advanced: Advanced Range check: 1 to 30000 Default value: 11000 Default value differs with model variant? : N Config file parameter name: apt_output_level System Audio Path Test apt status...
Page 35
GAI-TRONICS apt last test ok count Description: Details of last audio path test. See section 6. Basic or advanced: Basic Range check: view only Default value: Default value differs with model variant? : N Config file parameter name: apt_last_test_ok_count System Audio Path Test apt last test passed count Description:...
Page 36
GAI-TRONICS Details of last audio path test. See section 6. Basic or advanced: Advanced Range check: view only Default value: Default value differs with model variant? : N Config file parameter name: apt_last_test_silence System Audio Path Test apt last test tone Description: Details of last audio path test.
Page 37
GAI-TRONICS Default value: Default value differs with model variant? : N Config file parameter name: apt_last_test_high_threshold VoIP Accounts VoIP Account Information 1 provider name Description: Provider or server name for identification purposes. Not used by SIP. Parameters for VoIP Acccount 1 are repeated for providers 2, 3 and 4 Basic or advanced: Basic Range check: Default value:...
Page 38
GAI-TRONICS Default value: Default value differs with model variant? : N Config file parameter name: _voip_provider_1.registration_state VoIP Accounts VoIP Account Information 1 display name Description: Holds the display name that will be displayed to other SIP clients if making an IP call Basic or advanced: Advanced Range check:...
Page 39
GAI-TRONICS Default value differs with model variant? : N Config file parameter name: _voip_provider_1.auth_user_name VoIP Accounts VoIP Account Information 1 auth user password Description: Specifies the password to use for authentication purposes Basic or advanced: Basic Range check: Default value: Default value differs with model variant? : N Config file parameter name: _voip_provider_1.auth_user_password VoIP Accounts...
Page 40
GAI-TRONICS Default value: Default value differs with model variant? : N Config file parameter name: _voip_provider_1.register_domain_name VoIP Accounts VoIP Account Information 1 reregister interval Description: Sets the default registration update period Basic or advanced: Advanced Range check: Default value: 3600 Default value differs with model variant? : N Config file parameter name: _voip_provider_1.reregister_interval VoIP Parameters...
Page 41
GAI-TRONICS Default value differs with model variant? : N Config file parameter name: voip_dtmf_transmit_method VoIP Parameters Audio Settings voip aec enable Description: Enables acoustic echo cancellation Basic or advanced: Advanced Range check: enabled / disabled Default value: disabled Default value differs with model variant? : Y Config file parameter name: voip_aec_enable VoIP Parameters RTP Protocol Parameters...
Page 42
GAI-TRONICS VoIP Parameters RTP Protocol Parameters rtp jitter buffer start depth Description: Jitter buffer depth at startup in msec Basic or advanced: Advanced Range check: 0 to 500ms Default value: 0 Default value differs with model variant? : N Config file parameter name: rtp_jitter_buffer_start_depth VoIP Parameters RTP Protocol Parameters rtp jitter buffer minimum depth...
Page 43
GAI-TRONICS SIP Parameters SIP Protocol Parameters sip user agent Description: User-Agent header for outbound responses. Factory set to include firmware version. Basic or advanced: Advanced Range check: max 95 chars Default value: GAI-Tronics IP Phone Default value differs with model variant? : N Config file parameter name: sip_user_agent SIP Parameters SIP Protocol Parameters...
Page 44
GAI-TRONICS SIP Parameters SIP Protocol Timers sip timer no answer duration Description: sets the maximum length of time in seconds that the phone will ring on an outgoing call before either failing over to the next in the list or timing out. A value of 0 disables the timer.
Page 45
GAI-TRONICS IPBX Parameters Call Progress Patterns ipbx pattern ring 2 Description: Set the activation pattern (or cadence) for outputs assigned with incoming "ring 2" function. Refer to section 4.5.5 Basic or advanced: Advanced Range check: max 64 chars Default value: 1 0 Default value differs with model variant? : N Config file parameter name: ipbx_pattern_ring_2 IPBX Parameters...
Page 46
GAI-TRONICS IPBX Parameters Call Progress Patterns ipbx pattern connect Description: Set the activation pattern (or cadence) for outputs assigned with the "connect" function. Refer to section 4.5.5 Basic or advanced: Advanced Range check: max 64 chars Default value: 1 0 Default value differs with model variant? : N Config file parameter name: ipbx_pattern_connect IPBX Parameters...
Page 47
GAI-TRONICS Config file parameter name: ipbx_call_progress_1_priority_hook IPBX Parameters Call Progress 1 Information ipbx call progress 1 priority ring 1 Description: Set priority for hook output. There are 6 call progress information pages, with the parameters ipbx_call_progress_1_priority_ring_1 to ipbx_call_progress_6_priority_ring_1. See section 4.5.5 for full details. Basic or advanced: Advanced Range check: max 64 chars Default value: 2...
Page 48
GAI-TRONICS Basic or advanced: Advanced Range check: max 64 chars Default value: 0 Default value differs with model variant? : N Config file parameter name: ipbx_call_progress_1_priority_ring_out_2 IPBX Parameters Call Progress 1 Information ipbx call progress 1 priority in use Description: Set priority for hook output.
Page 49
GAI-TRONICS Set priority for hook output. There are 6 call progress information pages, with the parameters ipbx_call_progress_1_priority_emergency to ipbx_call_progress_6_priority_emergency. See section 4.5.5 for full details. Basic or advanced: Advanced Range check: max 64 chars Default value: 0 Default value differs with model variant? : N Config file parameter name: ipbx_call_progress_1_priority_emergency IPBX Parameters Timers...
Page 50
GAI-TRONICS ipbx timeout no answer drop duration Description: Sets the maximum time in seconds that the phone will ring on an incoming call before ending it. A value of 0 disables the timer, meaning that the phone will ring until answered or the call is ended either by the caller or the server. Basic or advanced: Advanced Range check: 0 to 65535 Default value: 0...
Page 51
GAI-TRONICS Description: Call disconnect tone pattern. See code explanations, section 4.5.8. Basic or advanced: Advanced Range check: Default value: 2 2 0 480 -19 620 -19 500 500 Default value differs with model variant? : N Config file parameter name: ipbx_call_disconnect_tone Regionalisation Call Progress Tones ipbx busy tone...
Page 52
GAI-TRONICS Basic or advanced: Advanced Range check: Default value: 2 4 0 3380 -10 20 -10 400 200 400 2000 Default value differs with model variant? : Y Config file parameter name: ipbx_call_ring_default_tone User Configuration Speed Dials ipbx speed dial [1-20] Description: Speed dial entries.
Page 53
GAI-TRONICS Controls the automatic answering of the phone for an incoming call: 0 = Off / 1 = Preceeding Tone / 2 = Silent Answer / 3 = Babyphone mode / 4 = Page Mode. See section 3.1 Basic or advanced: Basic Range check: 0 to 4 Default value: 0 Default value differs with model variant? : Y...
Page 54
GAI-TRONICS Description: For products with a handset, modifies the earpiece level in 10 steps, where each step is approx 2dB. If the product has a volume step control, this sets its starting point for each new call. Normally leave at default. Basic or advanced: Basic Range check: 0 to 9 Default value: 4...
GAI-TRONICS Description: Sets level of sidetone, if enabled. Range is 0 to 128, where 0 is the loudest setting. Basic or advanced: Basic Range check: 0 to 128 Default value: 0 Default value differs with model variant? : N Config file parameter name: sidetone_level Phone Configuration Phone Audio Settings headset mic gain...
GAI-TRONICS 4.5.1 Codecs There are 3 audio codecs available, coded as follows: G.711a = 8 G.711u = 0 G.729 = 18 Codecs required are entered in the desired preference order, separated by spaces. For example, to use G.711a as the 1st preference and G.711u as the 2nd preference, the string should be entered as just: 4.5.2 Button map string The button map string defines the functions of all available pushbuttons and keypad keys,...
Page 57
GAI-TRONICS Each assigned code consists of 1 or more text characters defined below Each button or input may have one of the following functions: 0 - None 1 - Digit 2 - Memory dial 3 - PTT / mute (see important note below) 4 - Redial 5 - Volume 6 - Hook...
GAI-TRONICS In this example, a button (or input) assigned as memory 1 will first attempt to call speed dial 1. If that fails, it will attempt speed dial 2; if that fails speed dial 3 and if that fails it will abandon the call.
Page 60
GAI-TRONICS These options are set using 2 groups of settings: • Patterns, on the IPBX Parameters / Call Progress Patterns page, where each stage of call progress is assigned a pattern or cadence, and • Priorities, on the IPBX Parameters / Call Progress information pages, where patterns are assigned to ouputs with a priority sequence.
GAI-TRONICS The example below shows an output set to activate during ring (pattern 2), or when a call is connected, or when the telephone is registered. In this example, if the phone is ringing, then the pattern assigned for “ring2” will be used as the priority.
GAI-TRONICS The full set of characters used to build input pattern rules is set out below (note that all letters are lower case) Parameter Description "e" specify ending termination digit which follows (usually * or #). Note, if used, this parameter must occur first in any rule pattern "t"...
GAI-TRONICS The full rules for specifying custom tones are presented below these tables. These coding rules apply to all the possible tones on the Call Progress Tones page. Note that “ring tones” are tones made by the telephone on an incoming ring, whereas “ringback tone”...
GAI-TRONICS Possible values for frequency are between 0-3000Hz. Possible values for dB levels are between –1 to –40 dB. The maximum number of tones is 4. The maximum number of on and off times counted individually is 9. For example, the default setting for initial dial tone (UK and US) is 2 0 0 350 -19 400 -19. “2” is the number of tones.
GAI-TRONICS If the phone is unable to register or make a call it can fail over to the next account in a prioritised sequence. The accounts are organised in priority order such that VoIP account 1 is the highest priority. There is also a parameter named voip multiple registration mode which sets whether multiple proxies and registrars are used serially or concurrently.
GAI-TRONICS • apt last test count shows the number of individual tests carried out the last time a test was run • apt last test ok count shows the value of apt test ok count the last time a test was run •...
GAI-TRONICS • Within 5 seconds of releasing the Reset button (ie whilst the reboot is in progress), press and hold the “Factory” button for at least 10 seconds. • The telephone will then reboot once more and be restored to its original configuration. Note that any settings or changes made via webpages or configuration upload will be lost.
GAI-TRONICS Structure of files used in the update process 8.1.1 Update control file The update control file is a plain text file containing a maximum of 7 lines (not including comments). Comments are lines starting with #. A typical file could be: # Upgrade Titan telephones to v 2.1.00 server=192.168.9.253 bootfile=1193boot1_0.ece...
GAI-TRONICS The web page permission string is one of the following values: Permission Basic level Advanced level User view only &3e0 &23e0 User edit &3f0 &23f0 The value to assign is preceded by an equal sign (“=”). If the value is a text string it is entered exactly as intended, including any spaces, and without any delimiters or quote marks.
GAI-TRONICS 8.2.1 TFTP Upgrade Example This is an example showing a firmware update. In this example the phone is 192.168.9.3, and the TFTP server is 192.168.9.128. 1. Copy the firmware files onto the TFTP server and add the control file. In this example the update control file is called update1193.txt.
Page 73
GAI-TRONICS 5. Set the update parameters to use the TFTP server. Set update domain name to the server address, firmware update enable, firmware update now. Then press update. 6. Check the TFTP server to prove that it has downloaded the control file and then the firmware files.
GAI-TRONICS 7. Check the firmware version has changed. Now shows 1.08.00. 8. Note that the phone copyright notice (at the top of the System Identification page) shows the actual current version of the firmware, regardless of what was in the update control file.
GAI-TRONICS • Snmp community 2 • Snmp community 2 access • Snmp trap enable -> enabled (this parameter is disabled by default) • Snmp trap server (to be the IP address of the remote server receiving SNMP traps) • Snmp trap community Maintenance Maintainence requires the use of the correct MIB file.
GAI-TRONICS • TMA (see section 11) The faults reported are the same for all methods. The web page (Fault Log Configuration) shows a fault status mask and a fault clear mask. The fault status mask is a text representation of an 8-digit hex number, where each digit can be between 0 and f, representing the state of up to 4 fault sensors.
Page 78
GAI-TRONICS [including the GNU Public Licence.] SNMP Copyright 1988, 1989 by Carnegie Mellon University All Rights Reserved Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of CMU not be used in advertising or publicity pertaining to distribution of the...
Need help?
Do you have a question about the GAI-TRONICS 1193 and is the answer not in the manual?
Questions and answers