Teledesign Systems TS4000EH Radio Modem User Manual TS4000 User s Manual
Teledesign Systems Inc Radio Modem TS4000 User s Manual
Users Manual
TS4000 Radio Modem User’s Manual 1729 South Main Street Milpitas, CA 95035 (408) 941-1808 (800) 663-3674 (408) 941-1818 Fax www.teledesignsystems.com productsales@teledesignsystems.com techsupport@teledesignsystems.com Copyright This document is copyrighted by Teledesign Systems Inc. with all rights reserved. No part of this document may be reproduced in any form without the prior written consent of Teledesign Systems Inc. Copyright © 2012 by Teledesign Systems Inc. All rights reserved. Disclaimer This manual has been thoroughly reviewed for accuracy, and every effort has been made to ensure that the information is accurate and complete. However, different versions of this product have different features and capabilities, and this manual reflects only one of those versions. Therefore, Teledesign Systems Inc. assumes no responsibility for errors, omissions or defects in this material, and shall not be liable for any damages resulting from their use. The information in this document is subject to change without notice. TELEDESIGN SYSTEMS INC. MAKES NO WARRANTY OF ANY KIND WITH RESPECT TO THIS DOCUMENT AND SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Emissions FCC Part 15 The TS4000 complies with Part 15 of the FCC Rules (Code of Federal Regulations 47CFR Part 15). Operation is subject to the following two conditions: (1) This device does not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Part 90 The TS4000 has been type accepted for operation by the FCC in accordance with Part 90 of the FCC rules (47CFR Part 90). See the label on the unit for the specific FCC ID and any other certification designations. Industry Canada ICES-003 This Class B digital apparatus meets all requirements of the Canadian Interference-Causing Equipment Regulations. RSS-119 The TS4000 has been certified for operation by Industry Canada in accordance with RSS-119 of the Industry Canada rules. See the label on the unit for the specific Industry Canada certification number and any other certification designations. Notice Changes or modifications not expressly approved by Teledesign Systems Inc. could void the user’s authority to operate this equipment. Shielded cable must be used with this equipment in order to ensure that it meets the emissions limits for which it was designed. It is the responsibility of the user to obtain and use good quality shielded cables with this device. Safety Warning In order to ensure the safe operation of this radio equipment, the following practices should be observed. • • • RF Exposure DO NOT operate radio equipment near electrical blasting caps or in an explosive atmosphere. DO NOT operate any radio transmitter unless all RF connectors are secure and any open connectors are properly terminated. DO NOT allow the antenna to come close to, or touch, the eyes, face, or any exposed body parts while the radio is transmitting. In order to ensure the safe operation of this radio equipment, the minimum distance that a person should be from the attached antenna when this equipment is transmitting is 5.5 ft. (165 cm). This is based on using the TS4000 at a power of 5 watts with a 10dBd (12.1dbi) gain antenna. TS4000 Radio Modem User’s Manual Emissions iii Table of Contents Emissions ......................................................................................................iii FCC.................................................................................................... iii Industry Canada................................................................................. iii Notice.......................................................................................................iii Safety Warning .......................................................................................iii RF Exposure ...........................................................................................iii Table of Contents..........................................................................................iv TS4000 Overview ...........................................................................................1 Introduction..............................................................................................1 Features....................................................................................................1 Connections.............................................................................................3 Serial Port ...........................................................................................3 Antenna Connector .............................................................................3 Power Connection...............................................................................3 Mounting ..................................................................................................4 Configuring the TS4000 ..........................................................................4 AirTest - Data Testing .............................................................................4 Upgrading the TS4000 Firmware ...........................................................4 AirScan .....................................................................................................4 Remote Diagnostics................................................................................4 AirCalc - Range Estimation ....................................................................5 Status Lights............................................................................................6 Configuration Program..................................................................................7 Using Help................................................................................................7 System Requirements.............................................................................7 Installation................................................................................................7 TS4000 to PC Connection.......................................................................7 Programming and Retrieving Configurations ......................................8 Storing Configurations ...........................................................................8 Diagnostics ..............................................................................................9 Diagnostics Screen .............................................................................9 Modem Hardware Screen.................................................................10 Radio Hardware Screen ...................................................................10 Serial Port .....................................................................................................11 RS-232 Serial Port Basics.....................................................................11 Connectors........................................................................................11 DCE vs. DTE.....................................................................................11 Asynchronous Data ..........................................................................11 Flow Control......................................................................................11 Serial Port Connector ...........................................................................12 Signal Levels..........................................................................................12 Signal Options .......................................................................................12 RI Pin Signal Options........................................................................13 DSR Pin Signal Options....................................................................13 DTR Pin Signal Options ....................................................................13 Configuration Options – Serial Port 1 .................................................14 Serial Port 2............................................................................................18 Radio Setup ..................................................................................................21 TS4000 Radio Modem User’s Manual Table of Contents iv Configuration Options ..........................................................................21 Clear Channel Scan..........................................................................23 Redundancy......................................................................................23 Frequency Programming......................................................................26 Methods of Programming Channels .................................................26 Frequency Configuration Screen ......................................................27 Channel Switching ................................................................................28 Channel Change with a Control String .............................................28 Compatibility..........................................................................................29 AirNet Packet Protocol ................................................................................31 Overview.................................................................................................31 Configuration Options ..........................................................................33 Packet General .................................................................................33 Packet for Port 1 / Packet for Port 2 .................................................36 Control and Status Strings...................................................................40 Control Strings ..................................................................................40 Status Strings....................................................................................41 Master-Slave System Setup .................................................................42 Setting Packet Timeout.....................................................................42 Data Packet Transmit Time ..............................................................43 Polled System with Store and Forward Repeaters ............................44 Single Repeater System ...................................................................45 Dual Repeater System......................................................................47 Three Repeater System....................................................................49 Chain Repeater System....................................................................52 Other System Topologies .................................................................54 CSMA System Setup .............................................................................55 Basic System - Setup Summary .......................................................55 System with Repeaters - Setup Summary........................................56 Setting Slot Time...............................................................................58 Setting Min Idle Slots ........................................................................58 Setting Tx Index ................................................................................59 Setting Packet Timeout.....................................................................61 Data Packet Delay ............................................................................62 GPS Configuration.......................................................................................64 Configuration Options ..........................................................................64 Testing ..........................................................................................................67 AirTest ....................................................................................................67 Data Test ..........................................................................................67 BER Test...........................................................................................68 AirScan ...................................................................................................69 AirScan Controls ...............................................................................69 Remote Diagnostics ....................................................................................70 Remote Diagnostics with Repeaters ................................................70 Remote Diagnostics Screen .............................................................70 Remote Diagnostic Controls .............................................................70 Remote Diagnostics Request and Response Strings ......................72 Upgrading Firmware....................................................................................73 Upgrading...............................................................................................73 Licensing ......................................................................................................74 User’s License .......................................................................................74 TS4000 Radio Modem User’s Manual Table of Contents USA (FCC)........................................................................................74 International ......................................................................................75 Manufacturer’s Certification ................................................................75 USA (FCC)........................................................................................75 Industry Canada................................................................................75 International ......................................................................................75 Service and Support ....................................................................................76 Contacting Teledesign..........................................................................76 Returning Equipment............................................................................76 Warranty........................................................................................................77 Appendix A - Serial Ports............................................................................78 Standard Case .......................................................................................78 Serial Port 1 Pinout ...........................................................................78 Serial Port 2 Pinout ...........................................................................78 Watertight Case .....................................................................................78 Pinout ................................................................................................78 Standard RS-232 Serial Port Pinout ....................................................80 Standard Usage of the RS-232 Control Signals .................................80 Signal Levels..........................................................................................81 Appendix B – ASCII Character Set.............................................................82 Appendix C – Control and Status Strings .................................................83 General Strings .................................................................................83 Frequency Control Strings ................................................................83 Modem Configuration Strings ...........................................................83 Packet Strings...................................................................................84 Diagnostics Strings ...........................................................................86 Appendix D – Internal Jumper Block .........................................................89 Factory Default Jumper Settings ......................................................89 Instructions for Accessing the Jumpers............................................89 Jumper Settings for Power on Serial Port 1 - Pin 9 ..........................90 Jumper Settings for Power on Serial Port 1 - Pin 4 ..........................90 Jumper Settings for Power on Serial Port 2 - Pin 9 ..........................91 Jumper Settings for TTL Levels on Serial Port 1..............................91 TS4000 Radio Modem User’s Manual Table of Contents vi TS4000 Overview Introduction The TS4000 Radio Modem is an integrated radio and modem designed for the wireless transmission of digital data. The TS4000 can transfer data at rates up to 12,600 bits per second. The TS4000 includes a synthesized VHF or UHF transceiver that can be programmed for up to 99 channels. This product is ideally suited to OEMs and system integrators who require a versatile radio modem in a single package. The TS4000 is configured with windows based PC configuration software. Features Main Features High speed channel rates up to 12,600 bits per second. Selectable operating modes for transparent and packet data operation. High efficiency switching voltage regulator provides a wide input voltage range and uses minimum power regardless of the input voltage. Provides addressed communications for devices that are not directly addressable themselves. Includes store-and-forward data repeating for wide area coverage. Provides two individually configurable data ports. Supports data activation (three wire) and RTS/CTS handshake protocols. Configurable RF output power levels. Programmable receive sensitivity level (squelch) for use on noisy channels. Watertight case option for outdoor use and marine installations. Clear Channel Scan - The TS4000 will automatically and dynamically select the best channel for communication without intervention from the host equipment. Automatic CW Station ID - The TS4000 can be configured to periodically transmit a Morse code station ID. Remote Diagnostics allows the status of remote TS4000s to be checked over the air. Flexible Data Interface Two highly configurable user data serial ports. Serial ports support connection to virtually any asynchronous user device. Full handshake and data activation modes supported on serial port 1. Data activation mode requires only receive and transmit data lines for full communication with user device. Data rates from 1200 to 38,400 baud. RS-232, RS-485 or TTL signal levels. Using Serial Port 2 for data is a firmware upgrade option which is available for all TS4000s. Contact Teledesign for pricing. Integrated RF Transceiver Synthesized transceivers cover VHF and UHF bands. Programmable RF output power levels. Channel frequencies are stored in internal flash memory and are selectable on-the-fly using simple ASCII command strings. Selectable Channel Protocols User selectable scrambling codes for private network communications. Optional Forward Error Correction (FEC) using block coding and interleaving corrects channel induced errors. User selectable transparent or AirNet packet data transfer modes. TS4000 Radio Modem User’s Manual TS4000 Overview Integrated AirNet Packet Data Protocol Allows user directed transmissions to only selected destinations. Provides addressed communications for devices that are not directly addressable themselves. Can be optimized for point to point, point to multi-point and full mesh networks. Supports group and all-call broadcast transmissions. Built in CSMA/CA algorithm minimizes transmission collisions to maximize channel efficiency and utilization. Individual TS4000s can be configured as store-and-forward data repeaters to extend radio network coverage. Remote Diagnostics Allows the status of remote TS4000s to be checked, over the air, from any other TS4000. Parameters include: RSSI (inbound, outbound and repeater), Input Voltage, Radio Voltage, Temperature, Path (direct of through one or more store and forward repeaters), and Transmit Power (not available on all units). Allows for the test and verification of a system independent of host equipment (RTU, GPS, etc,). Provides easy determination of the radio coverage and signal quality between TS4000s. Available while the system is in normal operation. Can be used through Serial Port 1 or Serial Port 2 of the TS4000. Windows display software provided, free of charge, with the TS4000 Configuration Software. Remote Diagnostics function is available to other equipment through the use of control strings. Upgrade available for all TS4000s. Contact Teledesign for pricing. PC Configurable Windows based configuration software provides quick setup and testing. Flash memory program storage allows for easy in field firmware upgrades. AirTest is included with the TS4000 configuration program. AirTest is a general purpose wireless modem test program which can be used to verify operation and to gather performance statistics (BER) about the link between modems. Rugged and Reliable Optional watertight housing and connections designed to withstand abuse from field and marine use. External interfaces protected against voltage transients, reverse polarity, electrical shorts and high VSWR. Two year warranty. Free technical support provided during all phases of installation and use. TS4000 Radio Modem User’s Manual TS4000 Overview Connections The TS4000 has two serial ports that provide a data connection between the TS4000 and the host equipment. The serial ports are standard RS-232 asynchronous serial interfaces and are setup as DCEs. The serial ports provide all the standard RS-232 handshake lines. In addition, the TS4000 provides a number of configuration options that allow the serial port line usage to be customized for different host equipment (see Serial Port Configuration Options). Serial Port Signal Levels Standard Case Antenna Connector Serial port 1 can be configured for either RS-232 or TTL signal levels. To change the signal level setting, the modem must be opened and the four jumper plugs next to the serial port connector moved to the desired position (See Appendix A - Serial Port, Appendix F - Internal Jumper Block). The serial port connectors are standard 9 pin subminiature D with female pins. These ports can be mated to with standard PC serial cables. To minimize emissions and interference, the serial cables used should be good quality shielded cable (See Appendix A - Serial Port). A variety of antennas can be used with the TS4000, but it is important that the antenna provides a 50 ohm load at the radio’s operational frequencies. In addition, all cabling used with the antenna must be good quality coaxial cable with 50 ohm impedance. Caution: The modem should never be allowed to transmit without an antenna or dummy load attached to the antenna connector. Power Connection Switching Regulator Power Supply Current The TS4000 requires a DC supply voltage between 12 and 24 volts. Note that the minimum supply voltage depends on the particular radio module in the TS4000. In addition, the power (watts) used by the TS4000 also depends on the particular radio module. Internally, the TS4000 has a high efficiency switching voltage regulator (as opposed to a linear voltage regulator). The switching regulator minimizes the amount of power that the TS4000 requires. Also, the power required (watts) is independent of the input supply voltage. The power supply current required depends on the input voltage used. This can be calculated with the following formula. Max Power Supply Current (amps) = Max Power (watts) / Input Voltage Example Max Power = 10 watts (The actual value depends on the particular radio module in the TS4000). Power Supply Voltage = 20 volts Max Power Supply Current = 10 / 20 = 0.5 amps Standard Case With the standard case power can be connected through either the power connector or one of the serial port connectors. The power connector is a 2 pin Molex Micro-Fit 3.0 (Molex P/N 43045-0202) with pin 1 as ground and pin 2 as power. The mating plug for this connector is a Molex P/N 43025-0200. See the Serial Port section for details on connecting power through the serial ports. TS4000 Radio Modem User’s Manual TS4000 Overview Fuses The TS4000 has an internal 4 amp fuse for each of the three possible power connections. The power source used with the TS4000 should also be fused with an in-line power fuse. Mounting The preferred method of mounting the TS4000 is to use the mounting bracket supplied with the modem. An alternative is to use the threaded mounting holes in the bottom of the TS4000 (see Appendix D - Case Dimensions). Configuring the TS4000 The TS4000 is supplied with a windows based PC configuration program. Configuring the TS4000 consists of configuring the modem operating parameters and also configuring the frequency channels. For details on how to load and start the configuration program see Installation in the TS4000 Configuration Program section. Making selections with the controls on the various configuration screens sets a configuration. Once set, configurations can be programmed into the TS4000. In addition, configurations can be retrieved from the TS4000. Configurations can also be stored and recalled as PC files. Details about the configuration controls are available later in this manual and in the on line help of the configuration program. AirTest - Data Testing Teledesign provides general-purpose wireless modem test software called AirTest. AirTest can send data and gather performance statistics, including BER (Bit Error Rate), about the link between two modems. AirTest is accessed with the AirTest button on the main screen of the configuration program (See Testing - AirTest). Upgrading the TS4000 Firmware The TS4000 comes with flash program memory that allows the firmware to be easily upgraded in the field. Firmware is upgraded with the upgrade program which is included as part of the TS4000 configuration program. The upgrade program is started with the Upgrade Firmware button on the main screen of the configuration program (See Upgrading Firmware). AirScan AirScan is a program that comes with the TS4000 configuration program and enables the TS4000 to be used as a frequency scanner. AirScan is useful for determining the frequency and magnitude of potential interference within the TS4000’s frequency band. AirScan is started with the AirScan button on the main screen of the configuration program (See Testing - AirScan). Remote Diagnostics Remote diagnostics is used to check the status of remote TS4000s over the air. This allows the radio communication to be setup and tested independent of the host equipment. Remote diagnostics is an extra cost firmware option which can be used with any TS4000. The remote diagnostics firmware option upgrade is accomplished the same way as a standard firmware upgrade (see Upgrading Firmware). Please contact Teledesign for ordering information. The remote diagnostics can be accessed using the Remote Diagnostics screen in the TS4000 Configuration Program and can be operated through either serial port. For more details see Remote Diagnostics. TS4000 Radio Modem User’s Manual TS4000 Overview AirCalc - Range Estimation Teledesign provides wireless range estimation software called AirCalc. AirCalc provides estimates of the flat terrain range of wireless data communication systems. Actual range of a system can vary dramatically, and therefore it is important that range is verified with in field tests in the area of operation. AirCalc is accessed with the AirCalc button on the main screen of the configuration program. TS4000 Radio Modem User’s Manual TS4000 Overview Status Lights The TS4000 has three lights (LED) indicators to provide operational status of transmit (TX), receive (RX) and power (PWR) functions. Special combinations of these indicators are used to indicate secondary operating modes and fault conditions. TS4000 State Normal Operation LEDs PWR Indicator State On when the TS4000 is powered. RX On when the TS4000 detects activity on the radio channel. TX On when the TS4000 is transmitting. Program Mode RX, TX Both on continuously. Reset RX, TX Flash together four times. Although the reset indication takes about four seconds to complete, the TS4000 is fully operational when the flashing begins. Transmit Test Mode TX Flashes for the duration of the test. Invalid Frequency Channel Fault RX, TX Alternately flash. Transmit Buffer Overflow TX Flashes between 6 and 16 times for each occurrence depending on the details of the overflow Receive Buffer Overflow RX Flashes between 6 and 16 times for each occurrence depending on the details of the overflow Diagnostics Fault PWR Flashes for the duration of the fault. This fault occurs if the TS4000 is set for a channel that does not have a valid frequency programmed. In this mode the TS4000 has detected a fault but continues to operate. Operation may be unreliable due to the fault. The most common cause of this state is an out of range power source. The source of the fault can be diagnosed with the configuration program (see TS4000 Configuration Program, Diagnostics). Catastrophic Fault RX, TX Alternately flash until the fault is cleared and the TS4000 is reset. In this mode the TS4000 has detected a catastrophic fault and is non-operational until the fault is corrected. The source of the fault can be diagnosed with the configuration program (see TS4000 Configuration Program, Diagnostics). TS4000 Radio Modem User’s Manual TS4000 Overview Configuration Program The configuration program is used to configure the TS4000 for operation. Configuring the TS4000 consists of independently configuring both the modem operation and the radio frequency channels. The configuration program consists of controls and menus. The controls set the configuration and test options. The menus (line items at the top of the screen) execute program commands. In addition to configuring the TS4000, the configuration program provides access to AirTest (wireless modem test software), AirCalc (wireless range estimation), AirScan (frequency scanning), TS4000 firmware upgrade program (see Testing, Upgrading Firmware) and remote diagnostics (see Remote Diagnostics). Using Help The configuration program has on-line help that contains information on how to use the program and also detailed information on specific controls and menus. Help is accessed by selecting a command from the help menu, pressing the question button or pressing the F1 key. System Requirements Installation 1) Put the CD-ROM in the PC. 2) Run the installation program. 3) Follow the installation instructions. TS4000 to PC Connection Serial Cable To transfer configurations between the TS4000 and a PC, their serial ports must be connected together. The serial cable used should be a standard straight through (i.e. pin 1 to pin 1, pin 2 to pin 2, etc) serial cable. This is the same type of cable used to connect a PC to a standard phone modem (See Serial Port). Software Connection Personal computer using a 486 or faster Microsoft Windows 95 or later CD-ROM disk drive. Before configurations can be retrieved from and programmed into the TS4000 the configuration program must connect to the TS4000. To connect, select the Connect to Modem command from the Modem menu or press the Connect to Modem button. Connecting to the TS4000 puts it into program mode which is indicated by the Rx and Tx lights remaining on continuously. When connected to the TS4000 the configuration program may disable (lighter shade) some of the controls. These disabled controls are options that are not available with that particular TS4000's version of firmware. These controls are re-enabled when the connection is broken (using the Disconnect command from the Modem menu or the Disconnect button). TS4000 Radio Modem User’s Manual Configuration Program Programming and Retrieving Configurations The configuration of the TS4000 can be read out of the modem by selecting the Retrieve Configuration command from the Modem menu or by pressing the Retrieve Configuration button. To program a configuration into the TS4000, use the Program Configuration command from the Modem menu or the Program Configuration button. CAUTION: Programming a configuration into the TS4000 will write over (destroy) the configuration currently in the TS4000. To avoid losing the TS4000’s configuration information, save the configuration by retrieving it and then saving it as a PC file. Storing Configurations Configurations can be stored and recalled as PC files. This is done using the commands under the File menu or the corresponding buttons. Command New/Default Action Create a new file with default values. New/Default GPS Create a new GPS file with default values. The GPS file is a stripped down version with just the controls needed for GPS applications. Open Open a previously stored file. The user is prompted with a directory and file list. Close Close the active file. Save Save the active file under the current name. Save As Save the active file under a different name or in a different directory. The user is prompted with a directory and file list. Convert to Converts the file between the GPS and standard format. Recent File List This shows the last ten open files. A file can be recalled by selecting its name from the list. TS4000 Radio Modem User’s Manual Configuration Program Diagnostics The configuration program can access diagnostics information from the TS4000. This is done using commands under the Modem menu or the corresponding buttons. Diagnostics Screen Choose the Diagnostics menu to run, read and display diagnostic status of the TS4000. The diagnostics tests the major components of the modem and also monitors the power supply voltages. TS4000 Radio Modem User’s Manual Configuration Program Modem Hardware Screen Choose the Retrieve Modem Hardware menu to read and display the modem hardware details. These include details on the firmware version and memory configuration. These modem hardware values are set at the factory based on the modem hardware included in the TS4000 and cannot be changed. Radio Hardware Screen Choose the Retrieve Radio Hardware menu to read and display the radio hardware details. This includes details about the radio’s frequency, channel spacing and transmit power. These values are set at the factory based on the radio hardware included in the TS4000 and cannot be changed. TS4000 Radio Modem User’s Manual Configuration Program 10 Serial Port The serial port provides an asynchronous data connection between the TS4000 and the host equipment. The TS4000 serial port is a standard RS-232 serial port with a number of options to allow connection to a wide variety of serial host equipment. RS-232 Serial Port Basics The EIA (Electronic Industries Association) RS-232C standard is a standard for short distance (less than 50 feet) serial communications. The standard defines the electrical signal levels, interface characteristics and the operation of the control signals (handshake lines). Although the standard defines the operation of the handshake lines, there is significant variation in the way these signals are used by different equipment. Connectors The RS-232 standard does not require the use of a specific connector. However, most asynchronous RS-232 serial ports use either a 9 pin or 25 pin subminiature D connector. The same signals are provided with both connectors, but of course the pinouts are different (see Appendix A - Serial Port). DCE vs. DTE RS-232 serial ports come in two varieties - DCE (Data Communication Equipment) and DTE (Data Terminal Equipment). This defines the direction of the serial port’s lines (driven or received). It also typically defines the polarity of the connector. DCEs typically use female pin connectors and DTEs typically use male pin connectors. Connecting a DCE port to a DTE is the most common setup and requires a standard straight through cable (i.e. pin 1 to pin 1, pin 2 to pin 2, etc.). When connecting two DCEs or two DTEs together a null modem cable is required. The purpose of a null modem cable is to cross connect the appropriate signals. However, null modem cables are not all the same and therefore it is important to verify that a specific cable is appropriate for a specific application. Asynchronous Data The TS4000 is designed to work with asynchronous serial ports. Asynchronous ports do not use clocks or timing signals to synchronize data transfers. Instead data is framed into asynchronous characters which the ports synchronize to. An asynchronous character consists of a start bit, data bits and stop bits. The start bit indicates the beginning of a character. The number of data bits varies, but is typically between 7 and 9 bits. The data bits sometimes include a parity bit that provides error check information with each character. The number of stop bits also varies but is typically 1 or 2 bits. Flow Control Hardware Flow Control Flow control is the method for controlling the flow of data between the DCE and DTE. Flow control is used to prevent the DTE and DCE data receive buffers from overflowing. There are several different methods used for flow control and as with everything related to RS-232 there is no one standard. The two main variations of flow control are hardware flow control that utilizes the RS-232 handshake lines and software flow control that utilizes characters sent along with the normal data. Hardware flow control typically uses two control lines, one for each direction of data. When a port activates its flow control signal it is indicating its readiness to receive data. Deactivating the flow control signal indicates that the port can no longer receive data because its buffer is full or close to full. TS4000 Radio Modem User’s Manual Serial Port 11 The most common form of hardware flow control, and the one used by most full duplex wired (as opposed to wireless) modems, is RTS/CTS. With RTS/CTS flow control, RTS provides flow control for the DTE and CTS provides flow control for the DCE. One problem with RTS/CTS flow control is that for many half duplex modems (most wireless modems) the RTS signal is used to frame transmit data going from the DTE to the DCE. This use of RTS conflicts with using RTS for flow control of data to the DTE. An alternative form of hardware flow control is DTR/DSR. With DTR/DSR flow control, DTR provides the flow control for the DTE and DSR provides the flow control for the DCE. Software Flow Control Software flow control uses characters sent over the data lines to control data flow. These characters are sent along with the normal flow of data between the DTE and DCE. There is typically one character that is used to stop the flow of data and a different character to restart data flow. Software flow control can use any characters to start and stop flow. However the most common characters used are the ASCII XON (starts flow) and XOFF (stops flow) characters. Because these are the most common characters used, software flow control is often referred to as XON/XOFF flow control. The ASCII XON character is the decimal character 17 (0x11 hex) and is also known as DC1 or Ctrl-Q. The ASCII XOFF character is the decimal character 19 (0x13 hex) and is also known as DC3 or Ctrl-S (See Appendix B - ASCII Character Set). A problem with software flow control is that the normal data passed over the communications link cannot include the flow control characters. If it does, the flow of data will be incorrectly stopped or started. This limits the characters that can be used by the host application and also prevents the sending of binary (all character numbers) data. The TS4000 serial ports are setup as DCEs (Data Communication Equipment). The TS4000 with the standard case uses two 9 pin subminiature D connectors with female pins for the serial ports. The TS4000 with the watertight case uses a 19 pin environmentally sealed LEMO connector (see Appendix A - Serial Port). Serial Port Connector Signal Levels Serial Port 1 Serial Port 2 RS-485 Signal Options Serial port 1 can be configured for either RS-232 or TTL signal levels. To change the signal levels, the modem must be opened and the four jumper plugs next to the serial port connector set to the desired position (see Appendix A Serial Port, Appendix F - Internal Jumper Block). Serial port 2 is always set for RS-232 signal levels. The serial ports can be used with RS-485 signal levels through the use of an external signal converter. These external signal converters can be obtained from Teledesign. The serial ports can be setup to provide different internal electrical connections to the DTR, DSR and RI pins. To change the pin connections, the modem must be opened and the jumper plugs next to the serial port connector set to the desired position (see Appendix F - Internal Jumper Block). TS4000 Radio Modem User’s Manual Serial Port 12 RI Pin Signal Options RI for Modem Power RI Connected for DSR DSR Pin Signal Options DSR Always High DTR Pin Signal Options DTR for Modem Power The RI (Ring Indicator) pin is pin 9 of a standard 9 pin subminiature D connector and is an output for DCEs (the TS4000). The TS4000 has no internal RI signal and therefore the RI pin is normally left unconnected. As an alternative, the RI pin can be connected as a power pin into the TS4000. This is non-standard use of this pin and therefore care should be taken when connecting the TS4000 to other serial devices. For most serial devices this is not a problem because RI is a modem (DCE) output and the TS4000 power supply mostly falls within the allowed voltage range for RS-232 signals. Therefore the power voltage on this pin is interpreted as an active RI signal. For systems that use the RI signal differently, or cannot operate with power on this pin, this pin should be disconnected between the TS4000 and the host equipment. As an alternative, the RI pin can be connected to the internal DSR output signal. The DSR (Data Set Ready) pin is pin 6 of a standard 9 pin subminiature D connector and is an output for DCEs (the TS4000). For the TS4000, the DSR pin is normally connected to the internal DSR output signal. As an alternative, the DSR pin can be set to always be in the active high state. In this case it is internally connected to +5 volts through a 1 K ohm resistor. The DTR (Data Terminal Ready) pin is pin 4 of a standard 9 pin subminiature D connector and is an input for DCEs (the TS4000). For the TS4000, the DTR pin is normally connected to the internal DTR input signal. As an alternative, the DTR pin of serial port 1 can be connected as a power pin into the TS4000. This option is only available for serial port 1. Caution: The use of the DTR pin for power is non-standard. Therefore the TS4000 serial port must not be connected to a standard serial device that drives the DTR pin (i.e. a PC). Connecting a TS4000, that is configured for power through the DTR pin, to a device that drives the DTR pin can result in the power supply voltage of the TS4000 being shorted to the DTR output of the host serial port. This could damage to the host device. Therefore, when connecting the TS4000 to a PC for configuration, make sure that the cable does not have a DTR (pin 4) connection. TS4000 Radio Modem User’s Manual Serial Port 13 Configuration Options – Serial Port 1 Baud Rate List Data Bits Parity Transmit Data Protocol The serial port provides a number of configuration options that allows it to be connected to virtually any asynchronous host equipment. These configuration options are set using the Serial Port tab of the Modem Configuration. The baud rate list provides selection of the serial port asynchronous baud rate. The available selections are 300, 1200, 2400, 4800, 9600, 19200 and 38400 baud. These options set the number of data bits in each asynchronous character. These options set the parity of the asynchronous characters. Selection Hardware Handshake Description In this mode the RTS handshake line is used to frame transmit data into bursts. The TS4000 burst begins when RTS is activated and at least one character (non-control string) is received. Transmission ends when RTS goes inactive and the burst has been completely transmitted. Data Activation This mode uses a character timer to frame the transmit data into bursts. The TS4000 burst begins when one character (non-control string) is received. The transmit burst is completed when the transmit data line is idle (no data) for the number of character periods defined by the data activation timeout control. TS4000 Radio Modem User’s Manual Serial Port 14 Selection Data Activation Timeout (Timeout Time) Description This control sets the number of character periods of idle required on the serial port's transmit data line to declare the end of a transmit burst. Char Period = Char Length / Baud Rate Where: Char Length = Data Bits + Parity + 2 Data Bits is the value selected from the Data Bits control. Parity is 0 if none is selected from the Parity control and 1 if even or odd is selected. The 2 added to the accounts for the start and stop bits of an asynchronous character. Baud Rate is the value selected from the baud rate list. RTS Control of Sleep Mode Wait For Complete Burst Before Beginning Transmission When this is active RTS is used to control sleep mode. When RTS is inactive, the modem will enter sleep mode until RTS is activated. This option only has effect only in transparent (non-packet) mode. In packet mode the TS4000 always waits for a complete burst before beginning transmission. Selection Disabled Description The modem begins transmitting as soon as it receives the first non-control character of a transmit burst. Enabled The modem waits for a complete transmit burst before it begins transmitting. TS4000 Radio Modem User’s Manual Serial Port 15 Receive Data Protocol Selection Idle Time Between Bursts Description This sets the minimum amount of time (in character periods) that the receive data (RXD) line will be idle (inactive) between received bursts of data. If this value is set to zero, the receive data line may remain active continuously when multiple bursts of receive data are transferred to the host. If the DCD line option is set for the Active when Sending Receive Data to the User then the DCD line will also be inactive during the receive data line idle times. DTR Enabled for Receive Data Flow Control When enabled, DTR acts as flow control for receive data coming from the TS4000 to the host. When DTR is inactive, data received by the TS4000 is stored in an internal buffer and inhibited from being sent to the host equipment. The flow of receive data out of the serial port resumes when DTR is activated. Provide RSSI at Receiver When this control is activated, the RSSI (Receive Signal Strength Indication) of the received packet is sent as a prefix string to the data. The string is made up of ASCII characters as follows: +TSRxxx where xxx = receive signal level in –dBms (i.e. +TSR087 = a –87dBm signal level) Note that because the value is in –dBms (negative dBms) a larger receive signal is represented with a smaller 3 digit number. DCD Line Control Selection Active when Sending Receive Data to the User Description DCD is active when receive data is sent out of the TS4000 via the serial port. Active when Receiving DCD is active when the TS4000 detects a signal on the radio channel. This mode can be used to remote the receive light. Both DCD is active when either receive data is being sent out the serial port or when a signal is detected on the radio channel. Note that for most conditions and configurations these states overlap. TS4000 Radio Modem User’s Manual Serial Port 16 CTS Line Control DSR Line Control Selection Always Active Description The CTS line is active. Active when Transmitter is Sending Data CTS is normally inactive and is activated when the TS4000 is transmitting and the radio channel is ready for the transmission of data. Active when Transmitting CTS is normally inactive and is activated when the TS4000 is transmitting. Note that the modem begins transmitting only after it has received at least one character (non-control string) of data. This selection can be used to remote the transmit light. Delayed RTS CTS is normally inactive and is activated a fixed time after RTS becomes active. The time is controlled with the RTS to CTS delay value. Deactivate when Transmit Buffer is Full When this is enabled, CTS is deactivated when the transmit buffer is full. This setting effects all of the above options. Selection Active when Operational Description DSR is active when the TS4000 is powered and has passed self test. Active when Transmitting DSR is active when the TS4000 is transmitting. This selection can be used to remote the transmit light. Active when Receiving DSR is active when the TS4000 detects a signal on the radio channel. This mode can be used to remote the receive light. TS4000 Radio Modem User’s Manual Serial Port 17 Serial Port 2 Serial Port 2 Enable Selection Enable Serial Port 2 for Data Description This enables serial port 2 for transmitting and receiving data. This does not effect using serial port 2 for configuration and remote diagnostics. Serial port 2 can only be used in packet mode (transparent mode is not available). i) This function is an extra cost firmware option. Please contact Teledesign for information on purchasing and enabling this option. ii) This feature requires firmware version 6.00 or higher. iii) This feature also requires that Enable Packet Operation on the Packet General tab to be checked. Available for Configuration TS4000 Radio Modem User’s Manual This option box cannot be set by the user. When this is checked it indicates the firmware is a version (5.00 or higher) that supports the use of Serial port 2 for configuration of the modem, control of the modem operation and for diagnostics. Serial Port 18 Selection Available for Remote Diagnostics Description This option box cannot be set by the user. When this is checked it indicates that the remote diagnostics firmware option is enabled (see Remote Diagnostics). i) This function is an extra cost firmware option. Please contact Teledesign for information on purchasing and enabling this option. ii) This function also requires version 5.00 or higher firmware. iii) Remote diagnostics also requires that AirNet packet operation is enabled (see AirNet Packet Protocol). Baud Rate List Data Bits Parity Transmit Data Protocol The baud rate list provides selection of the serial port asynchronous baud rate. The serial port 2 baud rate is fixed at 9600 baud. The number of data bits for serial port 2 is fixed at eight. The parity of serial port 2 is fixed at no parity. Selection Data Activation Description This mode uses a character timer to frame the transmit data into bursts. The TS4000 burst begins when one character (non-control string) is received. The transmit burst is completed when the transmit data line is idle (no data) for the number of character periods defined by the data activation timeout control. Timeout Time This control sets the number of character periods of idle required on the serial port's transmit data line to declare the end of a transmit burst. Char Period = Char Length / Baud Rate Where: Char Length = Data Bits + Parity + 2 Data Bits is the value selected from the Data Bits control. Parity is 0 if none is selected from the Parity control and 1 if even or odd is selected. The 2 added to the accounts for the start and stop bits of an asynchronous character. Baud Rate is the value selected from the baud rate list. Receive Data Protocol – Idle Time Between Bursts This sets the minimum amount of time (in character periods) that the receive data (RXD) line will be idle (inactive) between received bursts of data. If this value is set to zero, the receive data line may remain active continuously when multiple bursts of receive data are transferred to the host. If the DCD line option is set for the Active when Sending Receive Data to the User then the DCD line will also be inactive during the receive data line idle times. DCD Line Control – Active when Radio Carrier Detected DCD is active when the TS4000 detects a signal on the radio channel. This mode can be used to remote the receive light. TS4000 Radio Modem User’s Manual Serial Port 19 CTS Line Control – Active when Transmitting CTS is active when the TS4000 is transmitting. This selection can be used to remote the transmit light. DSR Line Control – Active when Operational DSR is active when the TS4000 is powered and there are no active faults. An active fault is indicated by a flashing power light. TS4000 Radio Modem User’s Manual Serial Port 20 Radio Setup The radio setup requires setting the modem configuration options and also setting the radio frequencies. The modem configuration options are accessed on the Radio tab of the Modem Configuration. The frequency programming is accessed with the Frequency Configuration button on the main screen of the configuration program. Configuration Options Modulation The radio configuration options set the operation of the radio. These configuration options are set using the Radio tab of the Modem Configuration portion of the configuration program. Selection Occupied Bandwidth Description The occupied bandwidth sets the amount of frequency bandwidth that the transmitted signal will use. A higher value corresponds to more bandwidth and therefore provides better BER (Bit Error Rate) performance. The occupied bandwidth must be set to equal to or lower than the occupied bandwidth that is allowed for the channels in use. For operation in FCC jurisdictions, the occupied bandwidth is fixed (not user configurable) at 11.2KHz which is the maximum bandwidth allowed for 12.5KHz channels. GMSK (BT=0.3) Gaussian Minimum Shifted Keyed modulation with a BT = 0.3. This is more spectrally efficient than GSMK (BT=0.5) modulation. TS4000 Radio Modem User’s Manual Radio Setup 21 Selection GMSK (BT=0.5) Description Gaussian Minimum Shifted Keyed modulation with a BT = 0.5. This is the least spectrally efficient modulation. However, it provides the best BER for a given receive signal level. Rate The over the air modulation bit rate. All TS4000s that communicate together must use the same setting. Lower settings result in better signal demodulation which results in a better (lower) BER (Bit Error Rate) for a given receive signal level. The maximum rate that can be set depends on the settings of occupied bandwidth and modulation type Receive Carrier Detect Level This sets the receive signal level at which the receiver is activated. This is similar to the squelch control on mobile radios. Normally this level is set slightly lower than the level at which the TS4000 can correctly demodulate the incoming data. When using the TS4000 in a high noise environment, this level can be raised so that the TS4000 is more selective about the signals that it attempts to demodulate. This is important for configurations that do not allow the TS4000 to transmit while it is receiving. These include configurations with packet operation enabled or with the Force Transmit over Receive control disabled. Automatic Station ID The TS4000 can be configured to periodically output a Morse code identification string. Selection Enable Automatic Station ID Repeat Time ID Message Frequency Channel at Power Up Description When the control is selected, the modem will output the ID message at the designated repeat time. This is the amount of time between station ID transmissions. This is the text message that is transmitted. The transmission is formatted as standard Morse code. This is typically set to be a station call sign, license number or location. Selection Active Channel at Power Down Description The channel activated at power up is the channel that was active when the modem was last powered down. Port 2 Handshake Lines The channel is controlled by the handshake input lines of serial port 2 according to the table below. Fixed Channel TS4000 Radio Modem User’s Manual RTS Low Low High High DTR Channel Low 1 High 2 Low 3 High 4 The channel activated at power up is the channel set in the corresponding control. Radio Setup 22 Clear Channel Scan Clear Channel Scan Activates Clear Channel Scan Operation (see below). Channel List The bottom box is the scan list which indicates the channels that will be scanned. Channel Box, Add Button, Delete Button These controls are used to change the channel numbers in the channel list. CCS Remote Operation When this is checked the TS4000 will transmit on the same channel that it last received a packet from another TS4000. The bottom box is the scan list which indicates the channels that will be scanned. The scan list can be changed with the channel box, add button and delete button. This function is useful for systems where a unit (the CCS Remote) needs to respond back to another TS4000 that is at an advantaged site (a site that has wide radio coverage and therefore can hear interference that the CCS Remote does not hear). By transmitting back on the same channel as the advantaged unit, the CCS Remote unit minimizes the likelihood that it chooses a channel with interference. When Clear Channel Scan operation is enabled, the TS4000 will automatically and dynamically select the least congested channel from the clear channel scan list. This operation is completely transparent to the host equipment and does not require any operator intervention. When clear channel scan is enabled, all of the TS4000s (both transmitters and receivers) constantly scan the channels of the scan list looking for valid TS4000 transmissions and also looking for interference (noise or transmissions from other sources). The TS4000s keeps track of the amount of interference on each channel. Before transmitting, a TS4000 will select the best channel and switch to the channel with the least amount of interference. The receiving TS4000s will then see this valid TS4000 transmission during their scans and receive the packet. To insure that receiving TS4000s have time to detect and lock up to the transmissions, the transmit preamble time is increased based on the number of channels on the scan list. Note that the transmit attack time can be read out of the modem with the Retrieve Radio Hardware command. Redundancy For systems that require very high reliability at some or all sites, Teledesign has a Redundancy Switch that provides hot standby redundancy for the TS4000. The Redundancy Switch requires two TS4000s and can be used with one or two power supplies and one or two external amplifiers. When using the TS4000s with the Redundancy Switch, the TS4000s can be configured with any of the options. However, it is essential that the two redundant modems are configured identically except of the Enable Redundancy settings. TS4000 Radio Modem User’s Manual Radio Setup 23 Selection Enable Redundancy Description This configures the TS4000s for use with the Redundancy switch. Redundant Modem A The TS4000 that is connected to the A side of the redundancy switch must have this option checked. Redundant Modem B The TS4000 that is connected to the B side of the redundancy switch must have this option checked. For redundant modems used in packet mode, the modems will consume two individual packet addresses. The first address is the value configured on the Packet for Port tab under Modem Address – Individual. The second is an individual address 1 number higher. This is done automatically by the TS4000s and the Individual Address must be configured the same for both redundant modems. It is essential that the second address is not used by any other modem in the network. For additional information please reference the Redundancy Switch User’s Manual. Sleep Selection Enable Sleep for Low Voltage Description With this enabled the modem will go into sleep mode when the input power drops below the sleep voltage. Sleep Voltage The voltage which puts the modem into sleep mode. In sleep mode the status lights will be off with the exception of the power light which will flash briefly every several seconds. Wake Up Voltage Once the modem is in sleep mode it will remain until the input voltage rises above this voltage. When the modem wakes up the Rx and Tx lights will flash together three times. Coding (FEC) Data Scramble Code Selection Disabled Description This minimizes the amount of overhead required to send data. Enabled Transmit data is block coded (12,8 Hamming) and interleaved (16 bits). This provides forward error correction (FEC) for strings of errors up to 16 bits long. Coding requires an extra 50 % overhead on top of formatted data. This type of coding is ideal for combating errors induced from multi-path fading common in mobile environments. The scramble code determines the pseudo-random sequence used to scramble the transmitted data. This provides data privacy and also randomizes the data for optimum signal detection. All TS4000s operating in the same network must use the same scrambling code. TS4000 Radio Modem User’s Manual Radio Setup 24 Force Transmit Over Receive Transmit Timeout Timer Transmit Only Operation Receive Only Operation Transmit Power Additional Transmit Attack Time Selection Disabled Description The modem will not transmit while receiving. Transmit data is buffered and then transmitted when the TS4000 stops receiving. Enabled Transparent Mode: The TS4000 transmits as soon as data is ready without regard to the receive state. Packet Mode: The TS4000 will transmit over foreign (non TS4000) receptions. During a receive, if the TS4000 cannot synchronize then it declares it to be foreign reception and allows transmission over it. When enabled, the timeout timer stops the TS4000 from transmitting after the specified period of continuous transmission. This is used to avoid locking up the radio channel due to a continuous transmission caused by a fault in the TS4000 or the host equipment When enabled, the TS4000 does not receive and will transmit regardless of activity on the channel. When enabled, the TS4000 will not transmit data sent to it through the serial port. This sets the transmit power level. The maximum transmit power that can be set depends on the specific radio module in the TS4000. Therefore the maximum value that can be set is listed only when the configuration program is connected to the TS4000. This is additional attack time added to the radio transmission process. This is used in setups where the TS4000 is used with a power amplifier or repeater system that creates an extra delay in establishing the radio channel. Attack time is the amount of time necessary to establish the radio channel. This includes the power up time for the transmitter and the time for the receiver to sense and demodulate the transmit signal. The TS4000 is preset for the appropriate attack time of the installed radio module. Therefore, this control should normally be set to zero. TS4000 Radio Modem User’s Manual Radio Setup 25 Frequency Programming The TS4000 comes in various frequency bands (i.e. 450 to 470 MHz) and can be programmed for any valid channel within a given frequency band. The TS4000 can be set for up to 99 channels. A channel consists of a receive frequency and a transmit frequency which can be set to the same or different frequencies. Methods of Programming Channels Frequency channels are programmed into the TS4000 using the configuration program. To access the frequency program screen press the Frequency Configuration button on the main screen of the configuration program. Frequency channel configuration settings are programmed into and retrieved from the TS4000 the same as the modem configuration settings. There are three ways to program frequencies into the TS4000 - cloning, using a preprogrammed file and being an authorized service organization. 1) Frequency Programming for Authorized Organizations The FCC rules state that only authorized organizations should be allowed to arbitrarily change the frequencies programmed into radio devices. Because of this, a software enable code is required to enable the arbitrary frequency programming capability of the TS4000 configuration program. Note that this enable code is not required to retrieve and display the channel frequencies programmed in the TS4000. Contact Teledesign Systems to find the nearest authorized service center. 2) Frequency Cloning 3) Preprogrammed Frequency File Cloning is copying the channels from one unit into another unit. Cloning can be done by any user and does not require a software enable code. Cloning is accomplished by first retrieving the desired frequency configuration from a unit. This retrieved file can then be used to program another unit. Note that if the retrieved frequency file is changed it can no longer be used to program another unit. Frequency programming can also be accomplished using a preprogrammed frequency file. Preprogrammed frequency files must be obtained from Teledesign. To use the preprogrammed file, first open the file with the frequency configuration program, then program the TS4000 with the opened file. TS4000 Radio Modem User’s Manual Radio Setup 26 Frequency Configuration Screen Radio vs. File Settings The minimum and maximum frequencies and the channel spacing depend on the specific radio module in the TS4000. The configuration program does not know this information unless it is connected to the TS4000. Therefore, these fields in the Radio Settings frame only show up when the configuration program is connected to the TS4000. When the user creates a new frequency configuration file these values can be set in the channel frequencies frame. This allows the user to create, modify and store frequency files without being connected to a TS4000. When a file is used to program frequency channels into the TS4000, the configuration program compares the radio values with the file values and determines if they are compatible. If they are compatible then the programming continues. If they are not compatible then the user is prompted to make the necessary changes in these values so that only valid frequency channels are programmed into the TS4000. TS4000 Radio Modem User’s Manual Radio Setup 27 Channel Switching During normal operation, the frequency channel can be switched on the fly with: 1) A control String through either serial port. 2) The DTR and RTS control lines on serial port 2. For details, see Radio Setup – Frequency Channel at Power Up. 3) Automatically with the Clear Channel Scan function. For details, see Radio Setup – Frequency Channel at Power Up. Channel Change with a Control String The channel is switched by sending the following ASCII character string to either of the TS4000’s serial port. +TSCxx Where: xx = Channel number from 01 to 99 Note: The letter characters must be upper case. The channel change control string is sent to the modem the same as standard transmit data. For the control string to be recognized it must be the first characters of a burst of transmit data. If the control string is sent alone (no data following), then the TS4000 will switch to the receive frequency of the new channel pair and wait in receive mode. If the control string is sent with a transmit data burst following it, then the TS4000 will switch to the transmit frequency of the new channel pair and transmit the burst. Determining the Active Channel The active channel can be determined with the channel query string. This is done with the following ASCII character string. +TSC? Note: The letter characters must be upper case. The response string is sent out the serial port and is as follows. 1) +TSCxx 2) +TSCCS For single channel systems Where: xx = Channel number from 01 to 99 For modems configured for clear channel scan Invalid Channel Selection If a frequency channel is selected that has not been programmed with valid frequencies, the modem will not receive or transmit and the RX and TX lights will alternately flash. Channel at Power Up The channel that the TS4000 activates at power up depends on the setting of the Frequency Channel at Power Up control (see Radio Setup – Frequency Channel at Power Up). TS4000 Radio Modem User’s Manual Radio Setup 28 Compatibility mode allows the TS4000 to be setup to be compatible with our previous generation TSI9600 radio modem. Compatibility Enable Data Protocol Selection Trimble Compatible Mode TSI9600 Compatibility Mode 3295 Compatibility Description This mode allows the TS4000 to communicate with Trimble TrimMark and TrimTalk GPS data links. This mode allows the TS4000 to communicate with Teledesign TSI9600s. This configures the TSI9600 compatibility mode to be suitable for operation with JDT-3295 modems. The JDT-3295 is a TSI9600 with slightly different firmware. Typically the 3295 consisted of an enclosed TSI9600 modem and interface board connected with a cable to a separately enclosed radio transceiver. Selection Data Scrambling Description This control is equivalent to the data scrambling DIP switch on the TSI9600 modem board. On the TSI9600 this switch is marked “H-F”. Transmit Deviation This sets the amount of transmit deviation. This should be set to match the level of the TSI9600. Normally this should not be changed from the default value. TS4000 Radio Modem User’s Manual Radio Setup 29 Data Polarity Trimble Options - Mode Trimble Options – Channel Spacing Trimble Options – Store and Forward Repeaters Selection Transmit Data Inversion Description This controls the transmit data polarity in 3295 mode. This control corresponds to the transmit polarity jumper on the interface board. Receive Data Inversion This controls the receive data polarity in 3295 mode. This control corresponds to the receive polarity jumper on the interface board. This should be set to match the type of Trimble data link that the TS4000 must operate with. This should be set to match the channel spacing of the Trimble data link that the TS4000 must operate with. These controls enable store and forward repeater operation in Trimble compatible mode. TS4000 Radio Modem User’s Manual Radio Setup 30 AirNet Packet Protocol Overview AirNet is an embedded packet protocol available in some Teledesign Systems modems. AirNet provides a complete protocol that manages the end to end data transfers of wireless networks. The AirNet protocol is flexible and configurable so that it can be used with any host (user) system or network architecture. Packet Basics The basic purpose of the AirNet packet protocol is to ensure that data is reliably transferred between nodes in the network. This means preventing data from being lost, repeated or corrupted at the receiving nodes. This is accomplished by combining transmit data into packets which contain user data and control information. The control information includes addressing, sequencing and error detection. Addressing information allows receiving nodes to determine if a packet is intended for them and also who the source of the packet was. Sequence information is used so that the data can be reconstructed in the correct order, and so that repeated packets of the same data are not given to the user. Error detection is provided by adding a CRC (Cyclic Redundancy Check) onto the packet so that any corruption of the packet can be detected. Addressability The key feature of any packet data protocol is its ability to identify and coordinate data transfers between individual nodes in a network. In order to move data between nodes, each node is assigned a unique address. With the AirNet protocol each node is assigned a unique individual and group address. Group addresses allow the nodes in a network to be partitioned into classes of service or segmented into regions. The AirNet protocol allows a data packet to be transferred to an individual node, to all nodes in a group (group broadcast), or to all nodes in all groups (network broadcast). The AirNet protocol also includes multicast reception. Multicast reception is the ability of a node to receive group broadcasts for groups other than its own. This allows a node to be a member of a number of different groups at the same time. Acknowledgment and Retries Individual node to node data transfers can be sent with or without positive acknowledgment from the destination node. Positive acknowledgment is the process where a destination node which receives an error free packet sends a return packet (without user data) to tell the source node that the packet was received correctly. This allows the source node to be sure that the data has been transferred. If the sending node does not receive an acknowledgment (ACK) packet within a preset period of time then it automatically re-sends (or retries) the data packet. Note that broadcast packets are never acknowledged and therefore the source node cannot be sure that they have been received correctly by all the destination nodes. Channel Access Store and Forward Repeater For most wireless data networks, there is the possibility that more than one node will attempt to transmit simultaneously. This is termed a collision and typically results in the data from both nodes being lost. To minimize collisions, the nodes must have an orderly means of accessing the shared channel. The AirNet protocol uses a CSMA/CA (Carrier Sense Multiple Access with Collision Avoidance) protocol to coordinate channel access (see CSMA System for details). In many networks some nodes are unable to directly communicate with all other nodes in the system due to insufficient RF coverage. To combat this many systems use frequency translating repeaters that are located at advantaged TS4000 Radio Modem User’s Manual AirNet Packet Protocol 31 (mountaintop) locations. In some situations, the use of a repeater may be logistically difficult and may not completely solve all propagation problems. The AirNet protocol provides an option where nodes can be set up as store and forward repeaters. The relay nodes store packets that they receive and repeat (forward) the packets when the channel is idle. The relay nodes can be set to relay all packets or only packets with certain source or destination addresses. Features Complete Packet Capability Nodes automatically re-send packets which are not received correctly. Robust 32 bit CRC ensures that packets are received correctly. Adjustable maximum number of retries. Adjustable maximum packet size - Large packets can be automatically broken up into smaller packets for reliable transmission. Easy to Use Host Control and Status The host (user equipment) controls operation of the packet protocol with simple ASCII command strings. No special formatting of user data is required. Status strings can be enabled to provide information on the success or failure of packet transmissions. Addressing Individual addresses from 1 to 999. Group addresses from 1 to 60. Various transfer types Individual (point to point with acknowledge) - The acknowledgment provides for guaranteed delivery of the data packets. Individual without acknowledgment. Group broadcast - Unacknowledged transfer to all members of a group. Network broadcast - Unacknowledged transfer to all modems. Multicast receptions - Allows a modem to receive group broadcasts to groups other than its own. This can be used to create sub-groups or supergroups of modems. Channel Access CSMA/CA - Carrier Sense Multiple Access with Collision Avoidance. Adjustable Transmission Index (transmit probability) - Allows a network to be optimized for maximum efficiency. Adjustable Slot Time - Allows the modem to be optimized for different radios and repeater systems. Store and Forward Data Repeater Any unit can be configured as a relay node. Allows for easy expansion of the network. Repeater filter allows for repeating of only packets to or from select nodes. This minimizes the amount of repeater traffic created. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 32 Configuration Options Packet General Packet Activate Medium (Channel) Access Control (MAC) These configuration options are set using the Packet General tab of the Modem Configuration. Selection Enable Packet Operation Description This activates packet operation for all user data. The type of Medium Access Control (MAC) determines how a modem decides when to transmit packets. This effects the transmission of both data and acknowledgment packets. Selection Master-Slave Description The modem will transmit data as soon as the channel becomes idle. This mode should only be used for masterslave systems where two modems will never attempt to transmit at the same time. This also implies that store and forward repeaters are not used in the system. CSMA Carrier Sense Multiple Access. This mode should be selected for systems where multiple modems may attempt to transmit simultaneously. With this setting, the modem waits until the channel becomes idle and then transmits in each following idle slot based on a random probability of transmission (see CSMA MAC Options - Transmission Index). This minimizes the potential for collisions in multiaccess systems. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 33 CSMA MAC Setup Control Slot Time Description This sets the transmit slot time (see Setting Slot Time). Min Idle Slots This sets the minimum number of idle slots before a modem attempts transmission (see Setting Min Idle Slots). If the minimum number of idle slots is set to zero the modem randomizes its transmission attempts with the first slot after the channel becomes idle. For values greater than zero, the modem waits that many slots before randomizing its transmission attempts. Tx Index The transmission index (TI) is the inverse of the probability of transmitting in an idle slot. An index of 4 corresponds to a 1/4 or 25% chance of transmitting in an idle slot. The goal of setting TI is to maximize efficiency on the channel. If TI is set too low then transmissions collide too often. If TI is set too high then there is excessive unused channel time in the system (see Setting Transmission Index). Min Idle Slots and Tx Index can be set differently for different types of packets. The following table describes the different packet types. Repeater Filtering Type Data Packets Description These are any packets that carry user data. These include data packets for all the different types of transfers (i.e. Individual, Individual w/o ACK, Broadcast). These values are set on the Packet for Port tab. ACK Packets These are the acknowledgment packets for the individually addressed data packets. These values are set on the Packet for Port tab. Relay Packets These are any packets that repeated with the store and forward repeater option. Both data packets and ACK packets can be repeated. Selection Packet Type Description The store and forward filtering is based on the packet type. For most applications the newer Address based filtering is simpler and more versatile. Address The store and forward filtering is based on the address of the source and destination units. This selection requires that the modem firmware is version 5.20 or higher. Addresses Repeater Address List Selection None Description No packets are repeated. Some The packets repeated are determined by the address list control (see below). All All packets are repeated. This control consists of a list of address ranges. Each item in the list represents a range of addresses that are repeated. A packet is repeated if the packet’s source or destination address matches an address range in the list. The addresses consist of a group address and a minimum and maximum individual TS4000 Radio Modem User’s Manual AirNet Packet Protocol 34 address. The user can use as few as one or as many (up to the list size) address ranges as desired. Repeating All Network Broadcast Packets In network broadcast packets the destination group and individual destination address are zeros. Therefore, setting these addresses to zero in the list will cause all network broadcast packets, regardless of their source address, to be repeated Repeating All Group Broadcast Packets In group broadcast packets the destination individual address is zero. Therefore, setting the individual address to zero in the list, for a particular group address, will cause all group broadcast packets going to that group to be repeated, regardless of their source address. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 35 Packet for Port 1 / Packet for Port 2 Modem Address These configuration options are set using the Packet for Port 1 and Packet for Port 2 tabs of the Modem Configuration. Control Individual Address Description The individual address of this modem. Group Address The group address of this modem. The group address is used to isolate different sets of individual addresses. It is also used to filter group broadcast transfers. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 36 Modem Addresses of the two ports The Modem Addresses of the two ports can be the same or different. If the addresses are set the same then receive packets addressed for the modem will be sent out of both serial ports. If the addresses are different then the data coming out of the serial ports can be separated by address. Multicast Group Reception Multicast groups allow a modem to receive group broadcasts to groups other than its own. This allows modems to be combined in subsets and supersets of their basic groups. Control Enable Multicast Reception Description This control enables the multicast capability of the modem and also enables the entry of multicast groups. Multicast Groups This control is a list of multicast addresses. These addresses have the same range as the group addresses. The user can use as few or as many (up to the list size) multicast groups as desired. By default, a modem accepts two kinds of broadcasts. Network broadcasts are received by all modems. Group broadcasts are received by modems with the same group address as the transmitting modem. Packet Operation Control Max Retries Description This control sets the maximum number of transmit retries. A retry is attempted if a packet is sent and an acknowledge packet is not received within the time defined by the packet timeout control. After the maximum number of retries have been attempted the packet is cleared from the transmit buffer. Retries do not apply to any kind of broadcast transfers or individual transfers without acknowledgment. Max Packet Size This control defines the maximum packet size in bytes. Any burst that is larger than this number of bytes will be broken up into multiple packets with this maximum packet size. Note that there is a difference between bytes and asynchronous characters. A byte is always eight bits of data. The number of bits in an asynchronous character is dependent on the setting of the asynchronous character control fields. Packet Timeout TS4000 Radio Modem User’s Manual The packet timeout is the amount of time the modem waits for an acknowledgment before re-sending a packet (see Network Setup - Setting Packet Timeout). AirNet Packet Protocol 37 Default Transfer This field selects the type of transfer that the modem defaults to at power up. This will remain as the transfer type until it is switched using the appropriate control string. Selection Individual Transfer Description This is a standard point to point data transfer with acknowledgments. Individual Transfer w/o Acknowledge This is a point to point data transfer but without any acknowledgments. This implies that there are no transmit retries if the packet is received with errors. Group Broadcast This is a broadcast to a group of modems. Receiving modems will accept two types of group broadcasts. Network Broadcast Default Destination Address Group broadcasts - Broadcasts where the destination group matches the receiving modem's group. Multicast broadcasts - Broadcasts where the destination group matches a group from the receive modem's multicast group list. For these broadcasts to be received, the receiving modem must have multicast reception enabled. This is a broadcast to all modems. These fields select the default destination address that the modem defaults to at power up. This address will remain as the default until it is switched using the appropriate control strings. Type Individual Address Description The default destination individual address. Group Address The default destination group address. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 38 Packet Status Data Control Provide Address at Receiver Description When this control is activated, the source address of each received packet is sent as a prefix status string to the data (see Control and Status Strings). Provide Positive Transmit ACKs When this control is activated, a status string is sent to the user when an acknowledgment is received for a packet. The corresponding packet number of the packet will be provided as part of the status string (see Control and Status Strings). This does not apply to any type of broadcast transfer or individual transfers without acknowledgment. Provide Negative Transmit ACKs When this control is activated, a status string is sent to the user when the transfer of a packet is unsuccessful (all retries have been sent and no acknowledgment has been received). The corresponding packet number of the packet will be provided as part of the status string (see Control and Status Strings). This does not apply to any type of broadcast transfer or individual transfers without acknowledgment. Provide RSSI at Receiver When this control is activated, the RSSI (Receive Signal Strength Indication) of the received packet is sent as a prefix string to the data. The string is made up of ASCII characters as follows: +TSRxxx where xxx = receive signal level in –dBms (i.e. +TSR087 = a –87dBm signal level) Note that because the value is in –dBms (negative dBms) a larger receive signal is represented with a smaller 3 digit number. For serial port 1 this control is on the Serial Port 1 Tab. CSMA MAC Setup Control Min Idle Slots Description This sets the minimum number of idle slots before a modem attempts transmission (see Setting Min Idle Slots). If the minimum number of idle slots is set to zero the modem randomizes its transmission attempts with the first slot after the channel becomes idle. For values greater than zero, the modem waits that many slots before randomizing its transmission attempts. Tx Index The transmission index (TI) is the inverse of the probability of transmitting in an idle slot. An index of 4 corresponds to a 1/4 or 25% chance of transmitting in an idle slot. The goal of setting TI is to maximize efficiency on the channel. If TI is set too low then transmissions collide too often. If TI is set too high then there is excessive unused channel time in the system (see Setting Transmission Index). Min Idle Slots and Tx Index can be set differently for different types of packets. The following table describes the different packet types. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 39 Control and Status Strings Type Data Packets Description These are any packets that carry user data. These include data packets for all the different types of transfers (i.e. Individual, Individual w/o ACK, Broadcast). ACK Packets These are the acknowledgment packets for the individually addressed data packets. Relay Packets These are any packets that are repeated with the store and forward repeater option. Both data packets and ACK packets can be repeated. These values are set on the Packet General tab. Control strings are used to control the operation of the modem. Status strings are used to provide status information from the modem. Status strings from the modem can be disabled if they are not needed for a given application. All control and status strings begin with the ASCII string “+TS”, followed by specific ASCII letters and numbers corresponding to the particular control field or status value provided (See Appendix B - ASCII Character Set). All numbers are formatted as ASCII digits and sent most significant digit first. iii - Represents a three digit individual address. gg - Represents a two digit group address. nn - Represents a two digit packet number. Control Strings Control String +TSI Description Set for individual transfer. +TSIAiii Set for individual transfer with address change. The three address characters change the individual destination address. +TSICggiii Set for individual transfer with complete address change. The first two characters are for the group address and the remaining three are for the individual destination address. +TSN Set for individual without acknowledgment transfer. +TSNAiii Set for individual without acknowledgment transfer with address change. The three address characters change the individual destination address. +TSNCggiii Set for individual without acknowledgment transfer with complete address change. The first two characters are for the group address and the remaining three are for the individual destination address. +TSG Set for group broadcast transfer. +TSGAgg Set for group broadcast transfer with address change. The two address characters change the group destination address. +TSB Set for a network broadcast transfer (to all modems). +TSFAggiii Change the modem destination address. The first two address characters are for the group address and the remaining three are for the individual address. The type of transfer remains unchanged. This command will change the destination address of the serial port that the command is sent to. If serial port 2 is not enabled for data, then the command will always change the serial port 1 destination address regardless of which TS4000 Radio Modem User’s Manual AirNet Packet Protocol 40 Control String Description port it is sent to. +TSFA? Query the modem destination address. Response: +TSFAggiii +TSSnn Set the packet number of the next packet transmitted. Packet numbers are used in status strings to indicate the success or failure of the transmission of a particular transmit packet. The packet number is set to 0 when the modem is reset. +TSLAggiii Change the modem source address. The first two address characters are for the group address and the remaining three are for the individual address. This command will change the source address of the serial port that the command is sent to. If serial port 2 is not enabled for data, then the command will always change the serial port 1 source address regardless of which port it is sent to. +TSLA? Query the modem source address. Response: +TSLAggiii Status Strings Status String +TSIAggiii Description Received an individual packet from this address. The first two address characters represent the group address and the next three the individual address. +TSNAggiii Received an individual without acknowledgment packet from this address. The first two address characters represent the group address and the next three the individual address. +TSGAggiii Received a group broadcast packet from this address. The first two address characters represent the group address and the next three the individual address. +TSBAggiii Received a network broadcast packet from this address. The first two address characters represent the group address and the next three the individual address. +TSSFnn Indicates that the transfer of this packet number was not successful. This status string is returned after the last retry of this packet has timed out. This does not apply to any type of broadcast packet or individual without acknowledgment packets. +TSSPnn Indicates that the transfer of this packet number was successful. This does not apply to any type of broadcast packet or individual without acknowledgment packets. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 41 Master-Slave System Setup A master-slave system is one where the host application is designed so that only one node will ever attempt to transmit at a given time. An example of this type of system is a polled system with a base station that sequentially poles a number of remote nodes. In this case the base always initiates a pole and the remotes respond with the desired data. To set up AirNet for this type of system, select the Master-Slave selection in the Packet General tab of the modem configuration. With this selection, the modem transmits waiting packets as soon as it detects an idle channel. The masterslave setting should not be used with systems that use store and forward repeaters. The packet timeout timer is used for only for individually addressed packets that expect an acknowledgment (ACK). The packet timeout timer is started after a data packet is sent. If an ACK is not received before the timer expires, then a retry transmission of the data packet is sent. This timer should be set longer than the worst case time it takes to receive an ACK packet. Setting Packet Timeout For a master-slave system, an ACK packet is sent as soon as the data packet is received and the channel is idle. This can start as soon as the decay time of the originating modem is finished. Packet Timeout Time = Decay Time + Attack Time + ACK Packet Transmit Time Where: Decay Time = Tx Decay Time + Additional Transmit Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time Tx Decay Time and Tx Attack Time are fixed values that are preset for the radio in the TS4000. These values can be read out of the TS4000 using the Retrieve Radio Hardware menu or button. The Additional Transmit Attack Time is the value set on the radio tab of the modem configuration. ACK Packet Transmit Time = ACK Packet Length / Modulation Rate An ACK packet fits in one data frame (16 bytes) of data. If coding is used then 50% coding overhead is added to this. ACK Packet Length Example -Uncoded = 16 bytes x 8 bits per byte = 128 bits -Coded = 128 bits x 1.5 = 192 bits Tx Attack Time = 20 ms Tx Decay Time = 12 ms Additional Transmit Attack Time = 0 ms Over air channel rate = 9600 bps Coding = Enabled ACK Packet Transmit Time = 192 / 9600 = 20 ms Packet Timeout Time = 12ms + 20 ms + 20 ms = 52 ms TS4000 Radio Modem User’s Manual AirNet Packet Protocol 42 Data Packet Transmit Time For a master-slave system, the data packet transmit time is constant for a given packet size. As long as the channel is not busy, a data packet will be sent immediately upon becoming available for transmission. Calculating the delay is very similar to the calculation for the packet timeout time above. Total Packet Delay Time = Attack Time + Packet Transmit Time Where: Attack Time = Tx Attack Time + Additional Transmit Attack Time Note that the packet delay time does not include the transmit decay time. This is because the packet is available at the receiving modem as soon as all the data is transmitted. Packet Transmit Time = Packet Length / Channel Rate Packet Length = (Data Bits + Overhead Bits) x Framing Overhead x Coding Overhead Overhead Bits = 14 bytes x 8 bits per byte = 112 bits Framing Overhead = 1.1 Coding Overhead (optional) = 1.5 Packet Length = (Data Bits + 112) x 1.1 { x 1.5 } Example Tx Attack Time = 20 ms Additional Transmit Attack Time = 0 ms Over air channel rate = 9600 bps Number of async chars in packet = 50 Number of data bits per async char = 8 Coding = Enabled Packet Length = ((50 x 8) + 112) x 1.1 x 1.5 = 845 bits Packet Transmit Time = 845 / 9600 = 88 ms Total Packet Delay Time = 20 + 88 = 108 ms TS4000 Radio Modem User’s Manual AirNet Packet Protocol 43 Polled System with Store and Forward Repeaters A polled system is one where a master (or base) station unit polls a number of remotes in sequence. The master is always the unit that initiates the communication and one and only one remote unit responds to the master’s request. This type of system is very common for SCADA (Supervisory Control and Data Acquisition) and telemetry systems Polled systems are relatively easy to configure and test because the order of communication is predictable and therefore it is possible to eliminate collisions. The following section will show a number of system topologies and the appropriate settings for the TS4000. All of these systems operate on a single frequency (simplex) although clear channel scan can be used. Note that the repeater TS4000s can also be connected to host devices and used as remotes. There is no forced limit to the number of repeaters that can be in a system. However, in most cases it is best to use the fewest repeaters possible. Each additional repeater will add complexity and delay to the system. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 44 Single Repeater System A single repeater system is one where all communication goes through a single store and forward repeater. Blind Remote Remote Remote Blind Remote Base Remote Polling Host Repeater Remote Configuration Parameter All Units Setting Enable Packet Operation Checked Medium Access Control (MAC) CSMA Store and Forward Repeater Operation: Repeater Filtering Address Default Transfer Network Broadcast CSMA MAC Setup: Data Packets: Tx Index CSMA MAC Setup: Relay Packets: Tx Index Modem Address: Group Base Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots Repeater Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All Remote Sites - that hear the repeater Modem Address: Individual 10+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots TS4000 Radio Modem User’s Manual AirNet Packet Protocol 45 Configuration Parameter Remote Sites - that cannot hear the repeater Setting Modem Address: Individual 10+ (each remote must have a unique address) CSMA MAC Setup-Data Pkts-Min Idle Slots Number of slots for an outbound polling packet Number of slots for an outbound polling packet = Packet Transmit Time / Slot Time Packet Transmit Time = {9 * [Max Outbound Message Length (in bytes) + 14] * Overhead / Air Rate (in kbps)} + Radio Tx Attack Time (in ms) Overhead = 1 if Coding (FEC) is Unchecked Overhead = 1.5 if Coding (FEC) is Checked Slot Time = 1.5 * Radio Transmit Attack Time Example: Max Message Length for Modbus protocol = 255 bytes Radio Tx Attack Time = 20ms (this value can be read on the Radio Hardware Screen) Air Rate = 9.6 kbps (this is configured on the Radio tab) Coding = Unchecked (this is configured on the radio tab) Slot Time = 1.5 * 20ms = 30ms (this is configured on the Packet General tab) Packet Transmit Time = [9 * (255 + 14) * 1 / 9.6] + 20 = 273ms Number of slot for an outbound polling packet = 273/30 = 10 (rounded up from 9.1) (this value must always be round up) TS4000 Radio Modem User’s Manual AirNet Packet Protocol 46 Dual Repeater System A dual repeater system has two repeaters. For the specific configurations defined in this example, the two repeaters must be able to hear each other. Remote Remote Repeater A Remote Remote Base Remote Polling Host Repeater B Remote Configuration Parameter All Units Setting Enable Packet Operation Checked Medium Access Control (MAC) CSMA Store and Forward Repeater Operation: Repeater Filtering Address Default Transfer Network Broadcast CSMA MAC Setup: Data Packets: Tx Index CSMA MAC Setup: Relay Packets: Tx Index Modem Address: Group Base Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots Repeater A Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All Repeater B Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All TS4000 Radio Modem User’s Manual AirNet Packet Protocol 47 Configuration Parameter Remote Sites - that reliably hear both repeaters Setting Modem Address: Individual 10+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots Remote Sites – that hear only one of the repeaters Modem Address: Individual 10+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots Base packet transmit slots + Largest Relay Pkt: Min Idle Slot Remote Sites – that hear only the base Modem Address: Individual 10+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots (2 x Base packet transmit slots) + Largest Relay Pkt: Min Idle Slot Equations: Base packet transmit slots = Packet Transmit Time / Slot Time Packet Transmit Time = {9 * [Max Outbound Message Length (in bytes) + 14] * Overhead / Air Rate (in kbps)} + Radio Tx Attack Time (in ms) Overhead = 1 if Coding (FEC) is Unchecked Overhead = 1.5 if Coding (FEC) is Checked Slot Time = 1.5 * Radio Transmit Attack Time Example: Remote Sites – that hear only the base: Max Message Length for Modbus protocol = 255 bytes Radio Tx Attack Time = 20ms (this value can be read on the Radio Hardware Screen) Air Rate = 9.6 kbps (this is configured on the Radio tab) Coding = Unchecked (this is configured on the Radio tab) Largest Relay Pkt: Min Idle Slots = Repeater B: Relay Pkts: Min Idle Slots = 1 Slot Time = 1.5 * 20ms = 30ms (this is configured on the Packet General tab) Packet Transmit Time = [9 * (255 + 14) * 1 / 9.6] + 20 = 273ms Base packet transmit slots = 273/30 = 10 (rounded up from 9.1)(this value must be rounded up) CSMA MAC Setup: Data Pkts: Min Idle Slots = (2 x 10) + 1 = 21 TS4000 Radio Modem User’s Manual AirNet Packet Protocol 48 Three Repeater System A three repeater system is similar to a two repeater topology but with an additional repeater extending range to outlying remotes. For the specific configurations defined in this example, the following must be true: 1) All the remotes must hear at least one repeater site. 2) Repeater B and Repeater C cannot hear each other. Remote Remote Repeater C Repeater A Remote Remote Base Polling Host Repeater B Remote Remote Configuration Parameter All Units Setting Enable Packet Operation Checked Medium Access Control (MAC) CSMA Store and Forward Repeater Operation: Repeater Filtering Address Default Transfer Network Broadcast CSMA MAC Setup: Data Packets: Tx Index CSMA MAC Setup: Relay Packets: Tx Index Modem Address: Group Base Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots Repeater A Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All TS4000 Radio Modem User’s Manual AirNet Packet Protocol 49 Configuration Parameter Repeater B Site Setting Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All Repeater C Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay Some Store and Forward Repeater Operation: Addresses Group Individual 1 (Base) 400 - 499 (Remote Sites that hear Repeater C) Remote Sites - that hear ONLY the Base Modem Address: Individual 100+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots (2 x Base packet transmit slots) + Largest Relay Pkt: Min Idle Slot Remote Sites - that hear ONLY Repeater A Modem Address: Individual 200+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots Base packet transmit slots + Largest Relay Pkt: Min Idle Slot Remote Sites - that hear Repeater B Modem Address: Individual 300+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots Remote Sites - that hear Repeater C Modem Address: Individual 400+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots Equations: Base packet transmit slots = Packet Transmit Time / Slot Time Packet Transmit Time = {9 * [Max Outbound Message Length (in bytes) + 14] * Overhead / Air Rate (in kbps)} + Radio Tx Attack Time (in ms) Overhead = 1 if Coding (FEC) is Unchecked Overhead = 1.5 if Coding (FEC) is Checked Slot Time = 1.5 * Radio Transmit Attack Time TS4000 Radio Modem User’s Manual AirNet Packet Protocol 50 Example: Remote Sites – that hear only Repeater A Max Message Length for Modbus protocol = 255 bytes Radio Tx Attack Time = 20ms (this value can be read on the Radio Hardware Screen) Air Rate = 9.6 kbps (this is configured on the Radio tab) Coding = Unchecked (this is configured on the Radio tab) Largest Relay Pkt: Min Idle Slots = Repeater C: Relay Pkts: Min Idle Slots = 2 Slot Time = 1.5 * 20ms = 30ms (this is configured on the Packet General tab) Packet Transmit Time = [9 * (255 + 14) * 1 / 9.6] + 20 = 273ms Base packet transmit slots = 273/30 = 10 (rounded up from 9.1)(this value must be rounded up) CSMA MAC Setup: Data Pkts: Min Idle Slots = 10 + 2 = 12 TS4000 Radio Modem User’s Manual AirNet Packet Protocol 51 Chain Repeater System A chain repeater topology is one where the messages are passed down a chain of repeaters. This is typical for systems that operate along a road, river or railroad track. For the specific configurations defined in this example, the base and each repeater must hear only the next repeater in the chain. For example: Repeater B hears only Repeater A and C but not the Base and Repeater D. Remote Base Polling Host Remote Remote Remote Repeater A Repeater D Repeater B Remote Repeater C Remote Configuration Parameter All Units Setting Enable Packet Operation Checked Medium Access Control (MAC) CSMA Store and Forward Repeater Operation: Repeater Filtering Address Default Transfer Network Broadcast CSMA MAC Setup: Data Packets: Tx Index CSMA MAC Setup: Relay Packets: Tx Index Modem Address: Group Base Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots Repeater A Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All TS4000 Radio Modem User’s Manual AirNet Packet Protocol 52 Configuration Parameter Repeater B Site Setting Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All Repeater C Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All Repeater D Site Modem Address: Individual CSMA MAC Setup: Data Pkts: Min Idle Slots CSMA MAC Setup: Relay Pkts: Min Idle Slots Store and Forward Repeater Operation: All Packets Relay All Remote Sites Modem Address: Individual 10+ (each remote must have a unique address) CSMA MAC Setup: Data Pkts: Min Idle Slots Base packet transmit slots + Largest Relay Pkt: Min Idle Slot Equations: Base packet transmit slots = Packet Transmit Time / Slot Time Packet Transmit Time = {9 * [Max Outbound Message Length (in bytes) + 14] * Overhead / Air Rate (in kbps)} + Radio Tx Attack Time (in ms) Overhead = 1 if Coding (FEC) is Unchecked Overhead = 1.5 if Coding (FEC) is Checked Slot Time = 1.5 * Radio Transmit Attack Time Example: Remote Sites Max Message Length for Modbus protocol = 255 bytes Radio Tx Attack Time = 20ms (this value can be read on the Radio Hardware Screen) Air Rate = 9.6 kbps (this is configured on the Radio tab) Coding = Unchecked (this is configured on the Radio tab) Largest Relay Pkt: Min Idle Slots = Repeater B: Relay Pkts: Min Idle Slots = 3 Slot Time = 1.5 * 20ms = 30ms (this is configured on the Packet General tab) Packet Transmit Time = [9 * (255 + 14) * 1 / 9.6] + 20 = 273ms Base packet transmit slots = 273/30 = 10 (rounded up from 9.1)(this value must be rounded up) CSMA MAC Setup: Data Pkts: Min Idle Slots = 10 + 3 = 13 TS4000 Radio Modem User’s Manual AirNet Packet Protocol 53 Other System Topologies The TS4000 is very versatile and can be configured for virtually any system topology. If one of the above topologies cannot be adapted to match a particular network then Teledesign can work with you to create a suitable configuration. The TS4000 also has the capability to selectively repeat messages from groups or individual remotes. This feature can be used to allow for more complicated topologies and to minimize the throughput delay. The following questions will need to be answered prior to creating a suitable configuration. 1) What sites (base, repeater and remote) can hear each other? In many cases this can be adjusted by using a directional antenna at the remotes and pointing them appropriately. 2) What is the maximum message size of the polling message outbound from the base site to the remotes? 3) What is the maximum message size of the response message inbound from the remotes to the base site? TS4000 Radio Modem User’s Manual AirNet Packet Protocol 54 CSMA System Setup The CSMA MAC (Medium Access Control) is used for systems in which multiple modems will attempt to access the radio channel simultaneously (multi-access systems). If two modems attempt to transmit simultaneously, a collision results which prevents both transmissions from being successfully sent. The AirNet protocol uses CSMA/CA (Carrier Sense Multiple Access with Collision Avoidance) to provide multi-access capability. The CSMA refers to monitoring the channel to ensure that it is unused before transmitting a packet. Collision Avoidance For multi-access radio systems CSMA alone is typically not enough to prevent excessive collisions. The problem occurs when one modem is transmitting and multiple other modems receive data for their hosts and become ready to transmit. These other modems will wait until the first modem finishes its transmission and then they will all attempt to transmit simultaneously, resulting in a collision. This creates the need for collision avoidance. The AirNet protocol provides this by having modems randomize their transmissions once they detect an idle channel. In each slot after a modem detects an idle channel, it will decide with some probability (based on the Transmission Index) whether or not to transmit. This does not eliminate collisions, but, if the probability is set correctly, minimizes the collisions to allow for efficient multi-access use of the radio channel. Slot Time The AirNet protocol uses timing slots to determine when to attempt transmissions. These slots are slightly different from the slots used in conventional multi-access slotted MACs. The AirNet slots are the minimum channel detection times or the minimum time from when one modem begins transmission to when all other modems will detect that transmission. This size slot guarantees that modems waiting to transmit in consecutive slots will not collide and allows for very efficient use of the radio channel. Basic System - Setup Summary Slot Time The following is a summary of the suggested settings for a basic CSMA system. A basic system does not have any store and forward repeaters. Note that more detail on the parameters and equations can be found later in this section. Slot Time = Attack Time + Maximum Carrier Detect Time Variation = 1.5 x Attack Time Where: Attack Time = Radio Attack Time + Additional Transmit Attack Time Tx Decay Time and Tx Attack Time are fixed values that are preset for the radio in the TS4000. These values can be read out of the TS4000 using the Retrieve Radio Hardware menu or button. The Additional Transmit Attack Time is the value set on the radio tab of the modem configuration. Min Idle Slots Tx Index Min Idle Slots - ACK Packets Min Idle Slots - Data Packets =0 =1 Tx Index - ACK Packets = 1 Tx Index - Data Packets = Estimated Backlogged Nodes / Attempt Rate Where: 1/2 Attempt Rate = (Packet Detection Ratio) Packet Detection Ratio = Slot Time / Total Packet Time Total Packet Time = Attack Time + Packet Transmit Time + Decay Time TS4000 Radio Modem User’s Manual AirNet Packet Protocol 55 Packet Transmit Time = Packet Length / Channel Rate Packet Length = (Data Bits + Overhead Bits) x Framing Overhead x Coding Overhead = (Data Bits + 112) x 1.1 { x 1.5 } Overhead Bits = 14 bytes x 8 bits per byte = 112 bits Framing Overhead = 1.1 Coding Overhead (optional) = 1.5 Packet Timeout Packet Timeout = Decay Time + Attack Time + ACK Packet Transmit Time Where: Decay Time = Tx Decay Time + Additional Transmit Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time ACK Packet Transmit Time = ACK Packet Length / Channel Rate ACK Packet Length -Uncoded = 16 bytes x 8 bits per byte = 128 bits -Coded = 128 bits x 1.5 = 192 bits System with Repeaters - Setup Summary Slot Time The following is a summary of the suggested settings for a system that has one or more store and forward repeaters. Note that more detail on the parameters and equations can be found later in this section. Slot Time = Attack Time + Maximum Carrier Detect Time Variation = 1.5 x Attack Time Where: Attack Time = Radio Attack Time + Additional Transmit Attack Time Tx Decay Time and Tx Attack Time are fixed values that are preset for the radio in the TS4000. These values can be read out of the TS4000 using the Retrieve Radio Hardware menu or button. The Additional Transmit Attack Time is the value set on the radio tab of the modem configuration. Min Idle Slots Min Idle Slots - ACK Packets =0 Min Idle Slots - Relay Packets Min Idle Slots - Relay Packets ... ... Min Idle Slots - Relay Packets (Relay #1) = 1 (Relay #2) = 2 (Relay #Z) = Z Min Idle Slots - Data Packets = Highest Relay # + 1 = Z + 1 Tx Index Tx Index - ACK Packets = 1 Tx Index - Relay Packets = 1 Tx Index - Data Packets = Estimated Backlogged Nodes / Attempt Rate Where: Estimated Backlogged Nodes (number of nodes that simultaneously want to transmit) = the greater of A) Average Number of Backlogged Nodes or B) 1/4 Maximum Possible Number of Backlogged Nodes 1/2 Attempt Rate = (Packet Detection Ratio) Packet Detection Ratio = Slot Time / Total Packet Time TS4000 Radio Modem User’s Manual AirNet Packet Protocol 56 Total Packet Time = Attack Time + Packet Transmit Time + Decay Time Packet Transmit Time = Packet Length / Channel Rate Packet Length = (Data Bits + Overhead Bits) x Framing Overhead x Coding Overhead = (Data Bits + 112) x 1.1 { x 1.5 } Overhead Bits = 14 bytes x 8 bits per byte = 112 bits Framing Overhead = 1.1 Coding Overhead (optional) = 1.5 Packet Timeout Packet Timeout = Relay Delays for Data Packet + Ack Packet Delay at Destination Node + Relay Delays for ACK Packet Where: Relay Delays for Data Packet = Relay #1Data Packet Delay + Relay #2 Data Packet Delay ... ... + Relay #Y Data Packet Delay Relay #Y Data Packet Delay = Decay Time + (Y x Slot Time) + Attack Time + Data Packet Transmit Time Data Packet Transmit Time = Data Packet Length / Channel Rate Data Packet Length = (Data Bits + Overhead Bits) x Framing Overhead x Coding Overhead Overhead Bits = 14 bytes x 8 bits per byte = 112 bits Framing Overhead = 1.1 Coding Overhead (optional) = 1.5 ACK Packet Delay at Destination Node = Decay Time + Attack Time + ACK Packet Transmit Time Relay Delays for ACK Packet = Relay #1ACK Packet Delay + Relay #2 ACK Packet Delay ... ... + Relay #Y ACK Packet Delay Relay #Y ACK Packet Delay = Decay Time + (Y x Slot Time) + Attack Time + ACK Packet Transmit Time ACK Packet Transmit Time = ACK Packet Length / Channel Rate ACK Packet Length -Uncoded = 16 bytes x 8 bits per byte = 128 bits -Coded = 128 bits x 1.5 = 192 bits Decay Time = Tx Decay Time + Additional Transmit Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time TS4000 Radio Modem User’s Manual AirNet Packet Protocol 57 Setting Slot Time The slot time should be set to the attack time of the radio plus the maximum variation (uncertainty) in the carrier detection circuit. The variation in the carrier detection circuit is the difference in the carrier detect time between the radio with the fastest carrier detect time and the radio with the slowest carrier detect time. Note that the attack time is made up of the worst case transmitter power ramp up time plus the worst case carrier detect time. Typically the maximum variation of the carrier detect circuit is less than half (50%) of the attack time. Slot Time = Attack Time + Maximum Carrier Detect Time Variation = 1.5 x Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time Tx Attack Time is a fixed value that is preset for the radio in the TS4000. This value can be read out of the TS4000 using the Retrieve Radio Hardware menu or button. The Additional Transmit Attack Time is the value set on the radio tab of the modem configuration. Setting Min Idle Slots Systems without Repeaters The minimum idle slot setting defines the number of slots which a modem will leave vacant after the modem detects an idle channel and before the modem attempts to transmit. A setting of 0 means that the modem will attempt transmission in the first slot after the channel becomes available (idle). A setting of 1 means that the modem will wait 1 slot after the channel is available before attempting to transmit. The number of minimum idle slots can be set differently for each packet type (data, ACK or relay). The simplest and most efficient system setup is where ACK (acknowledgment) packets are sent immediately after a valid data packet is received. With this setup the ACK packets do not contend for the channel the way data packets do. Correspondingly, the data packets are set so that they will leave the first slot open for the ACK packets. This type of setup has the advantage that the delay for receiving an ACK packet is consistent and predictable. This makes it much easier to set an appropriate packet timeout (see Setting Packet Timeout). Systems with Repeaters Min Idle Slots - ACK Packets Min Idle Slots - Data Packets =0 =1 Tx Index - ACK Packets Tx Index - Data Packets = 1 (Always transmit in the first slot) = Attempt Rate (see Setting Tx Index) For systems with one or more relay nodes, the simplest and most efficient system setup is where each relay is assigned a particular slot. This way the repeaters do not collide or contend for the channel the way data packets do. The data packets are set so that they will leave the necessary number of slots open for the repeaters and ACK packets. This type of setup has the advantage that the delay for sending data through the relay(s) is consistent and predictable. This makes it much easier to set an appropriate packet timeout (see Setting Packet Timeout). Min Idle Slots Min Idle Slots - ACK Packets =0 Min Idle Slots - Relay #1 Min Idle Slots - Relay #2 =1 =2 TS4000 Radio Modem User’s Manual AirNet Packet Protocol 58 Tx Index Setting Tx Index ... ... Min Idle Slots - Relay #N =N Min Idle Slots - Data Packets = Highest Relay # + 1 = N + 1 Tx Index - Relays (All) Tx Index - ACK Packets Tx Index - Data Packets = 1 (Always transmit in their assigned slot) = 1 (Always transmit in the first slot) = Attempt Rate (see Setting Tx Index) The transmission index (TI) is the inverse of the probability of transmitting in an idle slot. A TI of 10 corresponds to a 1/10 = 10% chance of transmitting in an idle slot. The goal of setting TI is to maximize efficiency on the channel. If TI is set too low then transmissions collide too often. If TI is set too high then there are an excessive number of unused slots. AirNet allows TI to be set differently for each packet type (data, ACK or relay). For most systems, TI is set to 1 for ACK and relay packets (see Setting Min Idle Slots). The setting of 1 corresponds to always transmitting (100% probability) in a particular slot. To set TI, the user must make some practical estimates and then do some calculations based on these estimates. First it is necessary to estimate the average data packet length. To do this, estimate the average number of data bits in a packet using the following formulas. Packet Length = (Data Bits + Overhead Bits) x Framing Overhead x Coding Overhead Overhead Bits = 14 bytes x 8 bits per byte = 112 bits Framing Overhead = 1.1 Coding Overhead (optional) = 1.5 Packet Length = (Data Bits + 112) x 1.1 { x 1.5 } With this average packet length number, calculate the packet transmit time. Note that the formulas require the configuration values for transmit attack and decay time. Packet Transmit Time = Packet Length / Channel Rate Total Packet Time = Attack Time + Packet Transmit Time + Decay Time Decay Time = Tx Decay Time + Additional Transmit Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time Tx Decay Time and Tx Attack Time are fixed values that are preset for the radio in the TS4000. These values can be read out of the TS4000 using the Retrieve Radio Hardware menu or button. The Additional Transmit Attack Time is the value set on the radio tab of the modem configuration. Calculate the packet detection ratio, which is the slot time normalized to the total packet time. Then, using packet detection ratio, calculate the attempt rate as its square root. Packet Detection Ratio = Slot Time / Total Packet Time TS4000 Radio Modem User’s Manual AirNet Packet Protocol 59 Attempt Rate = (Packet Detection Ratio)1/2 To finally calculate the transmission index we need to estimate the number of backlogged nodes (the number of nodes that may want to transmit at the same time). The difficulty in estimating this value is that for most systems this number is dynamic and can change dramatically depending on what is occurring in the system. For systems where the backlog can vary, estimate the average number of backlogged nodes for the most common scenario and also estimate the maximum number of backlogged nodes that will ever occur. If the average number of backlogged nodes is more than 1/4 of the maximum, then use the average as the backlog number. Otherwise use 1/4 of the maximum as the backlog number. The reason for this is that the system must operate under the worst case conditions. If the backlog is set too low then under worst case conditions, there will be an excessive number of collisions and the system will be very slow. In general it is a good idea to set the transmission index higher than expected as opposed to lower. This allows the system to more gracefully handle peak traffic. However, this also causes average efficiency to drop and packet delay time to increase. Transmission Index = Estimated Backlogged Nodes / Attempt Rate Estimated Backlogged Nodes = the greater of A) Average Number of Backlogged Nodes or B) 1/4 Maximum Possible Number of Backlogged Nodes Example Calculation of the transmission index. Tx Attack Time = 20 ms Tx Decay Time = 12 ms Additional Transmit Attack Time = 0 ms Over air channel rate = 9600 bps Coding = Disabled Average Packet Size = 400 bits Average Backlogged Nodes = 10 Maximum Backlogged Nodes = 100 Slot Time = 30 ms Packet Length = (Data Bits + 112) x 1.1 = (400 + 112) x 1.1 = 564 Packet Transmit Time = Packet Length / Channel Rate = 564 / 9600 = 59 ms Total Packet Time = Attack Time + Packet Transmit Time + Decay Time = 20 ms + 59 ms + 12 ms = 91 ms Packet Detection Ratio = Slot Time / Total Packet Time = 30 ms/ 91 ms = 0.33 Attempt Rate = (Packet Detection Ratio)1/2 = (0.33)1/2 = 0.57 Since: Max Backlogged Nodes / 4 > Average Backlogged Nodes Estimated Backlogged Nodes = Max Backlogged Nodes / 4 = 100 / 4 = 25 Transmission Index = Estimated Backlogged Nodes / Attempt Rate = 25 / 0.57 = 44 TS4000 Radio Modem User’s Manual AirNet Packet Protocol 60 Setting Packet Timeout Systems without Repeaters The packet timeout timer is used for individual packets that expect an acknowledgment (ACK). This timer is started after a data packet is sent. If an ACK is not received before the timer expires then a retry transmission of the data packet is sent. This timer should be set longer than the worst case typical amount of time it takes to receive an ACK packet. The following calculations are for systems that are setup so that ACK packets are sent immediately after the data packet transmission is completed without contending for the channel (see Setting Min Idle Slots). For this type of CSMA system the packet timeout time is the same as for a Master/Slave system. The ACK is sent as soon as the decay time of the sending modem is finished. Packet Timeout Time = Decay Time + Attack Time + ACK Packet Transmit Time Decay Time = Tx Decay Time + Additional Transmit Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time ACK Packet Transmit Time = ACK Packet Length / Channel Rate An ACK packet fits in one data frame (16 bytes) of data. If coding is used, then 50 % coding overhead is added to this. ACK Packet Length Systems with Repeaters -Uncoded = 16 bytes x 8 bits per byte = 128 bits -Coded = 128 bits x 1.5 = 192 bits The following calculations are for systems that are setup as described in the Setting Min Idle Slots section. The packet timeout should be set to the amount of time it takes to send the data packet and then the amount of time it takes to get back an acknowledgement. Packet Timeout = Relay Delays for Data Packet + Ack Packet Delay at Destination Node + Relay Delays for ACK Packet The amount of time it takes to send a data packet is the sum of the amount of time it takes each relay to send the data packet. Relay Delays for Data Packet = Relay #1Data Packet Delay + Relay #2 Data Packet Delay ... ... + Relay #Y Data Packet Delay The time it takes each relay to send the packet is basically the packet transmit time. Added to this must be the number of idle slots between the last transmission and when the current relay decides to transmit. Relay #Y Data Packet Delay = Decay Time + (Y x Slot Time) + Attack Time + Data Packet Transmit Time TS4000 Radio Modem User’s Manual AirNet Packet Protocol 61 Data Packet Transmit Time = Data Packet Length / Channel Rate Data Packet Length = (Data Bits + Overhead Bits) x Framing Overhead x Coding Overhead Overhead Bits = 14 bytes x 8 bits per byte = 112 bits Framing Overhead = 1.1 Coding Overhead (optional) = 1.5 The ACK packet delay at the destination node is the amount of time it takes for the destination node to send the ACK packet. ACK Packet Delay at Destination Node = Decay Time + Attack Time + ACK Packet Transmit Time After the ACK packet is transmitted by the destination node, it must be retransmitted by the various repeaters in the system. This is the sum of the time it takes each relay to transmit the ACK packet. Relay Delays for ACK Packet = Relay #1ACK Packet Delay + Relay #2 ACK Packet Delay ... ... + Relay #Y ACK Packet Delay Relay #Y ACK Packet Delay = Decay Time + (Y x Slot Time) + Attack Time + ACK Packet Transmit Time ACK Packet Transmit Time = ACK Packet Length / Channel Rate ACK Packet Length -Uncoded = 16 bytes x 8 bits per byte = 128 bits -Coded = 128 bits x 1.5 = 192 bits Decay Time = Tx Decay Time + Additional Transmit Attack Time Attack Time = Tx Attack Time + Additional Transmit Attack Time Data Packet Delay Average Delay The average delay is the average amount of time from when a packet is ready for transmission to when the packet is actually transmitted. This number is for a single attempt and does not include the time for any retries due to corrupted transmissions. Note that the average delay varies based on the number of backlogged nodes in the system at a given time. Also note that the average delay varies substantially even with constant conditions due to the random nature of events. For ease of notation we shall rename some of the parameters. Tslot = Slot Time PDR = Packet Detection Ratio TI = Transmission Index N = Backlogged Nodes PR = (TI - 1)/TI Average Delay = Tslot x (1 + PDR - PRN) PDR x ln(1/PR) TS4000 Radio Modem User’s Manual AirNet Packet Protocol 62 Where: ln symbolizes the natural log function. Example Using the values from the previous example, calculate the average delay for various backlogs. Tslot = Slot Time = 30 ms = 0.03 sec PDR = Packet Detection Ratio = 0.33 (from previous example) TI = Transmission Index = 44 (from previous example) PR = (TI - 1)/TI = (44 - 1)/ 44 = 0.977 Average Delay = Tslot x (1 + PDR - PRN) = 0.03(1 + 0.33 - 0.977N) PDR x ln(1/PR) 0.33 ln(1/0.977) = 0.03(1.33 - 0.977N) = 3.91(1.33 - 0.977N) 0.00768 Backlogged Nodes (N) 10 Average Delay (sec) 2.1 Probable Delay 25 3.0 50 4.0 75 4.5 100 4.8 The probable delay calculation allows the user to calculate the expected delay given some probability that the transmission actually occurs. The probable delay value can be used for calculating a packet timeout value for a system where the ACK packets do not use an immediate ACK and have a transmission index the same as the data packets. It can also be used to calculate timeouts for layers of the protocol stack above the modem on the host system. Note that the probable delay value does not include any transmission times due to repeaters and acknowledgement packets. The basis of the probable delay is the average delay calculated above. As noted before, the average delay will vary based on the actual number of backlogged nodes in a system. Probable Delay = Average Delay x ln(1/(1 - Probability of Sending)) Where: The Probability of Sending is a fractionalized percentage (i.e. 50% = 0.50, 95% = 0.95). Example Calculate the probable delay for various probabilities of sending in terms of the average delay. Probability of Sending (%) Probable Delay (Avg. Delays) 25 50 75 90 95 99 99.9 0.29 0.69 1.38 2.30 3.00 4.61 6.91 Note that the 50% probability of sending value is not equal to the average delay. This is because the delay spread is a statistical distribution where the mean and median delays are not the same. TS4000 Radio Modem User’s Manual AirNet Packet Protocol 63 GPS Configuration The GPS Configuration is designed to provide a simplified set of configuration options for use with differential GPS and RTK systems. In these GPS reference systems, one base unit transmits a GPS correction and one or more rover units receive and use this reference information. A GPS type configuration can be converted to a standard configuration using the Convert To selection under the File menu. Configuration Options Function Selection Base Description The base is the unit that transmits the GPS reference corrections. A base unit will not send receive data out of its serial port. However the Rx light will indicate activity on the radio channel. Rover The rover is a unit that receives the GPS reference corrections. A rover will not transmit data that it receives through its serial port. In this mode the Tx light indicates if an error free packet has been received and how strong the receive signal was. 1 flash: A good receive packet with a low signal. 2 quick flashes: A good receive packet with a medium signal. 3 quick flashes: A good receive packet with a strong signal. Repeater A repeater is a unit that repeats the GPS corrections in order to increase the range between the base and the rover. Note that a repeater unit can also be used to provide data to a GPS rover host. Baud Rate List The baud rate list provides selection of the serial port asynchronous baud rate. TS4000 Radio Modem User’s Manual GPS Configuration 64 Data Bits Parity Radio Operation This indicates the number of data bits in each asynchronous character. This indicates the parity of the asynchronous characters. Selection Channel Spacing Description This setting should be configured to match the maximum channel spacing allowed by the user’s license. This value controls the amount of frequency bandwidth (occupied bandwidth) that the transmitted signal will use. A higher value corresponds to more bandwidth and therefore provides better BER (Bit Error Rate) performance and a higher maximum over the air data rate. For operation in FCC jurisdictions, the channel spacing is fixed (not user configurable) at 12.5KHz. Frequency Channel at Power Up Air Rate The over the air modulation bit rate. Selection Fixed Channel Description The channel activated at power up is the channel set in the corresponding control. Clear Channel Scan Activates Clear Channel Scan Operation. The bottom box is the scan list which indicates the channels that will be scanned. The scan list can be changed with the channel box, add button and delete button. When Clear channel operation is enabled, the TS4000 will automatically and dynamically select the least congested channel from the clear channel scan list. This operation is completely transparent to the host equipment and does not require any operator intervention. When clear channel scan is enabled, all of the TS4000s (both transmitters and receivers) are constantly scans the channels of the scan list looking for valid TS4000 transmissions and also looking for interference (noise or transmissions from other sources). The TS4000s keeps track of the amount of interference on each channel. Before transmitting, a TS4000 will select the best channel and switch to the channel with the least amount of interference. The receiving TS4000s will then see this valid TS4000 transmission during their scans and receive the packet. To insure that receiving TS4000s have time to detect and lock up to all transmissions, the transmit preamble time is increased based on the number of channels on the scan list. Transmit Power This sets the transmit power level. The maximum transmit power that can be set depends on the specific radio module in the TS4000. Therefore the maximum value that can be set is listed only when the configuration program is connected to the TS4000. TS4000 Radio Modem User’s Manual GPS Configuration 65 Automatic Station ID The TS4000 can be configured to periodically output a Morse code identification string. Selection Enable Automatic Station ID Repeat Time ID Message Receive Carrier Detect Level Description When the control is selected, the modem will output the ID message at the designated repeat time. This is the amount of time between station ID transmissions. This is the text message that is transmitted. The transmission is formatted as standard Morse code. This is typically set to be a station call sign, license number or location. This sets the receive signal level at which the receiver is activated. This is similar to the squelch control on mobile radios. Normally this level is set slightly lower than the level at which the TS4000 can correctly demodulate the incoming data. When using the TS4000 in a high noise environment, this level can be raised so that the TS4000 is more selective about the signals that it attempts to demodulate. This is important for configurations that do not allow the TS4000 to transmit while it is receiving. These include configurations with packet operation enabled or with the Force Transmit over Receive control disabled. Trimble Compatible This mode allows the TS4000 to communicate with Trimble TrimMark and TrimTalk GPS data links. TS4000 Radio Modem User’s Manual GPS Configuration 66 Testing AirTest AirTest is Teledesign’s general purpose wireless modem test software. AirTest can send data and gather performance statistics about the link between multiple modems. AirTest is modem independent and can be used with any asynchronous serial communications device. To start AirTest press the AirTest button on the main screen of the configuration program. For details on using AirTest consult AirTest’s on line help. Data Test To test the operation of the TS4000, AirTest can be used to pass data between two modems. 1) Attach two TS4000s each to a PC serial port. 2) Configure AirTest for serial port settings (baud rate, data bits and parity) that match the attached TS4000’s settings (Setup Manu – Port Setup). 3) Transmit data between the TS4000s by typing a message into the Tx Message box of the Comm Port window followed by the ENTER key. 4) Automated tests can be run that will send data and verify that it is received correctly. To select a test, use the Test Setup command from the Setup menu. Use the on line help to obtain more information about each test. TS4000 Radio Modem User’s Manual Testing 67 BER Test A BER (Bit Error Rate) test is used to determine how good a radio environment is for transmitting data. The BER result tells the percentage of bits that are corrupted. A BER of 3.0 x 10-4 means that 3 out of 10,000 (104) bits are corrupted. The longer a BER test runs the more accurate the result. To get an accurate result a BER test should be run until at least 100 errors have been received. This provides a 90% confidence level in the BER value. However, in a relatively error free environment this can take a very long time. An alternative is to run the BER test until at least 10 errors have been received which provides a 68% confidence level. AirTest can be setup to run a BER test. To run a BER test, the TS4000s must be configured with packet operation disabled. This is because when the TS4000 is setup for packet operation it discards corrupted packets and does not send them out the serial port. 1) Attach two TS4000s each to a PC serial port. 2) Configure AirTest for serial port settings (baud rate, data bits and parity) that match the attached TS4000’s settings (Setup Manu – Port Setup). 3) Select and start one of the automated tests. To select a test, use the Test Setup command from the Setup menu. Use the on-line help for details about the different tests. 4) Observe the results by click on the Show Status button on the Comm Port window. TS4000 Radio Modem User’s Manual Testing 68 AirScan enables the TS4000 to be used as a frequency scanner. AirScan is useful for determining the frequency and magnitude of potential interference within the TS4000’s frequency band. AirScan To start AirScan press the AirScan button on the main screen of the configuration program. AirScan Controls Display Center Frequency Frequency Span AirScan scans each channel within a set range of frequencies. The granularity of the scan is fixed at the minimum channel spacing of the TS4000. Selection Live Description In this mode the scanning overwrites the previous values of signal magnitude. Peak Hold The display shows only the largest magnitude signal. Use the Clear Screen button to reset the values. This sets the frequency in the middle of the display. Note that the frequencies at the edges of the display are also indicated. This is the frequency span from the left edge to the right edge of the display. TS4000 Radio Modem User’s Manual Testing 69 Remote Diagnostics Remote diagnostics is used to check the status of remote TS4000s over the air. This allows the radio communications for a system to be setup and tested independent of the host equipment. Remote diagnostics is available while the host system is in operation and can be accessed through serial port 1 or 2 of the TS4000. The remote diagnostics screen is accessed from the main screen of the TS4000 Configuration Program. Remote diagnostics is an extra cost firmware option which can be used with any TS4000. The remote diagnostics firmware option upgrade is accomplished the same way as a standard firmware upgrade (see Upgrading Firmware). Please contact Teledesign for ordering information. Remote Diagnostics with Repeaters When using remote diagnostics in a system with store and forward repeaters, it is important that the repeaters are enabled to repeat individually addressed packets. The remote diagnostic packets are all individually addressed because only one unit is queried at a time. Many systems use network broadcast packets (received by all TS4000s) and the repeaters are configured only to repeat these packets. For details see the section AirNet Packet Protocol – Configuration Options – Packet General. Remote Diagnostics Screen Remote Diagnostic Controls Serial Port To use remote diagnostics, open the Remote Diagnostics screen of the TS4000 Configuration Program. This requires version 5.00 or later version of the configuration program. These controls configure the serial port and must be set to match the configuration of the TS4000s serial port. TS4000 Radio Modem User’s Manual Remote Diagnostics 70 To have the program set these automatically, connect to the modem (Modem menu – Connect to Modem), then select the desired retrieve button. The program will then disconnect from the modem and set the serial port settings to match the modem. Retrieve Local Diagnostics Address This button is used to retrieve the diagnostics data from the TS4000 that the PC is physically connected to. This function does not require the remote diagnostics firmware upgrade option. These defines the address of the TS4000 that will be queried over the air. They can also be used to choose the address to be removed from the diagnostics list. Retrieve Remote Diagnostics from One Unit This button retrieves the remote diagnostics data from the TS4000 indicated by the address controls. Retrieve Remote Diagnostics from All Units in List This button retrieves the remote diagnostics from all TS4000s in the diagnostics list. Maximum Response Time This is the maximum time that the program will wait for a diagnostics response. Continuous Polling Clear Successes/Attempts Diagnostics List When this is enabled, the type of diagnostics selected (Local, Retrieve One or Retrieve All) will be polled repeatedly until it is stopped. The time between polls is set with the Repeat Time control. This will clear the Successes/Attempts field of the diagnostics list. All other fields will be unaffected. Field Group Address Description Group address of the modem. Individual Address Individual address of the modem. An A or B after the address indicates that the modem is part of a redundancy switch and which modem it is. This field indicates the path of the diagnostics data. Local: The data is from the modem physically connected to the PC Direct: The data was received over the air without being repeated by a store and forward repeater. Repeater: The data was received over the air through a store and forward repeater. The address of the repeater is also shown. The data may come though multiple repeaters and the list will show the last five repeaters with the most recent repeater listed first. The path field can be expanded to show additional repeater addresses. The RSSI (Receive Signal Strength Indication) value of the incoming response packet measured at the local modem. For a local path, this field indicates the RSSI of the last received packet. The units are –dBms (negative dBms) and therefore a lower value indicates a larger received signal. Path RSSI Inbound TS4000 Radio Modem User’s Manual Remote Diagnostics 71 Field RSSI Outbound RSSI Repeater Input Voltage Radio Voltage Temp Tx Power Forward Tx Power Reflected Successes/ Attempts Response Time Last Attempt Remote Diagnostics Request and Response Strings Description The RSSI (Receive Signal Strength Indication) value of the outgoing request packet measured at the remote modem. The units are –dBms (negative dBms) and therefore a lower value indicates a larger received signal. The RSSI (Receive Signal Strength Indication) value of the returning response packet measured at the first repeater that repeats the packet (see Path, above, for information on the repeater list). The units are –dBms (negative dBms) and therefore a lower value indicates a larger received signal. The input voltage of the modem. This voltage is measured after a series diode and therefore is typically about 0.3 volts under the voltage at the power leads. The regulated radio voltage of the modem. The internal temperature of the modem. The forward (outgoing) transmit power of the modem. This field is not available on all TS4000 models. The transmit power reflected back into the modem. This field is not available on all TS4000 models. The number of successfully received diagnostics packets and the number of attempts. The over the air response time of the last successful attempt. The accuracy of this number may depend on the operating system and processor loading of the PC. The status of the last attempt. The remote diagnostics function can be used by the user’s host equipment using the appropriate request and response strings. Details on these can be found in Appendix E. TS4000 Radio Modem User’s Manual Remote Diagnostics 72 Upgrading Firmware The TS4000 comes with flash program memory that allows the firmware to be easily upgraded in the field. Firmware is upgraded with the upgrade program which is included as part of the TS4000 configuration program. Upgrading 1) Attach the TS4000 to a PC serial port. 2) Start the upgrade program by pressing the Upgrade Firmware button on the main screen of the configuration program. 3) Select the firmware version or firmware option to upgrade to. a) If the desired firmware version does not show up, us the Find File button (or menu) to manually search for the necessary file. 4) Press the Connect to Modem button to connect the upgrade program to the TS4000. 5) Press the Upgrade button and wait for the upgrade to complete. TS4000 Radio Modem User’s Manual Upgrading Firmware 73 Licensing To be operated legally, radio equipment requires two types of licensing - a manufacturer’s certification that the manufacturer obtains and a users license that the user must obtain. User’s License In most cases, the user of the TS4000 is required to obtain an operating license. This is the case for most frequency ranges in most areas of the world. Licensing is done so that the government can coordinate radio users in order to minimize interference. There are a handful of unlicensed frequency in the VHF band that are available for use in the United States (see Unlicensed Operation below). It is the user’s responsibility to obtain the necessary licenses prior to transmitting over the air with the TS4000. The user is also responsible for proper setup, operation, and maintenance of the TS4000 so that it complies with the limits specified by the license. Changes or modifications not expressly approved by Teledesign Systems Inc. could void the user’s authority to operate this equipment. Shielded cable must be used with this equipment in order to ensure that it meets the emissions limits for which it was designed. It is the responsibility of the user to obtain and use good quality shielded interface cables with this device. Shielded interface cables are available from most retail and commercial suppliers of interface cables designed to work with personal computer peripherals. USA (FCC) The TS4000 is licensed under the FCC (Federal Communications Commission) Part 90 rules. The FCC regulates the operation and licensing of radio equipment in the US. To obtain a license to operate radio equipment a user must fill out the appropriate FCC forms and pay an application fee. Many FCC licenses also require that the user obtain frequency coordination from the appropriate organization. The coordination organizations handle the up front work of qualifying applications and allocating channels. The appropriate coordination organization depends on the type of license (voice, data, paging, etc.), type of user (business, government, etc.) and the frequencies Licensing Service Companies To help with the licensing process, there are companies who, for a fee, will fill out and file the paperwork necessary to obtain a license. Atlas License Company 800-252-0529 www.alcds.com Professional Licensing Consultants 972-248-2400 www.fcc-licensing.com DCI/LAO (Licensing Assistance Office) 800-866-4222 www.dci-lao.com Radio Licensing Services 800-304-8821 www.radiolicensing.com TS4000 Radio Modem User’s Manual Licensing 74 Other Contacts FCC – Federal Communications Commission 888-225-5322 www.fcc.gov PCIA (Coordination agency for most business licenses) 800-759-0300 www.pcia.com International Countries other than the USA have different rules for operating radio equipment. The user should work with the appropriate government agency to obtain the necessary licenses and to make sure that the TS4000 meets the licensing requirements. Manufacturer’s Certification To sell most radio equipment, the manufacturer must obtain a certification that guarantees that their equipment meets the necessary regulations for operation. The regulations vary based on the country and frequency of operation. USA (FCC) Part 15 The TS4000 has been tested and found to comply with the limits for a Class B digital device, pursuant to Part15 of the FCC rules (Code of Federal Regulations 47CFR Part 15). Operation is subject to the condition that this device does not cause harmful interference. Part 90 The TS4000 has been type accepted for operation by the FCC in accordance with Part 90 of the FCC rules (47CFR Part 90). See the label on the unit for the specific FCC ID and any other certification designations. Industry Canada International ICES-003 This Class B digital apparatus meets all requirements of the Canadian Interference-Causing Equipment Regulations. RSS-119 The TS4000 has been certified for operation by Industry Canada in accordance with RSS-119 and RSS-210 of the Industry Canada rules. See the label on the unit for the specific Industry Canada certification number and any other certification designations. Many countries allow radio equipment that meets the FCC rules to be operated. However, some countries have their own rules which radio manufactures must comply with. It is the user’s responsibility to ensure that the TS4000 meets the required regulations. TS4000 Radio Modem User’s Manual Licensing 75 Service and Support We at Teledesign Systems are committed to providing excellent service and support to our customers. Our goal is to make using our products as easy and painless as possible. To accomplish this Teledesign provides free technical support for all our products during all phases of sales, installation, and use. Contacting Teledesign Service and technical support can be reached during our normal business hours of 8 AM to 5 PM (Pacific Standard Time) Monday through Friday. Teledesign Systems can be reached at the following phone numbers. (800) 663-3674 or (800) MODEMS-4 (USA & Canada) (408) 941-1808 (408) 941-1818 (Fax) In addition we have a web site which contains our latest product information and downloads: www.teledesignsystems.com We can be reached by email at: techsupport@teledesignsystems.com productsales@teledesignsystems.com We can be reached by mail at: Teledesign Systems Inc. 1729 South Main Street Milpitas, CA 95035 USA Returning Equipment Before returning equipment to Teledesign, please call for an RMA number and shipping information. This allows us to plan for your shipment in order to provide the best possible service. When returning equipment, please include a note indicating the symptoms of the failure and any other pertinent information. TS4000 Radio Modem User’s Manual Service and Support 76 Warranty Two Year Warranty Teledesign Systems Inc. warrants this product to be free from defects in materials and workmanship for a period of two (2) years from the date of shipment. During the warranty period, Teledesign Systems Inc. will, at its option, either repair of replace products that prove to be defective. Exclusions This warranty shall not apply to any defect, failure or damage caused by misuse, abuse, improper application, alteration, accident, disaster, negligence, use outside of the environmental specifications, improper or inadequate maintenance, or incorrect repair or servicing not performed or authorized by Teledesign Systems Inc. Limitations TELEDESIGN SYSTEMS INC. SHALL IN NO EVENT HAVE OBLIGATIONS OR LIABILITIES TO BUYER OR ANY OTHER PERSON FOR LOSS OF PROFITS, LOSS OF USE OR INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, WHETHER BASED ON CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, OR ANY OTHER THEORY OR FORM OF ACTION, EVEN IF TELEDESIGN SYSTEMS INC. HAS BEEN ADVISED OF THE POSSIBILITY THEREOF, ARISING OUT OF OR IN CONNECTION WITH THE SALE, DELIVERY, USE, REPAIR, OR PERFORMANCE OF THIS PRODUCT (INCLUDING EQUIPMENT, DOCUMENTATION AND SOFTWARE). IN NO EVENT SHALL THE LIABILITY OF TELEDESIGN SYSTEMS INC. ARISING IN CONNECTION WITH ANY PRODUCT EXCEED THE ACTUAL AMOUNT PAID FOR SUCH PRODUCT. THIS WARRANTY IS IN LIEU OF ALL OTHER WARRANTIES, WRITTEN OR ORAL, EXPRESSED OR IMPLIED, INCLUDING IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. TS4000 Radio Modem User’s Manual Warranty 77 Appendix A - Serial Ports Standard Case Connector The standard case uses a DE-9 subminiature 9 pin D connector with female pins for each serial port. Serial Port 1 Pinout Pin Serial Port 2 Pinout Pin Signal Data Carrier Detect (DCD) Receive Data (RD) Transmit Data (TD) Data Terminal Ready (DTR) Alt) Modem Power Signal Ground (SG) Data Set Ready (DSR) Alt) Always in high state Request to Send (RTS) Clear to Send (CTS) Not Connected Alt) Data Set Ready (DSR) Alt) Modem Power Direction Output Output Input Input Input -Output Output Input Output -Output Input Signal Data Carrier Detect (DCD) Receive Data (RD) Transmit Data (TD) Data Terminal Ready (DTR) Signal Ground (SG) Data Set Ready (DSR) Alt) Always in high state Request to Send (RTS) Clear to Send (CTS) Not Connected Alt) Data Set Ready (DSR) Alt) Modem Power Direction Output Output Input Input -Output Output Input Output -Output Input Notes [1] [2] [1] [3] [1] [4] Notes [1] [3] [1] [4] Watertight Case Connector The watertight case uses a single 19 pin LEMO HCG.2B.319 connector with female pins. The recommended mating plug for this connector is a LEMO FGG.2B.319 series cable mounted connector. Pinout Pin TS4000 Radio Modem User’s Manual Port Signal Signal Ground (SG) Data Terminal Ready (DTR) Transmit Data (TD) Receive Data (RD) Data Carrier Detect (DCD) Signal Ground (SG) Data Terminal Ready (DTR) Transmit Data (TD) Appendix A - Serial Ports Direction -Input Input Output Output -Input Input Notes [5] 78 Pin 10 11 12 13 14 15 Port --2 16 17 18 19 Signal Receive Data (RD) Data Carrier Detect (DCD) Ground (Power) Modem Power Clear To Send (CTS) Request To Send (RTS) Data Set Ready (DSR) Alt) Always in high state Not Connected Alt) Data Set Ready (DSR) Request To Send (RTS) Data Set Ready (DSR) Alt) Always in high state Clear To Send (CTS) Direction Output Output -Input Output Input Output Output -Output Input Output Output Output Notes [1] [3] [1] [4] [5] [1] [3] Modem Power Ground Power (+) 12 DTR-2 Data Port 2 Ground (-) 11 CTS-2 TD-2 RTS-2 13 14 CTS-1 18 10 DSR-2 19 RTS-1 RD-1 RI-1 17 RD-2 15 DCD-1 16 DCD-2 DSR-1 TD-1 Ground DTR-1 Data Port 1 TS4000 LEMO Connector (viewed from front of TS4000) Notes [1] These pins have multiple internal signals that they can be connected to. The connection options are selected with internal jumper plugs (see Appendix F Internal Jumper Block). [2] This pin is normally setup as the serial port Data Terminal Ready (DTR) line, which is an input for DCEs (input to the TS4000). As an alternative, this pin can be setup to feed DC power into the TS4000. Caution: The use of the DTR pin for a DC power input connection is non-standard. Therefore the TS4000 serial port must not be connected to a standard serial device that drives the DTR pin (i.e. a PC). This could result in the power supply voltage of the TS4000 being shorted to the DTR output of the host serial port, which could damage to the host device. Therefore, when connecting the TS4000 to a PC for configuration, make sure that the cable does not have a DTR (pin 4) connection. [3] This pin is normally setup as the serial port Data Set Ready (DSR) line, which is an output for DCEs (output of the TS4000). As an alternative, this TS4000 Radio Modem User’s Manual Appendix A - Serial Ports 79 pin can be set to always be in the active high state. In this case the pin is internally connected to +5 volts through a 1 KΩ resistor. [4] For standard RS-232 ports this pin is the Ring Indicator (RI) line, which is an output for DCEs (the TS4000). However, the TS4000 does not have an RI line internally. Instead, this pin can be connected to the serial port Data Set Ready (DSR) line which is an output for DCEs (output of the TS4000), or this pin can be setup to provide DC power into the TS4000. The use of this pin as a power pin is non-standard and therefore care should be taken when connecting the TS4000 to standard serial devices. For most serial ports this is not a problem because RI is a modem (DCE) output and the TS4000 power supply mostly falls within the allowed voltage range for RS-232 signals. Therefore the power voltage on this pin is interpreted as an active RI signal. For systems that use the RI signal differently, or that cannot operate with power on this pin, this pin should be disconnected between the TS4000 and the host equipment. [5] For the watertight version of the TS4000, the alternate jumper block option to supply power to the modem via this pin should not be used due to the amperage limitation of the flex circuit connecting the LEMO connector to the modem board. Standard RS-232 Serial Port Pinout Standard Usage of the RS-232 Control Signals Signal Name Signal Ground Signal Mnemonic SG Connector Pinout 9 Pin 25 Pin 1, 7 Direction DCE DTE --- Transmit Data TD Input Output Receive Data RD Output Input Request to Send RTS Input Output Clear to Send CTS Output Input Data Carrier Detect DCD Output Input Ring Indicator RI 22 Output Input Data Set Ready DSR Output Input Data Terminal Ready DTR 20 Input Output Signal Request to Send (RTS) Description Request for transmission from the DTE. Clear to Send (CTS) Response (to the Request to Send) from the DCE indicating a readiness to transmit data. Data Carrier Detect (DCD) Status from the DCE indicating that it is receiving. Ring Indicator (RI) Status from the DCE indicating that it has detected the ring state. Data Set Ready (DSR) Status from the DCE indicating that it is operational. Data Terminal Ready (DTR) Status from the DTE indicating that it is operational. TS4000 Radio Modem User’s Manual Appendix A - Serial Ports 80 Signal Levels RS-232 Signal Levels Serial port 1 can be configured for either RS-232 or TTL signal levels. The signal level selection is controlled with internal jumper plugs (see Appendix F - Internal Jumper Block). The RS-232 standard defines minimum and maximum voltage levels for the drivers and receivers. However, in practice the drivers and receivers work correctly with signal levels that are different from the specification. Level (volts DC) Low High Type Drivers (into a 3k to 7k ohm load) RS-232 Specification Actual TS4000 Drive Levels -15 to -5 -9 to -6 +5 to +15 +6 to +9 Receivers (with 3k to 7k ohm load) RS-232 Specification Actual TS4000 Receive Levels -25 to -3 -25 to +0.8 +3 to +25 +2.4 to +25 TTL Signal Levels Type Output (Driver) Level (volts DC) Low High 0.0 to +0.4 +3.0 to +5.0 (sinking up to 4 mA) (sourcing up to 4 mA) Input (Receiver) -25 to +0.8 +2.4 to +25 (3k to 7k ohm load) Signal Polarity The signal polarity is the same for both RS-232 and TTL operation. Level Voltage Low State Mark Control signal inactive Stop bit state (end of async character) Logic one data bit state (within async character) Voltage High Space Control signal active Start bit state (beginning of async character) Logic zero data bit state (within async character) TS4000 Radio Modem User’s Manual Appendix A - Serial Ports 81 Appendix B – ASCII Character Set Control Char Ctrl-@ Ctrl-A Ctrl-B Ctrl-C Ctrl-D Ctrl-E Ctrl-F Ctrl-G Ctrl-H Ctrl-I Ctrl-J Ctrl-K Ctrl-L Ctrl-M Ctrl-N Ctrl-O Ctrl-P Ctrl-Q Ctrl-R Ctrl-S Ctrl-T Ctrl-U Ctrl-V Ctrl-W Ctrl-X Ctrl-Y Ctrl-Z Ctrl-[ Ctrl-\ Ctrl-] Ctrl-^ Ctrl-_ Char NUL SOH STX ETX EOT ENQ ACK BEL BS HT LF VT FF CR SO SI DLE DC1 DC2 DC3 DC4 NAK SYN ETB CAN EM SUB ESC FS GS RS US Value Dec Hex 00 01 02 03 04 05 06 07 08 09 10 0A 11 0B 12 0C 13 0D 14 0E 15 0F 16 10 17 11 18 12 19 13 20 14 21 15 22 16 23 17 24 18 25 19 26 1A 27 1B 28 1C 29 1D 30 1E 31 1F TS4000 Radio Modem User’s Manual Char SP “ ‘ Value Dec Hex 32 20 33 21 34 22 35 23 36 24 37 25 38 26 39 27 40 28 41 29 42 2A 43 2B 44 2C 45 2D 46 2E 47 2F 48 30 49 31 50 32 51 33 52 34 53 35 54 36 55 37 56 38 57 39 58 3A 59 3B 60 3C 61 3D 62 3E 63 3F Char Value Dec Hex 64 40 65 41 66 42 67 43 68 44 69 45 70 46 71 47 72 48 73 49 74 4A 75 4B 76 4C 77 4D 78 4E 79 4F 80 50 81 51 82 52 83 53 84 54 85 55 86 56 87 57 88 58 89 59 90 5A 91 5B 92 5C 93 5D 94 5E 95 5F Appendix B - ASCII Character Set Char ‘ DEL Value Dec Hex 96 60 97 61 98 62 99 63 100 64 101 65 102 66 103 67 104 68 105 69 106 6A 107 6B 108 6C 109 6D 110 6E 111 6F 112 70 113 71 114 72 115 73 116 74 117 75 118 76 119 77 120 78 121 79 122 7A 123 7B 124 7C 125 7D 126 7E 127 7F 82 Appendix C – Control and Status Strings General Strings All characters are ASCII and all numbers are formatted as ASCII digits and sent most significant digit first. General Control Strings Control String +TSZ Description Reset the modem. Message Status Strings Status String +TSRxxx Description Receive RSSI preamble. This function must be enabled (see Serial Port section). xxx = receive signal level in –dBms (i.e. +TSR087 = a –87dBm signal level) Note that because the value is in –dBms (negative dBms) a larger signal is represented with a smaller 3 digit number. Frequency Control Strings Control String +TSCxx Description Change channel xx = channel number from 01 to 99 +TSC? Channel query string. Response: 1) +TSCxx - for single channel systems xx = channel number from 01 to 99 2) +TSCCS Modem Configuration Strings Control String +TSWxxx - for systems configured for clear channel scan Description Change transmit power xxx = transmit power in 0.1 watt (i.e. 050 = 5.0 watts) +TSMSFx Change the store and forward repeater operation. Options: 1) +TSMSFA - repeat all packets 2) +TSMSFN - repeat no packets 3) +TSMSFS:gg,aaa-bbb:gg,aaa-bbb:gg,aaa-bbb! - repeat some packets as indicated by the list. address list: :gg,aaa-bbb - this represents a line item in the packet address list. gg - indicates the group address aaa - indicates the starting individual address bbb - indicates the ending individual address examples: :03,006-123 - the modem will repeat packets will repeat packets with a source or destination address in group 3 from 6 to 123. :00,000-000 - the modem will repeat all network TS4000 Radio Modem User’s Manual Appendix E – Control and Status Strings 83 Control String Description broadcast packets regardless of their source address. :05,000-000 - the modem will repeat all group broadcast packets going to group 5 regardless of their source address. There can be a maximum of 20 addresses in the list. 4) +TSMSF? Response: i) +TSRSFA - query the store and forward setting - modem configured to store and forward all packets ii) +TSRSFN - modem configured to store and forward no packets iii) +TSRSFS - modem configured to store and forward some packets. The list of addresses has the same format as the set list above. iv) +TSRSFX - invalid setting or the modem is configured for packet type store and forward filtering. +TSMPP Program the configuration parameters into non-volatile memory. This process may take as long as 1 second. During this time, the modem will be unavailable for normal operation. Packet Strings Packet Control Strings All numbers are formatted as ASCII digits and sent most significant digit first. iii - Represents a three digit individual address. gg - Represents a two digit group address. nn - Represents a two digit packet number. Control String +TSI Description Set for individual transfer. +TSIAiii Set for individual transfer with address change. The three address characters change the individual destination address. +TSICggiii Set for individual transfer with complete address change. The first two characters are for the group address and the remaining three are for the individual destination address. +TSN Set for individual without acknowledgment transfer. +TSNAiii Set for individual without acknowledgment transfer with address change. The three address characters change the individual destination address. +TSNCggiii Set for individual without acknowledgment transfer with complete address change. The first two characters are for the group address and the remaining three are for the individual destination address. +TSG Set for group broadcast transfer. +TSGAgg Set for group broadcast transfer with address change. The two address characters change the group destination address. TS4000 Radio Modem User’s Manual Appendix E – Control and Status Strings 84 Control String +TSB Description Set for a network broadcast transfer (to all modems). +TSFAggiii Change the modem destination address. The first two address characters are for the group address and the remaining three are for the individual address. The type of transfer remains unchanged. This command will change the destination address of the serial port that the command is sent to. If serial port 2 is not enabled for data, then the command will always change the serial port 1 destination address regardless of which port it is sent to. +TSFA? Query the modem destination address. Response: +TSFAggiii +TSSnn Set the packet number of the next packet transmitted. Packet numbers are used in status strings to indicate the success or failure of the transmission of a particular transmit packet. The packet number is set to 0 when the modem is reset. +TSLAggiii Change the modem source address. The first two address characters are for the group address and the remaining three are for the individual address. This command will change the source address of the serial port that the command is sent to. If serial port 2 is not enabled for data, then the command will always change the serial port 1 source address regardless of which port it is sent to. +TSLA? Query the modem source address. Response: +TSLAggiii Packet Status Strings Status String +TSIAggiii Description Received an individual packet from this address. The first two address characters represent the group address and the next three the individual address. +TSNAggiii Received an individual without acknowledgment packet from this address. The first two address characters represent the group address and the next three the individual address. +TSGAggiii Received a group broadcast packet from this address. The first two address characters represent the group address and the next three the individual address. +TSBAggiii Received a network broadcast packet from this address. The first two address characters represent the group address and the next three the individual address. +TSSFnn Indicates that the transfer of this packet number was not successful. This status string is returned after the last retry of this packet has timed out. This does not apply to any type of broadcast packet or individual without acknowledgment packets. +TSSPnn Indicates that the transfer of this packet number was successful. This does not apply to any type of broadcast packet or individual without acknowledgment packets. TS4000 Radio Modem User’s Manual Appendix E – Control and Status Strings 85 Diagnostics Strings Diagnostics Request Strings Control String +TSDL Description Request diagnostics from the local modem. +TSDAggiii Request remote diagnostics from the modem with address ggiii. gg = Group address as ASCII characters iii = Individual address as ASCII character Local Diagnostics Response Structure The local diagnostics response is a total of 45 bytes with the following fields. Structure Field Header Description +TSDL This is a five character string in ASCII format. Local Address A five character string of numbers (most significant digit first) in ASCII format that indicates the address of the local modem. The first two characters indicate the group address. The last three characters indicate the individual address. Diagnostic Version A single binary character indicating the version of this structure. Reserved One byte – reserved for future use Local RSSI A one byte binary number indicting the RSSI (Rx Signal Strength Indication) of the last message received. In units of –dBms (negative dBms)(i.e. a 87 = -87dBm). A lower number indicates a stronger receive signal. Repeater RSSI A one byte field that is unused for local diagnostics. Remote RSSI A one byte field that is unused for local diagnostics. Input Voltage A two byte (high byte first) binary number indicting the input voltage in 0.01 volt increments (i.e. 2432 = 24.32 volts). Note that this voltage is measured after a series diode and therefore is typically about 0.3 volts under the voltage at the power leads. Radio Voltage A two byte (high byte first) binary number indicting the regulated radio voltage in 0.01 volt increments (i.e. 2432 = 24.32 volts). Temperature A two byte (high byte first) binary number indicting the internal temperature in degrees Celsius RF Forward Power A two byte (high byte first) binary number indicting the forward (outgoing) transmit power in 0.1 watt increments (i.e. 34 = 3.4 watts). This field is not available on all TS4000 models. A value of -1 (0xFFFF) indicates that this is not available from the TS4000. A value of -32768 (0x8000) indicates that there has not been a transmission since the last reset and therefore no measurement has been taken. RF Reflected TS4000 Radio Modem User’s Manual A two byte (high byte first) binary number indicting the Appendix E – Control and Status Strings 86 Structure Field Power Description reflected (incoming) transmit power in 0.1 watt increments (i.e. 34 = 3.4 watts). This field is not available on all TS4000 models. A value of -1 (0xFFFF) indicates that this is not available from the TS4000. A value of -32768 (0x8000) indicates that there has not been a transmission since the last reset and therefore no measurement has been taken. Redundancy A one byte field indicating if the TS4000 is part of a redundancy switch setup. 0 = Not in a redundancy switch 1 = The TS4000 is the A modem in a redundancy switch 2 = The TS4000 is the B modem in a redundancy switch Remote Diagnostics Response Structure Unused A nine byte field that is not currently used. Store and Forward Repeater List A ten byte field that is unused for local diagnostics. The remote diagnostics response is a total of 45 bytes with the following fields. Structure Field Header Description +TSDA This is a five character string in ASCII format. Local Address A five character string of numbers (most significant digit first) in ASCII format that indicates the address of the remote modem. The first two characters indicate the group address. The last three characters indicate the individual address. Diagnostic Version A single binary character indicating the version of this structure. Reserved One byte – reserved for future use. Local RSSI A one byte binary number indicting the RSSI (Rx Signal Strength Indication) of the last message received. In units of –dBms (negative dBms)(i.e. a 87 = -87dBm). A lower number indicates a stronger receive signal. Repeater RSSI A one byte binary number indicting the RSSI (Rx Signal Strength Indication) of the returning request message at the first repeater that hears it. In units of –dBms (negative dBms)(i.e. a 87 = -87dBm). A lower number indicates a stronger receive signal. Remote RSSI A one byte binary number indicting the RSSI (Rx Signal Strength Indication) of the transmitted (outgoing) request message at the responding unit. In units of –dBms (negative dBms)(i.e. a 87 = -87dBm). A lower number indicates a stronger receive signal. Input Voltage A two byte (high byte first) binary number indicting the input voltage in 0.01 volt increments (i.e. 2432 = 24.32 volts). Note that this voltage is measured after a series diode and therefore is typically about 0.3 volts under the voltage at the TS4000 Radio Modem User’s Manual Appendix E – Control and Status Strings 87 Structure Field Description power leads. Radio Voltage A two byte (high byte first) binary number indicting the regulated radio voltage in 0.01 volt increments (i.e. 2432 = 24.32 volts). Temperature A two byte (high byte first) binary number indicting the internal temperature in degrees Celsius RF Forward Power A two byte (high byte first) binary number indicting the forward (outgoing) transmit power in 0.1 watt increments (i.e. 34 = 3.4 watts). This field is not available on all TS4000 models. A value of -1 (0xFFFF) indicates that this is not available from the TS4000. A value of -32768 (0x8000) indicates that there has not been a transmission since the last reset and therefore no measurement has been taken. RF Reflected Power A two byte (high byte first) binary number indicting the reflected (incoming) transmit power in 0.1 watt increments (i.e. 34 = 3.4 watts). This field is not available on all TS4000 models. A value of -1 (0xFFFF) indicates that this is not available from the TS4000. A value of -32768 (0x8000) indicates that there has not been a transmission since the last reset and therefore no measurement has been taken. Redundancy A one byte field indicating if the TS4000 is part of a redundancy switch setup. 0 = Not in a redundancy switch 1 = The TS4000 is the A modem in a redundancy switch 2 = The TS4000 is the B modem in a redundancy switch Unused A nine byte field that is not currently used. Store and Forward Repeater List A ten byte field that indicates the addresses of the last 5 store and forward repeaters that the response message was repeated by. Each repeater address is a two byte field (high byte first) with the 6 most significant bits indicating the group address (a value from 1 to 60) and the 10 least significant bits indicating the individual address (a value from 1 to 999). The address of the most recent store and forward repeater that the response packet was repeated by is at the end of the list. If the packet was not repeated by any store and forward repeaters then the entire field will be zeros. If the packet was repeated by one store and forward then the last two bytes of this field will indicate the address of the repeater and the remaining 8 bytes will be zeros. TS4000 Radio Modem User’s Manual Appendix E – Control and Status Strings 88 Appendix D – Internal Jumper Block The TS4000’s jumper block lies between the radio flex circuit connector and serial port connector on the top side of the modem circuit board. With the radio flex circuit connector on the right side of the jumper block, the jumper block will be oriented as shown below with pin 1 located at the bottom right corner. Unless otherwise specified by the customer, the TS4000 is shipped from the factory with eleven jumpers installed as shown below. Factory Default Jumper Settings TS4000 Jumper Block Default Factory Settings Ground 32 31 CPU I/O (spare) 30 29 Port 2 DSR 1k pullup Port 2 DSR RS232 signal 28 27 Port 2 DSR pin Port 2 RI pin 26 25 Port 2 RI pin DC power 24 23 DC power Port 1 DSR RS232 signal 22 21 Port 1 DSR TTL signal Port 1 RI pin 20 19 Port 1 RI pin DC power 18 17 DC power Port 1 DTR pin 16 15 Port 1 DTR pin Port 1 CTS RS232 signal 14 13 Port 1 DTR RS232/TTL signal Port 1 CTS pin 12 11 Port 1 CTS TTL signal Port 1 RD pin 10 9 Instructions for Accessing the Jumpers Port 1 RD TTL signal Port 1 RD RS232 signal Port 1 DSR RS232 signal Port 1 DSR TTL signal Port 1 DSR pin Port 1 DCD RS232 signal Port 1 DSR 1k pullup Port 1 DCD pin Port 1 DCD TTL signal Caution: This procedure should be performed on an Electro-Static Discharge (ESD) safe work surface to insure that the internal circuitry of the TS4000 radio modem is not damaged. Remove the four 4-40 x 3/8” hex socket head screws on the outside corners of the TS4000’s front face plate. Place the small flat blade screw driver between the front face plate and the case on the bottom of the radio modem near the serial port 1 connector. Gently pry the front face plate away from the edge of the case until the front face plate and radio modem subassembly releases from the thermal pad at the rear of the case. Slide the radio modem subassembly completely out of the case. Remove the two 3/16” hex jack screws holding the serial port 2 connector to the front face plate. Using the small flat blade screw driver, gently rock the 50 pin flex circuit connector out of the connector on the modem circuit board. Rock the connector by placing the small flat blade screw driver under the brown end tabs of the connector and against the silver brackets on the sides of the modem circuit board. Apply pressure to gently lift up each end of the flex connector, alternating sides until the flex connector pops free of the TS4000 TS4000 Radio Modem User’s Manual Appendix F – Internal Jumper Block 89 board. Do not pull on the flex circuit to remove the flex connector from TS4000 because this will damage the flex circuit. Jumper Settings for Power on Serial Port 1 - Pin 9 Lift the body of the serial port 2 connector up and on top of the radio module circuit board to move the flex circuit away from the jumper block. With the radio flex connector on the right side of the jumper block, the jumper block will be oriented as shown above with pin 1 located at the bottom right corner. To enable power on pin 9 (RI - Ring Indicator) of serial port 1, locate the jumpers across pins 17 and 18, and pins 19 and 20. Remove these two jumpers using the small needle-nose pliers or tweezers and reinstall the jumpers across pins 17 and 19, and pins 18 and 20, as shown below. Port 1 - Pin 9 RI Signal Jumpers 20 19 20 19 18 17 18 17 Open Modem (default) Power Jumper Settings for Power on Serial Port 1 - Pin 4 To enable power on pin 4 (DTR – Data Terminal Ready) of serial port 1, locate the jumpers across pins 13 and 15, and pins 17 and 18. Remove these two jumpers using the small needle-nose pliers or tweezers and reinstall the jumpers across pins 15 and 17, and pins 16 and 18, as shown below. Caution: The use of the DTR pin for a DC power input connection is nonstandard. Therefore the TS4000 serial port must not be connected to a standard serial host device that drives the DTR pin (i.e. a PC). This could result in the power supply voltage of the TS4000 being shorted to the DTR output of the host serial port, which could damage the host device. Therefore, when connecting the TS4000 to a PC for configuration, make sure that the cable does not have the DTR (pin 4) line connected. Port 1 - Pin 4 DTR Signal Jumpers 18 17 18 17 16 15 16 15 13 13 Port 1 DTR RS-232/ TTL Signal TS4000 Radio Modem User’s Manual Modem Power Appendix F – Internal Jumper Block 90 Jumper Settings for Power on Serial Port 2 - Pin 9 To enable power on pin 9 (RI - Ring Indicator) of serial port 2, locate the jumpers across pins 23 and 24, and pins 25 and 26. Remove these two jumpers using the small needle-nose pliers or tweezers and reinstall the jumpers across pins 23 and 25, and pins 24 and 26, as shown below. Port 2 - Pin 9 RI Signal Jumpers 26 25 Jumper Settings for TTL Levels on Serial Port 1 26 25 24 23 24 23 Open (default) Modem Power To enable TTL levels for serial port 1 move the following jumpers as shown below. Move the jumper across pins 2 and 4 to pins 1 and 2. Move the jumper across pins 5 and 7 to pins 5 and 6. Move the jumper across pins 8 and 10 to pins 9 and 10. Move the jumper across pins 12 and 14 to pins 11 and 12. TS4000 Jumper Block Serial Port 1 TTL Level Settings Ground 32 31 CPU I/O (spare) 30 29 Port 2 DSR 1k pullup Port 2 DSR RS232 signal 28 27 Port 2 DSR pin Port 2 RI pin 26 25 Port 2 RI pin DC power 24 23 DC power Port 1 DSR RS232 signal 22 21 Port 1 DSR TTL signal Port 1 RI pin 20 19 Port 1 RI pin DC power 18 17 DC power Port 1 DTR pin 16 15 Port 1 DTR pin Port 1 CTS RS232 signal 14 13 Port 1 DTR RS232/TTL signal Port 1 CTS pin 12 11 Port 1 CTS TTL signal Port 1 RD pin 10 9 TS4000 Radio Modem User’s Manual Port 1 RD TTL signal Port 1 RD RS232 signal Port 1 DSR RS232 signal Port 1 DSR TTL signal Port 1 DSR pin Port 1 DCD RS232 signal Port 1 DSR 1k pullup Port 1 DCD pin Port 1 DCD TTL signal Appendix F – Internal Jumper Block 91
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.6 Linearized : Yes Encryption : Standard V2.3 (128-bit) User Access : Extract XMP Toolkit : Adobe XMP Core 4.0-c316 44.253921, Sun Oct 01 2006 17:14:39 Producer : Acrobat Distiller 7.0.5 (Windows) Create Date : 2012:03:23 11:27:19-07:00 Creator Tool : Acrobat PDFMaker 7.0.7 for Word Modify Date : 2012:04:06 13:17:36-07:00 Metadata Date : 2012:04:06 13:17:36-07:00 Format : application/pdf Title : TS4000 User's Manual Creator : Document ID : uuid:0b3ea740-bb62-4fde-a26c-cd451786deb1 Instance ID : uuid:9b04be98-6c65-427c-bac4-4c008ea45b92 Company : Teledesign Systems Inc. Page Count : 97 Page Layout : OneColumn Author :EXIF Metadata provided by EXIF.tools