W I R E L E S S C O M M U N I C A T I O N S Y S T E M S SPS-5 v9E Paging System Manual Version 9.XXE Firmware Copyright WaveWare Technologies, Inc. 2014 - All Rights Reserved SPS-5 v9E Ethernet and Serial Port Paging System WaveWare Technologies, Inc. 2630 National Dr. Garland, TX. 75041 Phone: 1.800.373.1466 Fax: 972.479.1735 www.WirelessMessaging.
Table of Contents Introduction Warranty and other Misc Information Obtaining Pagers for your Paging System Paging System Operation Paging System Installation Quick Start Guide Encoder Setup Software Programming Guide Web Browser Programming Guide Appendix “A” – TAP Interface Specifications o System ID Command o Paging Session “Log-In” o Paging Operation o Paging Session “Log-Out” Appendix “B” – Com Port and Network Settings Appendix “C” – TAP Checksum Calculations Appendix “D” – TAP Response Codes Appendix
Introduction – SPS-5 v9E Paging System Your WaveWare SPS-5 v9E Paging System allows you to Send Paging Messages to one or more Persons via Pagers, and Devices that incorporate POCSAG Paging Data Receivers. You can setup Automatic Transmission of Messages or you can Compose Messages on the fly and Transmit them immediately. The V9E is part of the V9E of paging systems offered by WaveWare. Following is a comparison chart.
Extended Pager ID Method (TAP, COMP2, and SNPP Compatible Extended Interface Supporting Embedded Control Characters and Paging Message Encoding Parameters Appended to the Pager ID field) PET (Page Entry Terminal), which provides human readable messaging prompts and also supports TAP protocol message formats Simplex TAP, a Single Serial Command String Composed of a Standard TAP Message Block. NOTE: Simplex TAP is the Recommended Interface Protocol for System Developers.
Programmable Data Encoding Polarity, Supports the Encoding of POCSAG Messages for compatibility with different pager models Normal Polarity Inverted Polarity Default is “Normal” Programmable Flow Control Signaling, Accommodates a variety of methods of busy terminal signaling.
NOTE: For most Normal Grouping of Pagers, it is “Recommended” to use a “Common” Cap Code within a Group of Pagers. This way the Pagers within that Group will Receive the Message simultaneously, instead of paging them one at a time from a List of Pagers, which could take awhile to go thru the entire list.
Warranty and Other Information Warranty: WaveWare Technologies, Inc. warrants this equipment to operate properly for a period of one year from date of shipment from WaveWare Technologies, Inc. Warranty includes parts and WaveWare factory labor, but does not include shipping charges. The warranty becomes void if the equipment is physically damaged by any external events.
Frequency - All Paging Receivers used with the WaveWare v9E Paging System must be of the same Frequency and Must Match the Frequency of the Paging System Transmitter. See the Label on the back of any WaveWare Transmitter Unit to Identify the Operating Frequency of your Paging System. POCSAG - All Paging Receivers used with the WaveWare v9E Paging System must be POCSAG Compatible. POCSAG is the Paging Protocol most frequently used in the paging industry.
Any POCSAG compatible paging receiver operating on the same frequency as the paging transmitter (in the UHF band) and operating at 512, 1200, or 2400 bps data rate. Pagers of this type include alphanumeric, numeric, and tone/vibe models and can be obtained from WaveWare Technologies, Motorola, NEC, Panasonic, and others. WaveWare Wireless Message Centers operating at the same frequency as your paging system. WaveWare Wireless Message Centers are normally configured to receive at a 512 bps data rate.
Note: Do not attempt to operate the paging system without the antenna connected to the paging transmitter, as damage to the paging transmitter may occur. Remove the Front Cover of the Transmitter Unit. Hold the unit up against the wall or other non-metallic vertical surface as a template to mark the 2 hole locations where you will mount the Transmitter Unit. Drill and attach the top # 8 x ¾” sheet metal screw to the wall or vertical surface (use the plastic anchors if needed).
Messaging: The Messaging page is the default page displayed when you connect your web browser to the SPS-5 v9E paging system. The Messaging page allows you to send test paging messages through the paging system, and to look up how the encoder decodes Pager ID values. You can use Pager ID values that are programmed into the Pager Families lookup table, or you can use Extended Pager ID values that bypass the lookup table. A typical Pager ID is 101, and a typical Extended Pager ID value is 101150.
The SPS-5 V9E Host Name field allows you to define a user-friendly reference for the paging encoder. That reference field is displayed in the Discovery function in the Encoder Setup Software, to help you differentiate between paging systems when multiple paging systems are displayed. The Enable DHCP checkbox allows you to use DHCP mode to auto-acquire an IP address on powerup of the paging system.
Quick Start Guide for Serial Port Programming Your SPS- 5 v9E Paging System should include: 1- Rubber Duck Style Antenna, 1- Power Supply, 1- Serial Cable, 1- Ethernet Cable, 1- Package of Mounting Hardware and 1- Product Support CD. A Second RS-232 Cable is available for Purchase if Required. Notes: The Frequency, Cap Code(s), Watts and other Information are “Labeled” on the Back of the unit. The SPS-5 will “Auto Detect” the Encoder Setup Software for Pager Database Programming.
Encoder Setup Software Programming Guide Getting Started Insert the “Product Support CD” into a Laptop or Desktop. Install the Encoder Setup v9 Program Software. The v9 Encoder Software has the ability to work with all Versions of the v9 Paging Systems, including V9, V9S, and V9E. Attach the paging system using the supplied Standard RS-232 serial cable to your selected Com Port. The SPS-5 v9 or the v9S will be Auto-Detected by the Encoder Setup Software, when you “Open” the Com Port.
See Fig. 3 Fig. 3 (Open the Com Port, Part 1)…Click the “Open Com 2” to Open the Com Port. The Software will detect the SPS-5 v9E Paging System and Open the Com Port and the Light will turn Green. See Fig. 4 Fig. 4 (Open the Com Port) The Software has Opened the Com Port and will now READ the Database. Click “OK” See Fig. 5 Fig.
Fig. 6 (Open the Pager Database)…Configuration Pager Families Screen: Enter Quantity, Pager ID’s, 7-Digit Cap Code, Baud Rate, Pager Type and Function code. Function Code 4 is normally for Alphanumeric Pagers and Function Code 1 is normally for Numeric Pagers. When Finished, Click “OK” See Fig. 7 Fig. 7 (Enter Pagers in the Database) If Family 1 is Red, Click to Activate and to Add Pagers, it will turn Green. For Programming of the Pager Groups – (See Next Page).
On the Main Screen of Encoder Setup Program, Click on “Group Paging” to Open the Pager Database. See Fig. 8 Fig. 8 (Group Paging)…Configuration Pager Groups Screen: Enter The Group ID and list the pager ID’s you want in that group. The ID’s must be in the Pager Families, programmed previously. Note: In most cases you would use a “Common” Pager Cap Code in the Pager themselves instead of using Pager Groups.
Pager Groups “Timer” Screen: This will send a page every 2 minutes to the pagers listed in that Group unless the “Host” system issues a “Reset” Command. You create the message to be sent in the “Canned Messages” Screen. When Finished, Click “OK”. See Fig. 10 Fig. 10 (Activate Timer) If Timer in the group is RED, click on the Box to Activate and it will turn Green. “Timer Message”: Choose the Number of the Canned Message you want to send. NOTE: You may need to “Configure” the Canned Messages “Before” Part.
On the Main Screen of Encoder Setup Program, Click on the “Canned Messages” Icon to Open the Predefined Messages Screen. See Fig. 11 Fig. 11 (Canned Messages)…Configuration In the “Predefined Messages Setup” Screen, type the Message you want sent, 1 Message per Line and Click “OK”. See Fig. 12 Fig. 12 (Add Predefined Messages) On the Main Screen of Encoder Setup Program, Click on the “Settings” Icon to Open the Com Port Screen. See Fig.
Fig. 13 (Settings Icon)…Settings The “Advanced Settings” Button will give you more Options. The “Restore Defaults” Button will “Reset” Both Com Ports to “Defaults”. Below are the “Encoder Settings” screen for the Dual Com Ports and Protocols. When Finished, Click “OK”. See Fig. 14 Encoder Settings: A: Protocol for the 1st Com Port Choices are TAP, PET and TAP, COMP1, COMP2, WaveWare and Scope.
Fig. 15 (Enter Password “Maint”) Below is the Advanced Encoder Settings Screen. In MOST cases you will NOT have to adjust these settings. The “Restore Defaults” Button will set each field back to the Original Default settings and affects the Entire screen. When finished, Click “OK”. See Fig. 16 Fig. 16 (Default Settings) For the SPS-5 v9E Advanced Settings Screen Advancedd Encoder Settings – “Default Settings”: (As Shown) Fig.
Fig. 17 (Programs the Encoder) On the Main Screen of Encoder Setup Program, Click on the “Read Encoder” Icon to see the Database information. Used when you want to check to be sure everything you have programmed into the database was saved and is correct. See Fig. 18 Fig. 18 (Reads the Pager Database and all Settings) It is Recommended that you save the Database “Before and After” you have finished Programming the SPS-5 v9. See Fig.
Fig. 19 (Click on “Files” and then Click “Save As” and name your file) Recommendation After “Reading” the System for the First Time and Before you Edit the Configuration: “Save the Database”. You could name it “Default” or “Base” or a name of your preference. This would give you a “Base Configuration” to fall back on in case you ever need the “Original” Database and Settings.
Fig. 21 (Test Encoder Screen) A: Pager Pin = Enter the Pager “ID” of the pager you want to test. It MUST match the Pager ID in the Database. B: Pager Message = Type the Message you want to send to the Pager. C: Message Archive = When you type a Message (B) you have the choice to save it by Highlighting the Message and click on the “ADD” Button. The Message will show in the Archive Window (C) and you may click on it anytime to move it to the Pager Message Window to send that message to a pager.
Fig. 22 (Range Test Function) Range Test Setup In this screen you can use the Default “Test” message or type any message in the “Base Message” Field (A). See Fig. 23 Fig. 23 (Range Test Setup) A: Base Message = Use Default Message “Test” or any Custom message you want. B: Pin = Use the Pager ID you entered in previous screen or type another Pager ID you want to use. C: Cycle Time = Default is 30 seconds but you may enter a different cycle time. D: Start / Cancel = When ready click “Start” to begin test.
The “Lookup ID” Function (A) will help you determine whether a Pager ID number you want to use is Valid or not. If it is valid, the “Response:” will show the Pager Information (B) and if the ID is NOT in the Pager Families Database, it will be Invalid and the “Response:” will show “Pager ID is Invalid”. See Fig. 24 Fig. 24 (Lookup ID Function and Response) TAP Interface Specifications: (See Next Page).
Appendix A – TAP Interface Specifications This appendix is included for those who want to develop their own paging control software or add an interface for the WaveWare v9E Paging Encoder to their existing software applications.
SYSTEM IDENTIFICATION COMMAND The System Identification command allows installation programs and other software applications to poll serial ports and network connections for the existence of a WaveWare v9E Paging Encoder using the Standard ATI Command. This can be used for a supervised process (also called keep-alive) where the host system periodically polls the paging system for a response.
IDMessageChecksum The ID Field is a one to ten character pager number. Leading zeroes are not required. The Message field accommodates up to 235 alphanumeric characters. The Checksum field provides a checksum for the previous portion of the TAP message block. See Appendix C – TAP Checksum Calculation, for sample code to create the checksum field.
error message and an , which tells the Host Device to abandon the transaction. An example error message sequence follows: 514 Checksum Error – Exp. 2:9 Got 2:X PAGING SESSION LOGOUT The Paging Session Logout mode allows a Host Device, sometimes called a Remote Entry Device, to stop communications with the paging system. With the WaveWare v9E Paging System, the Logout process is optional.
Appendix B – Com Port and Network Settings You may be required to configure the Com Port Settings and/or Network Settings in the paging encoder to establish the appropriate operating mode and communication parameters. Com Port Settings and Network Connection Settings are Programmable using the v9 Encoder Setup Software.
Appendix C – TAP Checksum Calculation Following is a sample Visual Basic™ code, that creates a string to be sent to the paging encoder. A subset of the string has a checksum calculation performed on it, and then the checksum and a control character are appended to form the string to be sent to the paging system. Refer to the TAP specification for more details on the checksum calculation. 'String that checksum is calculated on, of the form: ‘IDMessage TXString$ = Chr(2) & txtID.
This Completes the “Tap Checksum Calculations” Appendix D – TAP Response Codes Following is a table of response codes supported by the WaveWare v9E Paging Encoder. Please note that a response typically means the message should be resent by the host, and an response typically means the message should be abandoned by the host. Response Code Definition 110 1.8 Paging system supports TAP Specification v1.8 211 Page(s) Sent Successfully Paging message(s) successfully delivered.
Appendix E – Extended ID Processing The WaveWare v9E TAP Interface and COMP2 interfaces support ID field lengths from 1 to 10 digits. The ID field can be formatted as follows: Standard Method - ID field lengths from 1 to 4 digits will cause a pager database lookup. ID fields of this format must contain numeric digits only. The numeric ID value will be compared to the ID values stored in the WaveWare v9E Paging Encoder’s onboard pager database.
Extended ID Processing Continued: Following are valid example Extended ID fields causing Extended ID processing: 08A20 – Causes delivery of a standard (function code 4) alphanumeric message to cap code 0000008 at 2400 bps 08A24 – Same result as above 0008124 – Same result as above 0000008124 – Same result as above 11A53 – Causes delivery of an alphanumeric message with function code 3 to cap code 0000011 at 512 bps 0000011A53 – Same result as above 11N53 – Same result as above, but with numeric encoding 038
Appendix F – Embedded Control Characters When using “WaveWare mode” it is not necessary to make use of the control character. Since WaveWare mode does not use the control character it is only necessary to hit carriage return on your keyboard to have it show up on the pager display. To embed a control character in a TAP mode paging message however, it is necessary include a control character followed by an offset version of the control character you want to embed.
Appendix G – WaveWare Interface Specifications This appendix is included for those who want to develop their own paging control software or add an interface for the WaveWare v9E Paging Encoder to their existing software applications. You can choose to use the WaveWare Paging Protocol defined in this appendix, the TAP Paging Protocol, defined in Appendix A – TAP Interface Specifications, COMP1, or COMP2, or Scope Paging Protocols defined elsewhere in this manual.
PAGING MESSAGE COMMAND The Paging Message command is formatted as follows: Example 1: TBCC...CXXXX...XXX Example 2: T,B,CC...C,XXXX...XXX Note: The commas, the character, and the character are optional in the Paging Message command. They are used for appearance purposes to separate subparts of the command string and for formatting the echoed output while troubleshooting the system. (Hex code 01) is used to mark the start of a message.
(Hex code 02) is used to mark the beginning of a string of message characters to be transmitted. For paging message types of 1 to 4 Beeps (defined by the ‘T’ character above), this character and all following characters are ignored by the paging transmitter, until another is encountered. This character may have one or no leading commas separating it from the cap code. X...X A string of 0 to 256 alphanumeric message characters to be transmitted.
Example 4: 3,1,145678 Will send a three beep tone/vibe only message at 1200 bps to a tone/vibe only, a numeric, or an alphanumeric pager with cap code 0145678 and multiple tone/vibe cadence capability. Certain paging receiver models may not be designed to respond to multiple tone/vibe cadence messages. Example 5: 2,1,145678412-3433 Will send a two beep tone/vibe only message at 1200 bps to a paging receiver with cap code 0145678.
The QQ value is followed by a comma character. This parameter should be monitored if you intend to use software handshaking between your paging control software and the paging encoder. The paging encoder Input Queue overflows if the QQ value tries to exceed 14. As an example, with software handshaking, your software should stop sending data at a QQ value of 12 and resume sending data when the QQ value reaches 10 or less.
07 = EEPROM Write Error. Indicates an internal system error in the paging encoder with regard to the proper storage of configuration information. This condition would likely indicate that paging encoder repair is required. 08 = Invalid Command Format. Indicates that the command was not fully recognized as a valid paging encoder command. Example 1: A,5,46180,This is a testV8.
Example 1: S,1,0 will set the Carrier Detect function to the “Off” status. Example 2: S11 will set the Carrier Detect function to the “On” status. STATUS COMMAND You may request the paging encoder to respond with its current programmed settings using the Status command. The Status command is formatted as follows: S? Where the S? Requests the paging encoder to respond with the status of its current programmed settings.
Appendix H – COMP1 Interface Specifications This appendix is included for those who want to attach the WaveWare v9E Paging Encoder to existing systems that output raw data or simple data strings that are normally used in printing status logs on serial printers. The COMP1 Protocol is designed to emulate one of the operational modes of the Motorola People Finder™ paging system.
Appendix I – COMP2 Interface Specifications This appendix is included for those who want to attach the WaveWare v9E Paging Encoder to existing systems that output simplified paging system control commands. The COMP2 protocol is designed to emulate one of the operational modes of the Motorola People Finder™ paging system. There are two possible response modes for COMP2, the Verbose and Non-Verbose modes.
Tone/Vibe Only Example: PagerID Multiple Message Example: PagerID1Message1PagerID2Message2 Forced Resynchronization Example: PagerIDMessage Multiple Messages using Forced Resynchronization Example: PagerIDMessage 1PagerIDMessage 2 Function Code Control Example using Function Code B: PagerIDBMessage When incoming data is detected on the serial port, one of three things will happen: 1) The data in the ser
Appendix J – Scope Interface Specifications This appendix is included for those who want to develop their own paging control software or add an interface for the WaveWare v9E Paging Encoder to their existing software applications. You can choose to use the Scope Paging Protocol defined in this appendix, the TAP Paging Protocol, defined in Appendix A – TAP Interface Specifications, COMP1, or COMP2, or WaveWare Proprietary Paging Protocols defined elsewhere in this manual.
PAGING MESSAGE COMMAND The Scope Protocol Paging Message command is formatted as follows: AN1234567DMessage A Alphanumeric character representing the type of paging message to be transmitted A = Alphanumeric N = Numeric N Alphanumeric character representing the data rate, in bits per second, at which the paging message is to be transmitted N = 512 bps F = 1200 bps S = 2400 bps 1234567 D 7 digits representing the pager cap code, including leading zeroes as required Alphanumeric character representin
Example 3: AF0145678C Will send a three beep tone/vibe only message at 1200 bps to a tone/vibe only, a numeric, or an alphanumeric pager with Cap Code 0145678 and multiple tone/vibe cadence capability. Certain paging receiver models may not be designed to respond to multiple tone/vibe cadence messages. Example 4: AS0145678B Will send a two beep tone/vibe only message at 2400 bps to a paging receiver with Cap Code 0145678.
Appendix K – SNPP Interface Specifications This appendix is included for those who want to develop their own paging control software or add an interface for the WaveWare v9E Paging Encoder to their existing software applications. SNPP protocol is defined in RFC 1861. The V9E Paging Encoder conforms to Level 1 communications within the SNPP specification.
OPEN CONNECTION For the network interface, the Paging Encoder detects when a new socket connection occurs and outputs the 220 SNPP Gateway Ready response. For the serial port interface, the Paging Encoder detects when the serial port is opened by the host system by monitoring the RTS signal. When RTS is asserted, the Paging Encoder outputs the 220 SNPP Gateway Ready response. The server (v9E paging encoder) is now ready to accept paging requests.
Appendix L – Timed Messaging Function The Timed Messaging Function is designed to allow the WaveWare v9E Paging Encoders to be used for purposes of automatically transmitting pre-defined messages upon timer related conditions. The Timed Messaging Function can be activated during the process of programming the pager database using the WaveWare Paging Encoder Setup software. The Timed Messaging Function is available in all modes of operation.
Appendix M – Connectors and Indicators SPS-5 v9E Paging System: LED Indicators: RS-232 DB-9 Connector Pin-Out: POWER: GREEN LED – Shows Power is Applied 1 CD (not used) 2 RD (data output by paging encoder, typically required) 3 TD (data received by paging encoder, required) 4 DTR (not used) 5 GND (required) 6 DSR (signal output by paging encoder, requirement depends on host system) 7 RTS (signal input to paging encoder, required only if hardware flow control mode is active) 8 CTS (signal output by pagin
Appendix N – SITE SURVEY Some installation sites might cause paging reception problems. It might be beneficial to perform a site survey by monitoring the radio waves in the area that you want to install a system. It also might be beneficial to perform a range test to find out of the installed signal will be strong enough to be received in all of the areas you want to cover.
TROUBLESHOOTING POWER When the WaveWare v9E Paging Transmitter System is assembled and power is applied, you should be able to see a Green Power LED indicator illuminated on the Transmitter Unit. If not, verify that all connections are tight and verify that 110 VAC power is available at the power outlet. If connections are tight, power is available and the Green Power LED indicator doesn’t illuminate, determine if the Power Supply is at fault by trying another Power Supply.
This Completes the “Trouble Shooting” COPYRIGHTS/LICENSING The WaveWare v9E paging encoder contains a Microchip CPU. Following is licensing information related to the source code libraries used to create the V9E paging encoder. MICROCHIP IS WILLING TO LICENSE THE ACCOMPANYING SOFTWARE AND DOCUMENTATION TO YOU ONLY ON THE CONDITION THAT YOU ACCEPT ALL OF THE FOLLOWING TERMS.
For purposes of clarity, Licensee may NOT embed the Software on a non-Microchip Product, except as described in this Section. 3. Documentation License Grant. Microchip grants strictly to Licensee a non-exclusive, non-transferable, worldwide license to use the Documentation in support of Licensee's authorized use of the Software 4. Third Party Requirements.
termination, Licensee and Third Party will immediately stop using the Software, Documentation, and derivatives thereof, and immediately destroy all such copies. 10. Warranty Disclaimers. THE SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.