5100 System - VSCPU. Firmware Changes and New Feature Descriptions for Compatible (R4.99) and Enhanced (R5.xx) Modes

Transcription

1 5100 System - VSCPU Firmware Changes and New Feature Descriptions for Compatible (R4.99) and Enhanced (R5.xx) Modes

2 1. OVERVIEW COMPATIBLE MODE (PHASE I FEATURES) FIRMWARE VERSION WINDOWS 5100 INSTALLATION TOOL PLACING THE SYSTEM INTO COMPATIBLE MODE LAN CONNECTIVITY Setup for LAN Connectivity EPANDED SMDR MESSAGES PROGRAMMABLE VOICE CHIP MODULE Setup Normal Use Customizing the System Voice Chip Programmer Software Protected Phrases Connections Male/Female Voice Custom Voice Phrases Custom Tones INSTALLATION TOOL UPDATES COMPATIBLE MODE Defaults Tone Preview CLOCK (VSSER) CARD UPDATES Sync-wired clocks: Generator Control Correction Due to System Time Change Dial Codes for Manual Clock Control ENHANCED MODE (PHASE II FEATURES) FIRMWARE VERSION WINDOWS 5100 INSTALLATION TOOL PLACING THE SYSTEM INTO ENHANCED MODE AUDIO (PAGE) GROUPS ENHANCED CLID NAMED SCHEDULES AND GROUPS VSST BOARD SMDR DAYLIGHT SAVINGS TIME ADMIN FORCED DISCONNECT PROGRAMMABLE VOICE CHIP MODULE Schedules Alert Tones Room Number Announcement Voice Phrase Dial Codes Play a Recorded Phrase Offhook Mode Play a Recorded Phrase, with Queue and Repeat (R5.11 or greater) Cancel a Phrase (R5.11 or greater) Clear the queue (R5.11 or greater) Using an Input to Play a Phrase Voice Phrase Programming Setup VSINT BOARD RELAYS VSURI BOARD RELAYS EMERGENCY TONES SERIAL PORT Modems Direct Connect ADDITIONAL ENHANCED MODE FEATURE CHANGES

3 3.17. ENHANCED MODE DIALING PLAN PROGRAMMABLE SCHEDULED EVENT PRIORITY AUTOMATIC INTERNET TIME SYNC Description Dial Codes Programmable data: Additional Information ADMIN TOOL FIRMWARE UPDATE R5.20 DIALING PLAN COMPATIBILITY APPENDICES APPENDI 1 LAN PROGRAMMING SETUP Install the VCS IP Setup Tool Gather Network Information Connect to the LAN Configure the IP Tool s Subnet Information Program the Network Parameters Changing the System s IP Number LAN Connection - Current IP Number or Subnet is Known Serial Connection VCS IP Setup Tool Hyperterminal LAN Factory Defaults VCS IP Setup Tool Minimum System Requirements APPENDI 2 - LAN CONNECTION TO SYSTEM SMDR View SMDR over LAN UDP to SYSLOG Server Setup To View UDP SYSLOG SMDR Data Multicast Broadcast Setup To View Multicast SMDR Data APPENDI 3 - SMDR FORMAT APPENDI 4 - SYSLOG FORMAT APPENDI 5 VOICE CHIP PROGRAMMING UTILITY General Hardware Requirements Starting the Voice Chip Programmer Connections Importing Data into the 5100 Installation Tool Protected Phrases Updating the System with Voice Phrase Changes Voice Chip Programmer Tool Specifics Main Window Load VC Image File Save VC Image File Read / Write VC Unit Print VC Image Data Close Main Window Message (Phrase) Options Preview Edit Delete Import WAV Export WAV Edit Message Window Message Name Recording level meter

4 Record / Stop Play / Stop OK Cancel Make Silence Settings VC Unit Communications Window Com: Port Baud Rate Read Unit Write Unit Sectors Modem Status Status Bar Advanced Options Additional Resources Required Messages REVISION HISTORY November 9, October 13,

5 5100 System - VSCPU Firmware Changes and New Feature Descriptions for Compatible (R4.99) and Enhanced (R5.xx) Modes 1. Overview The 5100 System has been improved and upgraded in a two-phase development effort. During Phase I, circuitry was redesigned and board components consolidated in order to ensure uninterrupted support and greater system reliability. The Phase I VSCPU provides equivalent functionality (drop-in replacement) as the older design. The functionality of the Phase II VSCPU, built upon the new Phase I hardware, has been significantly enhanced to address market requirements and competitive pressures. Phase II functionality improvements are primarily software-driven

6 2. Compatible Mode (Phase I Features) The new hardware and firmware are compatible with existing R4.xx Systems Firmware Version Firmware version for the Compatible mode displays as R4.99. (Windows Tool: Transfer / System Data / System Information ) Windows 5100 Installation Tool The R4.99 system is fully compatible with the existing R1.00 Windows 5100 Installation Tool Placing the System into Compatible Mode The VSCPU board ships in R4.99 (Compatible) mode. A system that is in Enhanced mode may be restored to Compatible mode by reloading system defaults. Defaults may be loaded using the R2.xx Windows 5100 Installation Tool, or by booting with a jumper on JP11 of the VSCPU board the jumper must be removed after defaults are loaded, or user programmed data will not be saved during a power interruption LAN Connectivity The user programming may now be transferred to/from the 5100 System via a LAN, without requiring a serial to LAN adapter. The system must be set up for each specific LAN. To do this you need to install and use the IP Setup Tool. The LAN System Administrator will need to provide the following site information before you can use the Tool to set up the 5100 System: IP address to be assigned to the 5100 System Subnet mask Gateway address Setup for LAN Connectivity Refer to Appendix 1 LAN Programming Setup 2.5. Expanded SMDR messages Virtually all activity within the system is now indicated in the SMDR output

7 2.6. Programmable Voice Chip Module This Module is built into the VSCPU board, and replaces the functionality of the voice chips used in the existing version of the VSCPU, which have reached end-of-life. In Compatible mode the Module is used for playing existing phrases (numbers) and to allow two custom (user recordable) tones: 5 - High/Low, and 6 - Warble Setup Normal Use No setup is required for normal use Customizing the System Voice Chip Programmer Software The Voice Chip Programmer (VCMessageUtil.exe) is a Windows Tool used to edit or record phrases for the Voice Chip Module, and to transfer the voice chip image file (.VCI) to/from the system. The program also has an option to import professionally recorded (8k, 8 bit ulaw) files Protected Phrases The voice chip may be programmed with up to 127 phrases. Phrase numbers 1-63 are programmed from the factory, and default to read only in the Voice Chip Programmer, because they are usually needed for normal system operation. Phrase numbers are available for custom phrases. If it is desired to allow an advanced user to change phrases 1-63, use a text editor (such as Notepad) to change the first line in EDITO63.txt to ALLOW. For a typical installation, EDITO63.txt will be found in: c:\program Files\Valcom\VCMessageUtil Connections To use the Voice Chip Programmer to transfer a.vci file you must connect a NULL Modem cable between a PC serial port and the rear DB9 connector on the VSCPU board. The standard VCS programming cable may be used. If the standard VCS programming cable is used, the end with the right-angle connector, marked VCS, must be connected to the VSCPU board. Note the Voice Chip Programming port is not the VSCPU port used for normal direct connect or modem programming. Also note the voice data image file can not be transferred via a LAN Male/Female Voice The program ships with voice chip image files for a male and a female voice. System default is the female voice

8 Custom Voice Phrases Using the VCMessageUtil program, and with the appropriate recordings, the Installer may create files with any desired voice, accent, or language Custom Tones Two tone fragments are included in the default data files, as message numbers 62 and 63. A fragment is the unique portion of a tone, that, when repeated without pause, sounds like a continuous tone. The fragments included are used to create the system High/Low and Warble tones. By recording or generating new tone fragments for messages 62 and/or 63, the High/Low and Warble tones may be customized to meet the needs of a particular installation

9 Installation Tool Updates Compatible Mode Defaults Admin auto-answer is now enabled in a default system Tone Preview The Add/Edit event screen now includes a way for the user to preview system tones (a sound card and media player software are required to preview tones) 2.8. Clock (VSSER) Card Updates The new release of the VSSER firmware (R4.00) incorporates the following changes: Sync-wired clocks: Added power-fail correction, DST correction, and manual control of sync-wired clocks Generator Control Added Generator control on the K2 relay for clock types 1 and Correction Due to System Time Change Removed clock corrections for a system time change except in the case of a change of exactly one hour, in which case we perform the correction assuming it is due to a DST change Dial Codes for Manual Clock Control #94 00 will advance sync-wired clocks one hour. Command may be repeated as needed. # will advance impulse clocks 01 to 98 minutes as in existing systems. #94 99 is reserved used for firmware testing

10 3. Enhanced Mode (Phase II Features) Enhanced mode provides an expanded set of features. The Enhanced mode features are set up and managed with a new version of the Windows 5100 Installation Tool Firmware Version The firmware version for Enhanced mode displays as R5.00 or above. Not all versions of R5.xx support all the features listed below. The 5100 Installation Tool provides information on the firmware revision level required for certain features. Check you version by connecting to the system through the 5100 Installation Tool and selecting: Transfer / System Data / System Information Windows 5100 Installation Tool The R5.xx system requires a new Windows 5100 Installation Tool, R2.01 or above. The existing R1.00 Tool will not read Enhanced system files, and will not communicate with an Enhanced Mode system. The new 5100 Installation Tool may be used with both R4.xx and R5.xx systems, and will read and write both the Compatible and Enhanced file formats The new 5100 Installation Tool provides the installer with an option to update existing data files to the new format, for use with R5.xx systems. This action is not reversible. The Enhanced system files created by the R2.01 Tool are not compatible with the R1.00 Tool, or with pre R5.00 VSCPU boards. The 5100 Installation Tool is updated as features are added to the system. Not all versions of the Tool will support all the features below. If in doubt, download the latest version from: Placing the System into Enhanced Mode The R Installation Tool, when communicating with a R5.xx system via direct or LAN connection (but not a modem connection), provides the option to place the system into Enhanced mode. Once a system has been placed in enhanced mode, it will stay that way unless defaults are reloaded

11 3.4. Audio (Page) Groups The Enhanced mode system has 72 Audio groups. The groups are paged by dialing: Group 1 #111 Group 2 #112 Group 72 #182 All call #110 The audio group dial codes used in the R4.xx system are not valid in the Enhanced system 3.5. Enhanced CLID Caller ID now uses the enhanced CLID format, which supports sending names to the phone. The R Installation Tool lets the Installer enter the names or descriptive info to be sent to the phone. Programming is done in the screen used to set user arch numbers Named Schedules and Groups The Installer may provide names for schedules and groups. This information is not currently used by the system, but simplifies programming and may be used by a PC based GUI program in the future VSST Board The VSST board is now supported by the R5.xx system with the R2.01 Tool SMDR In addition to the R4.xx system s method of providing SMDR data via the serial port of a VSSER card, the R5.xx system may be set up to send the data directly over a LAN. The data may be sent in standard Syslog UDP format, and/or in a multi-cast format. The multicast version is provided as a hook for future use, to provide system status information to Admin GUI Tools, etc. Required UDP and/or multicast addresses are defined using the 5100 Installation Tool. The View SMDR option of the 5100 Installation Tool may be used to receive and view the data from the LAN. Standard Syslog servers may be used if the data needs to be collected, acted upon, or manipulated. See Appendix 2 for the syslog format. A VSSER card is not required to send SMDR data directly over a LAN. See Appendix 2 for setup information

12 3.9. Daylight Savings Time The system now supports automatic DST on/off (using 1987 method) without having to program the dates. This feature may be enabled/disabled with the 5100 Installation Tool. R5.25 adds the option to automatically adjust DST according to the Energy Policy Act of Admin Forced Disconnect Each Admin phone may be individually programmed with a timer to limit call duration. When the timer expires, the call will be released and a one second open loop will be sent to the Admin port to disconnect any other access equipment

13 3.11. Programmable Voice Chip Module Phrase as used below refers to pre-recorded audio. The recorded audio can be voice and/or tone Schedules A scheduled event may be programmed to play a phrase Alert Tones There are system-wide options to substitute voice chip phrases in place of one-way and/or handsfree alert tones (one phrase for handsfree, the same or a different phrase for one-way) Room Number Announcement A phrase may be inserted before the announcement of a room number to an Admin phone, and during Emergency voice over speakers (programmable per arch number) Voice Phrase Dial Codes The User may play a recorded phrase to a port or page group on the fly, by selecting the phrase and destination via dial codes. These Dial Codes are available to Admin phones only, not to Staff phones Play a Recorded Phrase Offhook Mode Format: #31 3-digit phrase number Page or all call dial code For example, dialing: # #*112 will make an emergency priority page connection to audio group 2 (#*112), and then will play phrase number 065. The connection will remain active until the Admin phone hangs up. In addition to the recorded phrase, the Admin phone is connected to the speakers during and after playing the recorded voice. This dial code option may be used to play a custom pre-announce tone before a real-time page, or to let the user speak additional information after playing a recorded announcement

14 Play a Recorded Phrase, with Queue and Repeat (R5.11 or greater) Format: #32 3-digit phrase number Page or all call dial code Number of plays If not entered = 1, If 0 = cancel this request, If 99 repeat until stopped Replay time #1..#999 (seconds) If not entered = 30 seconds For example, dialing: # #*112 5 #60 <hang up> will make an emergency priority page connection to audio group 2 (#*112), will play phrase number 065, and will release the page. This will be repeated after 60 seconds, and the sequence will continue until the phrase has been played 5 times. The replay time is the minimum length of time between repetitions of the phrase Timing for the replay may be longer than the time-out period if new phrases are added to the queue, or if multiple phrases are being repeated Up to 12 phrases may be queued for play New phrase requests will be queued according to the order entered and the page priority Priorities, from high to low: Emergency all call, emergency group, all call, group New phrases will be played before repeat phrases Only one phrase will be played at a time, to avoid missing speakers in overlapping groups The current phrase will be interrupted if a higher priority request enters the queue; the interrupted phrase will be played in its entirety as soon as possible Cancel a Phrase (R5.11 or greater) Remove all queued occurrences of a phrase and cancel if playing. Format: #33 Phrase Clear the queue (R5.11 or greater) Cancel the current phrase and delete all queued phrases. Format: #34 (level 3 Admin only)

15 Using an Input to Play a Phrase A VSURI input may be programmed to play a phrase (VSCPU firmware r5.25 and above). Options similar to those of dial codes #32, #33, and #34 are available when programming a URI input. An input may be momentary or locking, depending on the features and usage desired Voice Phrase Programming Setup The Voice Chip Programmer (Windows Tool) is used to record, import, or edit phrases, to save the phrase information to a file, and to send the digitized audio to the 5100 System. The 5100 Installation Tool obtains the information it needs to enable the voice phrase features by importing phrase names, numbers, and durations from the Voice Chip Programmer s data file (.VCI file). Important Importing the Voice Chip Image File into the 5100 Installation Tool: When the Voice Chip Programmer is used to send a new or modified.vci file to the system, you must also perform the following to fully implement the changes: 1. Use the 5100 Installation Tool to Receive Files from the system 2. Go to File, Load Voice Chip File and open the new.vci file 3. The phrase information is now available within the 5100 Installation Tool. Modify Schedule, Alert Tone, and/or Room Number Announcement programming as desired to utilize the voice phrases. 4. Save your files 5. Send Files back to the system

16 3.12. VSINT Board Relays A number of new programmable options have been added for the relay outputs on the VSINT board: 1. Follow a point. 2. Use # to activate during a handsfree conversation to a point 3. Follow a page to an audio group (This feature is available to Admin phones only, not to Staff phones). 4. Clock control Provides the same relay output timing as could be obtained by setting up these clock types in the VSSER card: Clock Type 1 Clock Type 1 generator Clock Type 2 Clock Type 2 generator Clock Type 23 Clock Type 24 #94 00 will move clocks to the next hour (may be dialed multiple times if needed). Automatic DST correction will occur if enabled via the 5100 Installation Tool VSURI Board Relays Relays on VSURI (VSGIO) boards may now be turned on and off through the schedules as events (R5.22) Emergency Tones An option has been added in the 5100 Installation Tool under: Initialize Tones / Tone Type, to allow an emergency tone to be disabled, i.e. dial code(s) ##1..##4, and VSGIO access to the tone(s) will be disabled

17 3.15. Serial Port Modems In Enhanced mode the baud rate for the serial port used for direct and modem connection has been increased from 2400 to Most modern modems do not perform well at 2400 baud, so this will make it easier to substitute modems other than USRobotics for the remote modem, should USR become difficult to obtain. Note: Modem substitution is still not trivial, and not something to offer a customer. Substantial work would be required to determine the proper modem init string to make a new modem work with the 5100 System. Versions R2.01 and above of the 5100 Installation Tool have options for setting up the remote modem for either baud rate. Only R5.xx systems will use 9600 baud Direct Connect During Direct (serial) connection, the Tool will attempt to automatically determine the correct baud rate (2400 or 9600) for the system. The order of the attempts, (Standard or Enhanced first) may be set by the user, or the Tool may be manually told what connection speed to use Additional Enhanced Mode Feature Changes Admin hookswitch enable/disable is now programmable through the 5100 Installation Tool (was a dial code in r4.xx systems) Digit 0 may be substituted for # as the first and/or second digit of dial codes (for access from telephone systems that don t send # out trunk ports, or that use it internally for their own feature access) The VSROM card serial port programming now has an option to display all Admins on one display. This feature also requires updated VSROM firmware, available in a new card: the VSROM-D. A system dialing plan may be printed from the 5100 Installation Tool. The printed plan includes only the stations, audio groups, and schedules that have caller ID or name defined (prints only numbers actually defined and used within the system)

18 3.17. Enhanced Mode Dialing Plan Changes are shown in italics Admin. Phone Ringing Off Hook (Answer Call) * Answer Call # System Dial Tone Hookswitch Flash - next call in queue Phone Idle Off Hook (Dial Tone) Access Levels #110 All Call Page # Page Groups #* Emergency Page Groups # page code Play pre-recorded phrase to a page group # , page code, num plays, #time-out Play pre-recorded phrase to a page group Num plays 1..98, 0=cancel, 99=replay until stopped Time-out (min time between replays) = seconds # Stop playing phrase #34 Stop playing all phrases #35 Temporary Page Group Station, #,... Station, #, # #36 Page to Test zones only #40 Control All Relays * Enable Automatic Relay Operation # Disable Automatic Relay Operation # Control Individual Relays * Operate Relay # Release Relay #50 Control Schedules * Enable Automatic Time Schedule # Disable Automatic Time Schedule # Time Schedule 1..8 * Activate Selected Event List # De-activate Selected Event List # Program Sources 1..3 * ON # OFF # Monitor Program Sources 1..3, Mic (if turned on) #71* Enable Call Forward after time-out # Disable Call Forward after time-out #72* Enable Immediate Call Forward # Disable Immediate Call Forward #73 Call Pickup #85 Activate test room command Station, #,... Station, #, # #86 Cancel individual test room restriction Station, #,... Station, #, # #87 Cancel all test room restrictions Station, #,... Station, #, #

19 #92 Passwd * Save System Data to EEROM #93 Passwd * Restore System Data from EEROM System WILL RESET #9400 Synchronous Clock Manual Advance to next hour #9401 Impulse Clock Manual Advance # = Number of Minutes to advance #96 Passwd * New Access Code feature override access code #97 Clear all ADA LEDs and LCD call indications #98* Enable Admin Hookflash #98# Disable Admin Hookflash #99 Enter Program Mode ##0 Emergency All Call ##1...4 Distribute Emergency Tones ##1 Tornado ##2 Fire Alarm ##3 Emergency Time Tone ##4 All Clear Tone ##5 Stop Emergency Tones ##9* Riot COS Enabled ##9# Riot COS Disabled *9 Bump Call in Progress *8 Join Call in Progress *7 Join Queue ** Arch No. Originate Message Waiting, no ring *# Arch No. Message Waiting Off, no ring Arch No. ** Dial station, no answer, press ** for message waiting Arch No. *# Message Waiting Off Sta. No. Ring Room Telephone (see note 1) *Sta. No. Connect to room handsfree (see note 1) Note 1: This is default operation; can be programmed to perform the opposite operation (r4.20 and above)

20 3.18. Programmable Scheduled Event Priority VCS system priorities from low to high are: Aux source priority Standard page priority Standard all call page priority Handsfree call priority Standard time scheduled event priority Emergency page priority Handsfree call originated during an emergency page A higher priority page to a speaker will override a lower priority page to the same speaker. When adding a scheduled event, you can now set the event's priority to one of these four levels: Level 1 - Aux Source Priority Level 2 - Standard Page Priority Level 3 - Standard All Call Page Priority Level 4 - Time scheduled Event Priority Typically, the time tone for a class change should be set to level 4 so it is heard even during a page; and an Aux source or voice phrase (anything longer than a few seconds) should be set to Level 1 so it doesn t prevent a page from being heard. In R4.99 and earlier systems, scheduled tones always play at Level 4, and scheduled Aux sources at Level 1. Voice phrases may not be scheduled in these systems Automatic Internet Time Sync Description This feature enables the CPU to update its date and time automatically, once a day, from an Internet time server utilizing the NIST Daytime Protocol, RFC-867. (See The feature also permits manual date/time update via dial codes or a button in the Admin Tool Dial Codes #92* allows the user to perform a manual network time update The system returns a voice phrase: "Time update successful", or "Time update failed" #92# allows the user to check the status of the Internet time update system. The system returns a voice response: "Last network time update hh mm DoW MM dd yy", indicating the date and time of the most recent successful network time update

21 Programmable data: The following settings are user programmable from the Installation Tool. Most options are also available in the Admin Tool. Enable / disable automatic updates If valid data has been programmed, manual updates via dial code or Tools will work, even if automatic updates are disabled IP and port number of time server Port should default to 13 Allow entry of a main and a backup IP and port Provide a link to Offset from UTC Provides a drop-down list of hours from -12 to +14 Provides a drop-down list of "Local" offset minutes from -59 to +59 (to handle schools that want to run late, and unusual time zones) DST Options Enable / disable DST Manual date entry 1987 method According to received Internet time message Time of day to perform the update There is a "test connection" button in the Tools that verifies the programmed IP and port numbers are accessible and work Additional Information A manual Internet time update may be performed from the Installation or Admin Tool BCD In and Internet Time Server are mutually exclusive, only one may be enabled

22 3.20. Admin Tool An Admin Tool has been created for this system. The Tool performs all the standard Admin Tool functions. In addition, new functions unique to the R5.20 CPU include: Relay control NIST time server setup and access Manual advance of impulse and sync-wired clocks Voice phrase selection, playback, and control It is strongly recommended VCS CPU firmware R5.20 be used with the Admin Tool, although the Tool will also work, with varying degrees of functionality, with R4.7x, R4.99, and R Firmware Update The CPU board firmware now has the capability of being upgraded on-site, instead of requiring return to the factory. The software Tool required to perform the update will be released in the near future

23 3.22. R5.20 Dialing Plan Changes are shown in italics Admin. Phone Ringing Off Hook (Answer Call) * Answer Call # System Dial Tone Hookswitch Flash - next call in queue Phone Idle Off Hook (Dial Tone) Access Levels #110 All Call Page # Page Groups #* Emergency Page Groups # page code Play pre-recorded phrase to a page group # , page code, num plays, #time-out Play pre-recorded phrase to a page group Num plays 1..98, 0=cancel, 99=replay until stopped Time-out (min time between replays) = seconds # Stop playing phrase #34 Stop playing all phrases #35 Temporary Page Group Station, #,... Station, #, # #36 Page to Test zones only #40 Control All Relays * Enable Automatic Relay Operation # Disable Automatic Relay Operation # Control Individual Relays * Operate Relay # Release Relay #50 Control Schedules * Enable Automatic Time Schedule # Disable Automatic Time Schedule # Time Schedule 1..8 * Activate Selected Event List # De-activate Selected Event List # Program Sources 1..3 * ON # OFF # Monitor Program Sources 1..3, Mic (if turned on) #71* Enable Call Forward after time-out # Disable Call Forward after time-out #72* Enable Immediate Call Forward # Disable Immediate Call Forward #73 Call Pickup #85 Activate test room command Station, #,... Station, #, # #86 Cancel individual test room restriction Station, #,... Station, #, # #87 Cancel all test room restrictions Station, #,... Station, #, #

24 #92* Manual Internet time update # Internet time update status #9400 Synchronous Clock Manual Advance to next hour #9401 Impulse Clock Manual Advance # = Number of Minutes to advance #96 Passwd * New Access Code feature override access code #97 Clear all ADA LEDs and LCD call indications #98* Enable Admin Hookflash #98# Disable Admin Hookflash #99 Enter Program Mode ##0 Emergency All Call ##1...4 Distribute Emergency Tones ##1 Tornado ##2 Fire Alarm ##3 Emergency Time Tone ##4 All Clear Tone ##5 Stop Emergency Tones ##9* Riot COS Enabled ##9# Riot COS Disabled *9 Bump Call in Progress *8 Join Call in Progress *7 Join Queue ** Arch No. Originate Message Waiting, no ring *# Arch No. Message Waiting Off, no ring Arch No. ** Dial station, no answer, press ** for message waiting Arch No. *# Message Waiting Off Sta. No. Ring Room Telephone (see note 1) *Sta. No. Connect to room handsfree (see note 1) Note 1: This is default operation; can be programmed to perform the opposite operation (r4.20 and above)

25 4. Compatibility Differences between Redesign and Existing (pre R4.99) Systems: 1. CLID format has changed from SDMF (single message format) to MDMF (multiple ). 2. Ring frequency/voltage differences (now using SLIC circuits). 3. The VSROM may be utilized for its serial port, but not for saving/restoring user program data. (The VSROM s EEPROM is no longer large enough to store the system database). 4. New CPU will not work with existing VSFR without software timing changes in VSFR. 5. Windows program help files are now in.pdf format, requiring Acrobat reader to be viewed. 6. When using VSST1/3 cards with an enhanced system, Staff phone users are only able to access the first 24 page groups. Page group dial codes for Staff phone users are: Group 1 #11 Group 2 #12 Group 24 #34 All Call #10 Note these codes are unchanged from those used in the existing R4.xx system 7. When changing system programming using the VSLCD, page group options will show as 1 24 in the screen text, but in fact the system will (correctly) allow the user to enter data for all groups:

26 5. Appendices 5.1. Appendix 1 LAN Programming Setup To prevent causing possible conflicts and network problems, no devices should be connected to any LAN without the knowledge and assistance of the local IT Manager. IP numbers must be obtained from the IT Manager Install the VCS IP Setup Tool 1. Obtain the VSWIN Version 2 System CD-ROM, or download the IP Setup Tool from 2. Follow the prompts (typical Windows installation) to install the program. 3. Click Finish to complete the installation Gather Network Information The following information is required from the Network Administrator: The static IP address to be assigned to the system. The subnet number The default gateway IP address Connect to the LAN Connect the 5100 System to the network using a standard RJ45 network cable connected to a network switch, and connect your PC to the same subnet of the network, or Connect directly from your computer to the 5100 System with a network crossover cable Configure the IP Tool s Subnet Information 1. Start the VCS IP Setup program. 2. To begin configuring a subnet, click on the Network Tool button on the toolbar. This will bring up the Networks dialog box where the configuration takes place. 3. Click the Add button. This brings up the subnet configuration dialog box. 4. Enter the information for the subnet

27 Program the Network Parameters The steps to setting LAN parameters in a new system are: 1. Scan the network using the VCS IP Setup Tool software Click the Scan button to find the new system in the local network. 2. Select the system In the left-hand pane (tree view), select the device to which you wish to assign the new IP address. 3. Assign the new device an IP address In the right-hand pane, type the new IP address into the IP Address text box. 4. Name the new device (optional) In the right-hand pane, type the new name into the Name text box. 5. Update the device After the IP address or the name of a device is changed, the device must be updated by clicking the Update Device button in the right-hand frame Changing the System s IP Number LAN Connection - Current IP Number or Subnet is Known 1. Plug a PC into the same subnet as the and give it valid IP and Gateway numbers for the subnet (Note: changing a PC s IP number may require use of your Windows operating system CD. 2. Using the IP Setup Tool, scan for the system. 3. Select the system, change its IP number, and update the device

28 Serial Connection VCS IP Setup Tool The VCS IP Setup Tool, with a serial connection to the system, may be used to set or change the system IP number. 1. Connect between PC and system using a Null Modem cable (direct connect) 2. Bring up the VCS IP Setup Tool 3. Select: File, Serial Connection The program will search the PC s serial ports for a system 4. Enter the system password 5. Select the system In the left-hand pane (tree view), select the device to which you wish to assign the new IP address. 6. Assign the new device an IP address In the right-hand pane, type the new IP address into the IP Address text box. 7. Assign the new device a Gateway address In the right-hand pane, type the new gateway address into the Gateway Address text box. 8. Update the device

29 Hyperterminal HyperTerminal with a serial connection to the system may also be used to set or change the system IP number. 1. Connect between PC and system using a Null Modem cable (direct connect) 2. Bring up HyperTerminal with these parameters: R4.99 system: 2400, n, 8, 1 R5.xx system: 9600, n, 8, 1 ASCII setup: Append line feeds to incoming line ends 3. Press <enter>, you should see > on the screen 4. Type: (R5.xx) or (R4.99) and press <enter>, you should see - on the screen (If the password has been changed, replace with the current password) 5. Type: 32<enter> to read the current IP, mask, and gateway info 6. Type: 33 iiiiiiiiiiii<enter>, where ii.. is the desired 12 digit IP number, without periods or spaces. 7. Type: 34 ssssssssssss<enter>, where ss.. is the desired 12 digit subnet mask, without periods or spaces. 8. Type: 35 gggggggggggg<enter>, where gg.. is the desired 12 digit gateway address, without periods or spaces. 9. Type: 32<enter> to verify the new data. (Displays a sequence of numbers corresponding to: iiiiiiiiiiiissssssssssssgggggggggggg) 10. Type: 0201<enter> to finish

30 LAN Factory Defaults The factory defaults for the system are: Network defaults IP Address VCS IP Setup Tool Minimum System Requirements The VCS IP Setup Tool has very few requirements in order to run. The system minimums are outlined below. Hardware Minimum required to support the Operating System Operating System Windows 98, ME, NT 4.0 SP6, 2000, P Network 10 Mbps connection

31 5.2. Appendix 2 - LAN Connection to System SMDR To prevent causing possible conflicts and network problems, no devices should be connected to any LAN without the knowledge and assistance of the local IT Manager. IP numbers must be obtained from the IT Manager View SMDR over LAN The 5100 Installation Tool contains a utility that allows you to view and log system SMDR data over the LAN. Follow the instructions in either the UDP to SYSLOG Server or Multicast Broadcast sections of this document (below), to set up the System to send SMDR over the LAN, and to set up the 5100 Installation Tool to receive the data UDP to SYSLOG Server Setup A Syslog server allows you to receive, store, and/or act on specific SMDR data from the system. Syslog server software used to receive and process the data is not provided by or supported by Valcom. This setup may also be used to view SMDR data using the 5100 Installation Tool. To set up the system to communicate with a syslog server: In the 5100 Installation Tool under: System / SMDR / SMDR Options : Check Send syslog SMDR via UDP (Port 514) Enter the IP address of the PC to receive the data in form: xxx.xxx.xxx.xxx Notes: This connection uses the standard syslog port To View UDP SYSLOG SMDR Data 1. In the 5100 Installation Tool bring up the Connect screen: File / Communications / Network / View SMDR : 2. Enter the IP address and port number of the system. Name and password are not required. The information may be saved to the Address Book for future reference, if desired. 3. Select Connect

32 Multicast Broadcast Setup The multicast output is to provide status information for future applications. This setup also provides a means to view SMDR data using the 5100 Installation Tool. To set up the system to send status information in multicast format: In the 5100 Installation Tool under: System / SMDR / SMDR Options : Check Send syslog SMDR via Multicast (Port 10020) Enter the multicast IP broadcast address in the form: xxx.xxx.xxx.xxx Notes: Multicast addresses must be in the range Local multicast is typically in the 239.xxx.xxx.xxx range This connection uses port To View Multicast SMDR Data 1. In the 5100 Installation Tool bring up the Connect screen: File / Communications / Network / View SMDR : 2. Enter the Multicast address and port number as programmed into the system. Name and password are not required. The information may be saved to the Address Book for future reference, if desired. 3. Select Connect

33 5.3. Appendix 3 - SMDR Format Format of SMDR output string (all printable ASCII characters): mm/dd/yy.hh:mm:ss..aaaa.bbbb..tttttttttt<cr><lf> Fields are column-delineated. All fields are fixed length except for the last one, which may be up to 10 characters. The output string is terminated with <cr><lf>. Columns are separated by one or two spaces ($20), indicated by. above. Spaces may also appear within fields. Field mm/dd/yy hh:mm:ss aaaa bbbb tttttttttt Description date of event time of event 4-character "originator" data field contents dependant on message type (arch numbers right justified with leading 0's suppressed) 4-character "destination" data field contents dependant on message type (arch numbers right justified with leading 0's suppressed) message type (variable length, up to 10 characters max, left justified) SMDR Output Examples mm/dd/yy hh:mm:ss aaaa bbbb tttttttttt , , /09/99 11:12: CONNECT 07/09/99 11:12: EMER VOICE 07/09/99 11:12: SYSMSG /09/99 11:12:45 00CF 009D SYSMSG /09/99 12:10: CRISIS ON 07/09/99 12:15:30 INPT CRISIS OFF

34 5.4. Appendix 4 - SYSLOG Format The following information is intended for an experienced IT professional setting up a syslog server to receive messages ( is a good source of information about SYSLOG). The syslog message format contains the following fields: Priority Month Day Time IP Address System ID Number Message Priority: The system always sends messages with the PRI field set to 14. This indicates a Userlevel message (Facility = 1) with an Informational priority (Severity = 6). The value for PRI is calculated by: (Facility * 8) + Severity = 14. System ID Number: The system creates a unique System ID Number by combining VALCOM5100 with the 8 digit customer number programmed into the system by the installer. Month, Day, Time, IP Address, Message: (Self-explanatory) As an example, the following SMDR message: 02/05/04 11:28: SYSMSG 016 when sent as a syslog packet from system , would look like this: <14>Feb 5 11:28: VALCOM : 02/05/04 11:28: SYSMSG

35 5.5. Appendix 5 Voice Chip Programming Utility General The Voice Chip Programmer (VCMessageUtil.exe) is a Windows Tool used to record phrases for the Voice Chip Module, to save the digitized audio to a file, and to transfer the voice chip image file (.VCI) to/from the 5100 System. The program also has an option to import professionally recorded (8k, 8 bit ulaw).wav files Hardware Requirements A serial port is required to transfer data to/from the 5100 System. A properly configured sound card is required to preview or record phrases Starting the Voice Chip Programmer The installation program (VCMessageUtilSetup.exe) will place a VCMessageUtil entry, with a microphone icon, in the computer s Programs menu. To bring up the program press Start on the taskbar, select Programs, and select VCMessageUtil Connections To use the Voice Chip Programmer to transfer a.vci file you must connect a NULL Modem cable between the PC s serial port and the rear DB9 connector on the VSCPU board. The standard VCS programming cable may be used. If the standard VCS programming cable is used, the end with the right-angle connector, marked VCS, must be connected to the VSCPU board. Note the Voice Chip Programming port is not the VSCPU port used for normal direct connect or modem programming. Also note the voice data image file can not be transferred via LAN or modem Importing Data into the 5100 Installation Tool The 5100 Installation Tool needs information from the Voice Chip Programmer s data file to enable user programming of voice phrase features. The Tool gets this information by importing the.vci file, and reading the phrase names, numbers, and durations. To import the.vci data file: Start the 5100 Installation Tool Load the data files for the job (create, open, or receive enhanced files) From the Tool File menu select Load Voice Chip File Locate, select and open the new.vci file

36 Protected Phrases The voice chip may be programmed with up to 127 phrases. Phrase numbers 1-63 are programmed from the factory, and default to read only in the Voice Chip Programmer, because they are usually needed for normal system operation. Phrase numbers are available for custom phrases. If it is desired to allow an advanced user to change phrases 1-63, use a text editor (such as Notepad) to change the first line in EDITO63.txt to ALLOW. For a typical installation, EDITO63.txt will be found in: c:\program Files\Valcom\VCMessageUtil Updating the System with Voice Phrase Changes When the Voice Chip Programmer has been used to create a new or modified.vci file, you must perform the following to fully implement the changes: Voice Chip Programming Tool: 1. Connect a NULL Modem cable between the PC s serial port and the rear DB9 connector on the VSCPU board. 2. Use the Voice Chip Programmer to transfer the.vci file to the 5100 System Installation Tool: 3. Connect to the 5100 System with the 5100 Installation Tool (serial, modem, or LAN). 4. Receive Files from the 5100 System. 5. Go to the menu option: File, Load Voice Chip File 6. Select and Open the new.vci file. 7. The phrase information is now available within the 5100 Installation Tool. Modify Schedule, Alert Tone, and/or Room Number Announcement programming as desired to utilize the phrases. 8. Save your files. 9. Send Files back to the 5100 System

37 Voice Chip Programmer Tool Specifics Main Window Load VC Image File Read a saved voice file into the tool for editing or sending to the 5100 System. Two files are installed with the VCMessageUtil program: FemaleVoice.vci and MaleVoice.vci. These files contain the required default phrases for the 5100 System, in a choice of two voices. If custom phrases are to be added, it is suggested you start by loading one of these files as a foundation to build on (see Required Messages, below) Save VC Image File Save your modifications to the same or a new file Read / Write VC Unit This opens a new window: VC Unit Communications, used to transfer a voice file to or from the Voice Chip Module on the VSCPU board Print VC Image Data Prints a list of the names and durations of programmed phrases Close Exit the program

38 Main Window Message (Phrase) Options Preview Highlight a message name in the Message box, then select Preview to listen to the highlighted message Edit This opens a new window: Edit Message, used to record, or re-record, a message Delete Highlight a message name in the Message box, then select Delete to remove the highlighted message Import WAV Import a pre-recorded message. The message will be imported to the highlighted location in the message box. The message to be imported must be a.wav file saved in 8k, 8 bit, ulaw format Export WAV Make a copy of the highlighted message, in the form of a.wav file. This could be used to save a copy of a message before deleting it from the.vci file, or to make a copy to import into another system. Note: Exporting a message does not remove it from the programmer or.vci file

39 Edit Message Window Message Name Name a new phrase, or rename an existing phrase Recording level meter Use in conjunction with your sound card s audio mixer program to optimize the recording level Record / Stop Press to begin recording a phrase. Press again to stop. It is important to have the microphone gain adjusted correctly when recording. During recording, the signal level should come close too, or just reach, the red level on the meter. Microphone gain is adjusted with the Mixer controls that were installed with your sound card. The mixer is typically accessed by right clicking on the speaker (volume) icon on the task bar. Suggestion: Speaking across the microphone at approximately 45 degrees often gives better recording quality than speaking directly into it Play / Stop Press to listen to the recording. Press again to stop OK Accept changes and exit the window Cancel Exit the window without saving any changes Make Silence Creates a completely silent phrase Settings Advanced options that should not need to be changed

40 VC Unit Communications Window Com: Port Select the COM: port connected to the Voice Chip Module Baud Rate The baud rate should remain set to Even at this rate, transfer of a full data file can take several minutes. If your PC has trouble communicating at this rate you can try dropping to If you change to in the programmer, you must also change the Voice Chip Module hardware by putting a jumper on JP12 of the VSCPU board Read Unit Read the voice data file from the Voice Chip Module Write Unit Write the current data to the Voice Chip Module Sectors Shows the read/write progress Modem Status CTS must be green during file transfer Status Bar The Status Bar (bottom of window) will display informational messages about theh status of the Voice Chip, such as Ready, Reading, Erasing, Programming

41 Advanced Options Additional Resources These selections are primarily for testing use, and should not be changed: Write one sector at a time Disable Timeouts Change system default setting Professionally recorded phrases: Audio editing software:

42 Required Messages The following phrases are included in the default male and female.vci files provided, and are required for system operation. If you wish to change to a different voice or language, you will need to re-record these phrases: Message Number Phrase 1 One 2 Two 3 Three 4 Four 5 Five 6 Six 7 Seven 8 Eight 9 Nine 10 Ten 11 Eleven 12 Twelve 13 Thirteen 14 Fourteen 15 Fifteen 16 Sixteen 17 Seventeen 18 Eighteen 19 Nineteen 20 Twenty 21 Thirty 22 Forty 23 Fifty 24 Sunday 25 Monday 26 Tuesday 27 Wednesday 28 Thursday 29 Friday 30 Saturday 31 A.M. 32 P.M. 33 Time update successful 34 Time update failed 35 Last network time update 39 Zero 51 40ms pause (silence) 52 80ms pause ms pause ms pause ms pause ms pause 62 High/Low tone 63 Warble tone