Boomer II OEM Modem Module User Manual and Integrator’s Guide November 2002
© Wavenet Technology Pty Ltd ACN 079 965 003 Publication No. BM210012WT27 Published November 2002 This publication is copyright and no part may be reproduced or copied without the prior consent of: Wavenet Technology Pty Ltd. 140 Burswood Rd Burswood, 6100 Western Australia Telephone: Facsimile: E-mail: Web Site: +61 8 9262 0200 +61 8 9355 5622 wavenet@wavenet.com.au www.wavenet.com.au This manual is intended to be used for the operation of Wavenet Technology equipment.
Boomer II User Manual & Integrator’s Guide __________________________________________________ Contents Contents Introduction ......................................................................................................9 Applications ................................................................................................11 Compliance Statement ...............................................................................12 Information for Your Safety........................................
Contents __________________________________________________ Boomer II User Manual & Integrator’s Guide Serial Communications Interface ............................................................35 Status Input / Output lines ......................................................................37 LED Indicators ........................................................................................38 LED Output Lines ...................................................................................
Boomer II User Manual & Integrator’s Guide __________________________________________________ Contents Desense and EMI.......................................................................................68 Regulatory Compliance ..............................................................................69 Application Software...................................................................................70 Software Driver Configuration.................................................................
Contents __________________________________________________ Boomer II User Manual & Integrator’s Guide Standard Context Routing (SCR) ...............................................................93 SCR Message Types..............................................................................94 Highlights of SCR Differences ................................................................94 SCR Header Charts ...................................................................................
Boomer II User Manual & Integrator’s Guide __________________________________________________ Contents Appendix C – Sample programs ..................................................................165 Client Application......................................................................................165 Server Application ....................................................................................168 Initialisation and Login .....................................................................
Contents __________________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 8 BM210012WT27
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction Introduction The Boomer II OEM Modem Module is a radio packet modem, intended for use on Motorola DataTAC 4000 SFR and DataTAC 5000 MFR data communication networks. It is primarily designed to be integrated into customer equipment as an OEM module, for use with a host running wireless applications or as the RF communications enabler device for telemetry products.
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide This manual contains the following sections: Section 1: Introduction Section 2: The Integrator’s Task Section 3: Installing the Modem Section 4: Modem Test Jig Section 5: Testing Section 6: Desense Section 7: Application Development Section 8: Message Routing and Migration In addition there is very useful reference information contained in the numerous Appendices which the reader may lik
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction Applications Suitable devices in which the Boomer II OEM Modem can be used include the following applications: Meter Reading The modem can be used to read billing information from intelligent electrical meters and basic disc meters. Data is transmitted wirelessly through a radio network to billing computers.
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide Compliance Statement This device has not been authorized as required by the rules of the Federal Communications Commission (FCC). This device is not, and may not be, offered for sale or lease, or sold or leased within the USA, until authorization is obtained.
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction Information for Your Safety Please read these safety instructions and the operation instructions provided in this manual before operating the Boomer II OEM Modem. Safe Use Switch the modem off in areas where radio devices are forbidden, or when it may cause interference or danger.
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide Integrator Developers Kit Wavenet has made available an Integrator Developers Kit which contains all the components necessary to get an evaluation and development platform up and running in the shortest possible time.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task The Integrator’s Task This section provides background information and points out the objectives and tasks of reaching the goal of a successful implementation. Areas of Focus Benefits Serial Port Pass-Through Capability Enables modem diagnostics and software upgrades without the need to disassemble the host device or terminal. Understanding RF Design Provides the required network coverage.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide Plan the Product and Create the Design To plan the product and create the design, perform the following steps: Develop a usage model. Develop a message model. Define a service strategy. Investigate and obtain regulatory approval.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task support for packet headers, the number of active users on a shared RF channel can directly affect network throughput. Define a Service Strategy The service strategy determines whether the integrated modem is the cause of a user’s problem and sets a policy for keeping the end user operational during repair.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide Diagnostic Capabilities To provide modem diagnostics, there are three LEDs on the modem itself. When the unit is first powered up it goes through its own self test and the status is reflected in the visual status of the LEDs. Customer Problem Isolation When application-visible problems are discovered in the field, you must isolate the source of the problem.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task Develop and Validate the Hardware To develop and validate the hardware, perform the following steps: Design the hardware platform Consider power supply options Select the source antenna Set up a development test environment Design the Hardware Platform Integrating a wireless modem into a hardware design requires many steps.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide evaluation board allows for maximum flexibility in accessing and controlling connections into and out of the modem. Wavenet also provides various software utilities that can help in performing development tests. See “Testing” on page 67.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task Wavenet provides a test facility for measuring host emissions and subsequent modem desense of integrated host terminals. See “Desense and EMI” on page 68. In addition, see “Desense” on page 73.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide Reinsert connectors straight and evenly to avoid causing short and open circuits. ESD Handling Precautions The Boomer II OEM modem contains components sensitive to ESD (electrostatic discharge). For example, people experience up to 35kV ESD, typically while walking on a carpet in low humidity environments. In the same manner, many electronic components can be damaged by less than 1000 volts of ESD.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task Regulatory Requirements You are required to obtain regulatory approval of products that integrate the Boomer II OEM wireless modem into a host device or terminal. The specific details for achieving regulatory approval vary from country to country.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide service test house if you have limited expertise in meeting the regulatory requirements of a specific country. All certification tests must be made by a qualified laboratory to ensure that the equipment complies with the applicable technical standards.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task If the Boomer-II OEM Modem Module is used in a mobile or fixed application and if the integrator uses one of the above antennae with an antenna lead length no shorter than 150mm, the MPE limits will not be exceeded.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide Labelling The FCC requires the integrated product to be labelled as shown here: “This product contains a type-accepted transmitter approved under FCC ID: PQS-BM2xxxxx.” Refer to FCC CFR 47, Part 2, Subpart J for information on obtaining an FCC grantee code, FCC identifier requirements, label requirements, and other equipment authorisation procedures.
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task Air Interface Protocols Data exchange protocols transport data between the host device or terminal and the network. Within the radio portion of the network, between the device and the base station, specialized RF protocols (RDLAP or MDC4800) carry the data. These radio protocols are typically transparent to wireless applications. The modem communicates over radio frequency channels using the RD-LAP 9.
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 28 BM210012WT27
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Installing the Modem This section will help you to successfully integrate the Boomer II OEM Modem into your custom application. When integrating a wireless modem, internal connections and placements are critical to a successful implementation.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Other considerations include mobile usage, which typically implies vehicular applications. Some of the design implications of mobile usage include: Resets The design must attempt to eliminate modem resets caused by supply voltage drops while the vehicle is starting. This is very disruptive to the network link.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Proper mounting of the modem requires securely fastening it within the product housing. The mating surface should be flat and ensure a rigid mounting for the modem to minimise the transmission of vibration to the unit. There should be an adequate supply of airflow to ensure the modem’s temperature limits are not exceeded.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide The modem utilises connector part number 803-30-T-U from A-Point, however, connector equivalents such as F006-52893 from Molex as shown below, may also be used in the host device or terminal. 20.4mm 14.5mm 14.5mm Molex FPC Connector F006-52893 Pin 1 of the connector is adjacent to the LED window and its location is shown below.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Data Interface Pin Descriptions Pin Signal Description Signal Reset State 1 DCD Data Carrier Detect Output High Impedance 2 RXD Receive Data Output High Impedance 3 TXD Transmit Data Input 100k pull up to 3.3V 4 DTR Data transmit ready Input 100k pull up to 3.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Modem On/Off Control The modem on/off input line (HOSTPWR_ON) is an active high input signal and is fitted with a 33Ω series resistor and clamp diode to the internal supply line for input protection. Internally it is passively pulled low (after the series resistor) via a 56kΩ pull-down resistor to ground and is asserted with an actively driven high signal.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation It is acceptable to drive this input with a NPN transistor or N-channel MOSFET connected to ground with a 4k7Ω pull-up resistor to 3.3V Warning: When the modem is turned off using the HOSTPWR_ON signal, all other signals connected to the Data Interface Connector should also be turned off or set to 0V otherwise the modem may remain powered on via these signals.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide If the modem is to be connected directly to a PC or other RS232 device, an interface must be provided to convert the signal voltage to the higher values required by an RS232 device. The protocol supported over this link is the Native Control Language (NCL). The data format for NCL is: 8 data bits, no parity, 1 stop bit.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Serial Communications Interface Definitions J1 Pin # Signal 1 Description Signal Active State DCD Data Carrier Detect Output Low when modem in-range 2 RXD Receive Data Output Low when active 3 TXD Transmit Data Input Low when active 4 DTR Data transmit ready Input Low when ready 6 DSR Data set ready Output Low when ready 7 RTS Request to send 8 CTS Clear to send 9 RI
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Status Input/Output Interface Definitions J1 Pin # Signal 16 SS0 Status Signal 0 Input/ Output User configurable (future option) 17 SS1 Status Signal 1 Input/ Output User configurable (future option) 18 SS2 Status Signal 2 Input/ Output User configurable (future option) 19 SS3 Status Signal 3 Input/ Output User configurable (future option) Description Signal Active State LED Ind
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation LED Output Lines In addition to the on-board LEDs there are three signal lines (Low Battery, Message Waiting, In-range), which are controllable by the modem for connection to an external LED. Each line has a 33Ω series resistor and clamp diode to the internal supply line for protection. It is recommended a series resistor be used with the external LED to limit current accordingly.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide transitions will occur at the same time as the low battery event occurs (or would occur if the event was activated). Note that in the case of a very fast transition between voltages, it may take up to 20 seconds for the modem to confirm a change in battery status.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation market relatively thin double braid coaxial cables. These cables show much better isolation than single braid cables, typically by 30 to 40dB. These double braid cables reduce radiation and RF pick-up when routed inside a portable device.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Selecting an Antenna The requirements for the antenna used with the Boomer II OEM Modem are: Antenna Gain: 1 dBi (isotropic) maximum average gain if module FCC approvals are to be used without separate equipment approval for the host product.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Positioning the Antenna Positioning the antenna will affect the gain provided by the antenna. The antenna should be orientated so that it provides vertical polarisation as the DataTAC network is based on vertically polarised radio-frequency transmission. The antenna should be located as far from the active electronics of the computing device as possible.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide The algorithm for the Source Based Time Averaging transmit control and the relevant parameters are given below: Idle_Time = Duty_Factor * Transmit_Duration Duty Factor = (100 – Duty_Cycle%) / Duty_Cycle% Duty_Cycle% = Preset limit for SAR compliance No Any data to transmit? Yes Has the transmit Idle_Time expired? Buffer data Decrement Idle_Time Yes No Wait for data Decrement Idle_Time Transmit d
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Supplying Power The Boomer II OEM Modem must be provided with a clean power source capable of delivering bursts of high current. The modem draws its power in bursts. The power required changes rapidly depending on whether the modem is transmitting, receiving or on standby. Ratings The power supply requirements are: Voltage: 3.8V (3.4 to 4.2V range) Transmit Current: 1.6A maximum (2.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide The power supply should be set above nominal 3.8V to accommodate worst case power supply drop. i.e. 4.0V. The power supply should have good regulation with < 200mV drop at 2.2A. Adequate supply decoupling (10,000uF min.) is added at terminal connector to reduce ripple and smooth supply voltage steps. The power supply be capable of supplying non-ideal current consumption conditions of up to 2.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Off The modem is turned off or the host (battery) has failed. Sleep The processor is sleeping and wakes up to an interrupt, but the RF section is off. Receive The processor is actively processing information; the RF sections are on and demodulating data. Transmit The processor is actively processing information; the RF sections are on and transmitting data.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide modem's factory loaded individual LLI) increases the percentage of time the modem stays in the receive state, thereby increasing its overall current consumption. Roaming Time The amount of time the modem spends scanning a channel or roaming to a new channel will affect the current consumption. The current consumption is dependant on the Network type (Private or Public) and the System type (MFR or SFR).
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Power-Up Timing Diagram Optional Delay HOST 3.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Power Down Sequence The terminal host may request the modem to turn OFF by de-asserting the HOSTPWR _ON or by sending a specific NCL command across the serial interface. For the modem to turn OFF after an NCL request the HOSTPWR_ON signal must be de-asserted. Warning: The power supply rail must be maintained during a power down sequence or else memory may be corrupted.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Power Down Diagram Callouts 1 HOSTPWR_ON is de-asserted from the host device to the modem. Important: The power rail must be present for up to ten seconds (typically two seconds) after HOSTPWR_ON is de-asserted for the deregistration process to complete orderly. 2 The modem starts the soft shutdown process. The battery status indicator pulses quickly until the shutdown steps are complete.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Internal impedance of 25-30µΩ per 1.2V cell Typical cell voltages are 1.2V, with multiple cells used to obtain higher operating voltages Can withstand high current pulses, which are characteristic of packet data applications Typical charge method is −∆ V (known as negative delta voltage), which involves charging the battery while looking for the battery voltage to peak.
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation Availability is an issue, as most suppliers do not sell cells, but force customers into particular solutions through their battery pack designs. Purchasing cells in an effort to design your own battery pack may be problematic due to cell lead times. Li-ion does not exhibit the memory effect and is unaffected by partial discharging-charging cycles Internal impedance of 100-150mµΩ per 3.6V cell.
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide Messaging model To determine the required battery capacity for your product, you need to define the messaging model for your target market.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing Using the Modem Test Jig The Boomer II Test Jig provides RS-232 serial interface ports between a PC and the modem. It is designed to enable you to quickly interface the Boomer II to a standard PC (through a COM port) or a terminal device with an RS-232 serial port.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Exploring the Boomer II Test Jig The test jig comprises the following components: DC Jack Input Supply On/Off Switch 3 RDW Header connector VCC test pin 3.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing Port 2 / SPY PC Connector DB9 connector used for two purposes depending upon the settings of the jumper switches located just behind the connector on the PCB. If the jumpers are used to connect the centre column to the right hand outer column (TX, RTS etc), then the port acts as a spy connection for the data between the PC and the modem via the PC connector. An analyser program such as “spy.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Audio Out Connector for monitoring an audio output. Used to monitor base band signal, BIT Error Rate (requires a PER test jig), receiver and demodulation. Warning: Must use a high impedance monitor, 100kΩ. Audio In Connector for monitoring an audio input. Used to monitor modulation and transmission. Warning: Must use a high impedance monitor, 100kΩ.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing Initial Calibration Without connecting a Boomer II OEM Modem to the Test Jig, initially check the calibration of the on-board voltage regulator. (This regulator supplies the RS232 converter and other on-board circuitry only. It does not supply power to the modem). 1. Connect the centre pin of the DC jack to the +3.8V power supply with 2A capability and the external pin to the ground. 2.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Note: If the cable has been partially inserted, or out of alignment, the lock lever will not engage. Should this occur, remove the cable (see below) and repeat steps a-c. Use the following procedure to remove the cable from the FPC connector. a. Lift up the lock lever of the FPC connector by flipping it up with the nail of your thumb or index finger. Lock Lever b.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing RSUSER The Radio Service Utility software (RSUSER ) enables a user to exercise and configure Wavenet Modems. This software runs in a DOS window under Windows 95, 98, NT, or 2000. RSUSER interfaces with the Boomer II OEM Modem via a PC’s communications port and the Test Jig’s PC port using an RS-232 cable with DB9 connectors. RSUSER is issued with the following files: RSUSER.EXE The executable RSTEST.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Using RSUSER 1. Supply power to the modem (e.g. via the test jig), switch it on and plug the modem into the communications port of the computer. (Refer to the modem’s user or test jig documentation for cabling and connection instructions). 2. Execute RSUSER.EXE 3. Check that the communication port settings displayed are correct under the Miscellaneous Heading. 4.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing You should see two “CMND…..ILLEGAL BYTE” lines, followed by two “SUCCESS” lines. This is normal. You must reset the modem ( 66 ) before the changes will take effect. If you do not receive the “SUCCESS” responses, reset the modem, reset RSUSER, and try again. + <6> Group LLI Programming This allows you to program up to 16 group LLIs into the non-volatile memory of the modem.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Set Destination LLI Similar to the above option, but sets the destination LLI for messages sent by the "SEND MESSAGES" options. Automatically Set SRC/Dest LLIs And Home Area Automatically queries the modem for its LLI and home area, and sets the above two options with that LLI for loopback tests, and the next option with that home area address.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing + Change Baud Rate This option changes the baud rate the RSUSER program uses. You will be asked for the baud rate you wish to change to. Valid baud rates are 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200. The change will take effect immediately. The baud rate is not preserved on exit from RSUSER. It defaults back to 9600 on next invocation.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide <<> A sequential sequence of ASCII characters will form the data portion of the message. You will be prompted for the length of the data portion of the message. A number from 1 to 2010 is allowed. Message Loopback Options The F9 and F10 commands, together with the above “send message” commands can be used to set up some automatic message sending and loopback tests.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing Testing This section contains a product development checklist of parameters to check, requirements to meet, and standards of performance to evaluate. You can use these process checks and functional test procedures to fully qualify that the Boomer II OEM Modem is well integrated with the host device or terminal.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide the modem and host. Ensure that the following hardware integration issues are evaluated: RF Immunity RF transmissions of the modem do not interfere with operation of the host. Electrical Signaling Power sources and interface are functionally compatible between the host and the modem.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing allows for the identification and analysis of the host components that are responsible for desense. This approach to desense troubleshooting can greatly speed up the OEM integration effort. For more detailed information about desense, refer to “Desense” on page 73.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Application Software Tests need to verify the communications links between the host and the modem and between the modem and the network, as follows: Software Driver Configuration Ensure that the host product can enable the modem serial port to permit the host and modem to communicate. This test verifies that the driver software functions well and is configured properly.
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing outage. For this reason, you should design the application to allow for end-user problem determination. Effective tests provide a systematic, positive acknowledgment from each of the network components.
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 72 BM210012WT27
Boomer II User Manual & Integrator’s Guide __________________________________________________ Desense Desense When you integrate wireless data radio technology into computing and telemetry devices, you must consider hardware issues related to RF emissions. For example, you must address the technical aspects of enabling a wireless RF device as an integrated peripheral in a host device, such as RF performance and inter-operability with the host.
Desense __________________________________________________ Boomer II User Manual & Integrator’s Guide Consistent and reliable reception occurs when a safety margin dictated by co-channel rejection is maintained. For example, if the co-channel rejection is 10dB, all unwanted signals must be 10dB below the receiver’s sensitivity level. Some modems and networks have different rejection levels. Use the rejection level appropriate for your modem (typically –10dB).
Boomer II User Manual & Integrator’s Guide __________________________________________________ Desense Testing directly is preferred method because it is more of a system test. The test must be non-intrusive. Peripheral test cables or apparatus must not be connected to the unit under test, as they can have a significant effect on the receiver sensitivity results. Indirect testing is essentially FCC Part 15 EMI testing that occurs today.
Desense __________________________________________________ Boomer II User Manual & Integrator’s Guide important. If the source is narrow-band, it has less effect than one occupying the entire channel bandwidth. The method is not effective in determining desensitisation at IF frequencies or from less obvious sources such as mixed products. The method provides information on how much effort, if any, needs to occur to resolve desense problems.
Boomer II User Manual & Integrator’s Guide __________________________________________________ Desense Components of the Shield Design To be effective, the shield design must incorporate: A highly conductive shielded enclosure that encapsulates all of the active circuitry. This can be constructed of sheet metal or plated/sprayed plastic. Decoupling on all signals exiting the enclosure Control of aperture sizes in the shield to less than l/10 of the frequency of interest.
Desense __________________________________________________ Boomer II User Manual & Integrator’s Guide The host and modem must communicate the problem at hand to attempt to correct it. This capability is not supported by the Boomer II OEM modem.
Boomer II User Manual & Integrator’s Guide __________________________________________________ Desense Networks can assist in the desense problem by offering more than one channel frequency at which to operate. If the radio encounters interference on a channel, it can then roam to another. WAN protocols include retry mechanisms that resend messages not acknowledged from the subscriber device.
Desense __________________________________________________ Boomer II User Manual & Integrator’s Guide characterize and correct. Most host computers are very fast and include numerous high frequency radiators. These can interfere with the radio reception of the wireless modem. The theoretical levels at which the receiver might be impacted are derived from system coverage requirements and the sensitivity of the radio.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Application Development This section provides comments and advice that can help you develop successful wireless enabled applications for DataTAC systems. Application development for NCL-compliant wireless modem devices is a two-part process. The first step sets up the interface between the device host and the wireless modem.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Roaming Issues During development, consider how the coverage for your wireless enabled application could be affected by a user moving in and out of the network coverage area. Coverage can be temporarily impacted by moving from one side of a building to another. Coverage can be lost for a longer time by moving beyond the network coverage boundary.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Conserve battery life when out-of-range When all channels (from both dynamic and static channel lists) are scanned and network contact is not established, the wireless modem enters a scan-delay state. The scan-delay starts at one second and doubles on each scan cycle failure, to a maximum of 255 seconds between scan cycles.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Inbound SDU Failures Potential SDU inbound failure codes are described below. The list identifies all likely SDU failure responses. The remaining SDU responses that appear in the NCL 1.2 reference manual are not expected to occur within the DataTAC wireless modem. Inbound SDU failure, no response from network The SDU was transmitted, but not acknowledged by the network.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Outbound SDU Failure Due to the unreliable delivery of RF data packets (and their responses), a client application must consider the possibility of an outbound SDU being delivered to the client, with the transport confirmation of that data packet being lost (RF acknowledgment and/or transport level acknowledgment).
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Low battery Network contact is dropped when a low battery condition is reached. This occurs at the same time as a battery alert notification event, but after the assertion of the LOWBAT LED that occurs while the battery still has some remaining usable capacity.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development Radio On/Off on Application Command The radio is the primary power-consuming component in the wireless modem card. Use S_RX_CONTROL for very effective control of session-based, user-initiated applications.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide new channel scan) is about 9 minutes for DataTAC 4000 networks. DataTAC 5000 networks respond typically in 1.5 Power-Save protocol frame times, or about 96 seconds. Wireless Data Systems Considerations The wireless modems application developer must account for the limitations of a wireless data system to minimize their impact on the user.
Boomer II User Manual & Integrator’s Guide _____________________________________ Application Development DataTAC 5000 system is optimised for the transfer of short and medium length messages. Typically, messages up to 512 bytes are transferred across the network as a single data packet. Messages larger than 512 bytes are segmented into 512-byte packets by the DataTAC system before being transmitted over the air. The packets are reassembled before they are delivered to the application.
Application Development _____________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 90 BM210012WT27
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Message Routing and Migration This section offers developers advice on how to migrate their applications. That is, how to create new versions of their wireless applications for porting to other DataTAC® systems. You can also use this information to plan ahead for portability as you begin your initial application development effort.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Network Link Layers Before a message can be routed, it must contain a header and be wrapped in a link layer protocol supported by the DataTAC network. Many link layer protocols are available, but not all are supported by each DataTAC network. The X.25 protocol is common to all three systems and supports both PVC and SVC host connection line types. X.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Standard Context Routing (SCR) SCR allows the central host to communicate with hundreds, even thousands of terminals across a single host connection. But the real advantage of using SCR is economic: The host only pays for a single connection to the network, significantly reducing communications cost.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide SCR Message Types Fleet mode of communications uses three types of messages: Commands / Host Requests (host-to-network) EXAMPLE: Send Message #1 to LLI 87654321 Responses / Host Confirmations (network-to-host) EXAMPLE: Message #1 to LLI 87654321 was ACKed Events / Mobile Information (terminal-to-network-to-host) EXAMPLE: Message received from LLI 12345678 A fourth type of message, the status message, i
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration ASCII versus Binary Encoding DataTAC 4000 system SCR fields are all ASCII encoded fields of numeric values or alphanumeric strings. DataTAC 5000 and 6000 systems use a mixture of ASCII and binary encoded fields. All three systems allow the user to send binary data, regardless of header encoding.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide On DataTAC 6000 systems the host ID field consists of: 1 to 4 bytes ASCII ‘;’ (semicolon) delimiter Host password of 1 to 8 bytes Carriage return On DataTAC 4000 systems the RNG (ARDIS switch) locates the calling X.25 address to verify it is in the database. A valid calling address is then associated with only those terminals allocated to a particular host.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Note: To run your application on DataTAC 4000 or 6000 systems, you must isolate the use of extended SCR or avoid it entirely. Service Data Unit (SDU) Size An application SDU consists of the complete message; both user data and data header. See “Data Header Routing” below. The maximum size of an application SDU is 2048 bytes for DataTAC 5000 and 6000 systems, and 2550 bytes for DataTAC 4000 systems.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide DataTAC System Type Header Fields (Not Shown) Data Header Offset Data Header Data 4000 ... 03 TE1 Hello World 5000 ... 03 TE1 Hello World 6000 ... 03 TE1 Hello World In this example the data header TE1 is a sample. The data header could also have been RO3, TX4, SS2, or many others, depending on the configuration of the network infrastructure.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Host Request Message Header Fields BM210012WT27 Save Bytes Supplied by the host and used by the network to tie the confirmation to the original host request. Save bytes are ASCII for DataTAC 4000 systems. Save bytes can be ASCII or binary for DataTAC 5000 and 6000 systems. Length Prefix DataTAC 5000 systems require all SCR messages to designate the length of the message.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 100 BM210012WT27
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Host Confirmation Message Header Fields Length Prefix DataTAC 5000 systems require all SCR messages to designate the length of the message. The length count does not include the length prefix itself, but does include everything else in the message packet. Type Code Identifies the type of the SCR message: Use ‘A’ ‘B’ for DataTAC 4000 systems. Use ‘H’ ‘C’ for the other systems.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 102 BM210012WT27
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Mobile Information Message Header Fields BM210012WT27 Length Prefix DataTAC 5000 systems require all SCR messages to designate the length of the message. The length count does not include the length prefix itself, but does include everything else in the message packet. Type Code Identifies the type of the SCR message: Use ‘O’ ‘B’ for DataTAC 4000 systems. Use ‘M’ ‘I’ for the other systems.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 104 BM210012WT27
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration DataTAC Messaging (DM) DM allows one terminal to communicate with up to ten other terminals by routing a message through the DataTAC system network. As such, DM provides the protocol for basic E-mail functionality. System differences with regard to DM appear mainly as differences in DM syntax.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide DM Header Charts The charts in this section allow you to compare DM syntax across all three DataTAC systems. Each chart displays a different set of headers based on message type. The charts show the differences you need to be aware of for your particular project. The list preceding each chart describes the contents of the header fields.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration BM210012WT27 107 Wavenet Technology
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Receive Header Fields Wavenet Technology Type All systems use ASCII ‘R’ ‘M’ to indicate a Receive Message type message header. Sender ID The ID of the originating wireless terminal. On DataTAC 4000 systems this field is 8 bytes. On other systems it is 14 bytes. First Destination ID The ID of the destination terminal Flag Bytes Settings for optional delivery services.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration BM210012WT27 109 Wavenet Technology
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Host Messaging (HM) Host Messaging (HM) is achieved by placing a DM header inside an SCR header. In addition, the first two bytes (either MG or RM) must be replaced with HM to signify the message was received from a host, rather than a peer. HM used in conjunction with DM allows the terminal to use the same routing protocol regardless of its destination.
Boomer II User Manual & Integrator’s Guide ________________________________ Message Routing and Migration Special Text Formatting The display of dates, numbers, and monetary values varies among locales. Support for these differences may be provided by your programming environment to simplify the development of code. If your programming environment doesn’t provide such support, include alternative tables or options for use when localizing.
Message Routing and Migration ________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 112 BM210012WT27
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE Appendix A - NCL Interface The Boomer II is compliant to Native Control Language (NCL) 1.2. Wavenet Vendor-specific extensions are also listed here. The specification for the NCL protocol may be obtained in Adobe Acrobat format from the Motorola website at http://www.mot.com/MIMS/WDG/pdf_docs/8-.
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide Commands Value Parameters Value Sub-values and Descriptions R_RADIO_IN_RANGE ASCII e Get radio in range status. R_OB_MSG_COUNT ASCII f Count of outbound messages queued. R_IB_MSG_COUNT ASCII g Count of inbound messages queued. R_FLOW_CONTROL ASCII h Get flow control status. R_EVENT_STATES ASCII i Get current event reporting enable/disable state.
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE Commands Value Parameters Value Sub-values and Descriptions S_BAUD ASCII K Set the baud rate for NCL communications: S_ANTENNA RESET_RPM VENDOR BAUD_1200 1200 baud ASCII 0 BAUD_2400 2400 baud ASCII 1 BAUD_4800 4800 baud ASCII 2 BAUD_9600 9600 baud ASCII 3 BAUD_19K2 19200 baud ASCII 4 BAUD_38K4 38400 baud ASCII 5 Undefined Select the antenna ASCII L..Z Reserved.
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide channel. RX_REG_DENIED HW_EVENT ASCII E HW_EVENT_BIT $01 ASCII 2 Low battery. ASCII 3 Memory full. HW_BATT_OK ASCII 4 Battery level OK. HW_MEM_OK ASCII 5 Memory OK. HW_OFF ASCII 6 Device shutdown imminent. HW_BATT_WARN ASCII 7 Battery at warning level. ASCII F ASCII G Self-test failed. HW_MEM_FULL Unreceivable message event. CONTROL_BIT ASCII 1 $20 ACK required, PDU received.
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE ASCII P..Y, 1..9 SYNTAX VENDOR ASCII 3 ASCII Z BM210012WT27 Reserved. Command SDU syntax error. Note the following error codes: INVALID ASCII b Invalid options. TOO_LONG ASCII c Data is too long. ASCII Z Vendor-specific response.
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Specific NCL Extensions The following table describes Wavenet specific extensions to the NCL 1.2 specification. All SDUs include three VENDOR control byte and the vendor Id. (the ‘\’ character is used as an escape character for hexadecimal bytes below): Command Type 1. Get status commands 2. Generic “Set RPM configuration” command type 1.
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE OPERAND DESCRIPTIONS AND RESPONSES: The various Vendor Status Requests that can be made, and the format of their response information in the SUCCESS response SDU, are described as follows. Please note that all multiple byte fields are stored MSB first. WN_GET_RADIO: Get radio status information (NCL string “ZF?r”).
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide WN_GET_BATT_VOLT: (NCL string “ZF?v”). Get modem battery status information SUCCESS is followed by a block of status information in the format shown below: WN_GET_BATT_VOLT Response Format: 7 6 5 4 3 2 1 0 Battery Voltage (2 bytes) Battery Percentage Where: Battery Voltage: Battery Percentage: WN_GET_TIME: “ZF?t”). Two byte unsigned integer representing the Voltage of the battery in mV.
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE WN_GET_SETTINGS: string “ZF?u”). Get configuration information (NCL SUCCESS is followed by a block of status information in the format shown below: WN_GET_SETTINGS Response Format: 7 6 5 4 3 2 1 0 LLI [4 bytes] Serial Number [16 bytes] .......
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide indicates disabled, a one indicates enabled. NCL Event Flags: Byte which indicates the start-up state of the NCL event reporting. A set bit indicates the relevant event is enabled. A cleared bit indicates the event is disabled.
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE FORMAT: WN_SET_PARAM Command Syntax (NCL string “ZF^…”): CMND Length SDU Tag VENDOR ‘Z’ ‘F’ VEND_WAVENET ‘^’ Parameter number Parameter length WN_SET_PARAM WN_SET_PARAM Response Syntax: RESP Length SDU Tag VENDOR VEND_WAVENET SUCCESS OPERAND DESCRIPTIONS AND RESPONSES: The various Vendor Parameter settings that can be made are described as follows.
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide Parameter length : Parameter contents : 0x0001 (“Byte3Byte4”) One unsigned byte (“Byte5”) indicating the Power Save mode as follow: ASCII ‘0’ : EXPRESS (Disabled Power Save or “full awake” mode). ASCII ‘1’ : MAXIMUM (4 windows). ASCII ‘2’ : AVERAGE (8 windows). ASCII ‘3’ : MINIMUM (16 windows).
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE Generic set RPM Configuration command type 2 This command allows the DTE to set the configuration settings of certain aspects of the modem.
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide Generic get RPM Configuration command (WN_GET_PARAM): This command allows the DTE to get the configuration settings of certain aspects of the modem. This section should be seen together with the previous section (“Generic GET RPM Configuration command”).
Boomer II User Manual & Integrator’s Guide ___________________________________________ NCL INTERFACE WN_GET_PROFILE_LIST Response Format: Number of profiles (n) [1 byte] Active profile number [1 byte] Profile Name 1 (up to 24 byte null terminated string) Profile Name 2 (up to 24 byte null terminated string) . . . Profile Name n (null terminated string) [24 bytes] Where: Number of profiles: Unsigned byte giving the current number of profiles in configuration sector. The number of profiles may change.
NCL INTERFACE ___________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 128 BM210012WT27
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Appendix B - Software Development Kit DataTAC networks allow wireless communication and are installed in many different countries around the world. The Wavenet Software Development Kit (SDK) has been developed to facilitate development of applications for these networks by providing a simple program interface for communicating with the network devices.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide documentation on how to activate the MSMQ service on your version of Windows. The NCL_API is built on Client-Server architecture. The NCL_API PortServer application allows multiple client applications simultaneous access to the modem via a single communications port. A sample Client Application 'ModemInfo' with full source code is also included in the NCL_API directories.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Please refer to Appendices B and C for guidance to how to use the Boomer II SDK. All code was developed using Microsoft Visual C++ Version 6.0, for Microsoft Windows WIN98/NT/2000. System Requirements This SDK requires the Microsoft Message Queue (MSMQ) service running on the target PC. MSMQ is included in Windows 2000 as part of the operating system but this service needs to be activated manually.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide on the following model. The NCL API is supplied as a Virtual Device Driver (VDD) for a PC (Win 98 or better) or a Pocket PC (Win CE Version 3.0 or better). Multiple applications can access the RPM via NCL encoded messages.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI LAYER NAME CONTENT FUNCTION to-Peer routing SDU formatting is contained in the NCL interpreter. 2. DATA LINK LAYER 1. PHYSICAL / BIT TRANSFER LAYER NCL Interpreter & Extender port – Serial Driver. Extender Port to RPM. Application NCL API function requests are processed via a FIFO queue.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Application Interface Opening a Session Applications are required to first open a session with the VDD by calling the API function ‘VDDOpen()’. All other API functions will return an error unless an open session with the VDD was established. If successful this operation will result in the creation of two MSMQ queues for use by the client.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Input: None Output: Return value = 0 Operation was successful Return value ≠ 0 Operation failed. Value specifies the error type Send Data to a Radio Host Applications can call this function to send data to a radio host. The Host ID will automatically be inserted into the data header of the SDU for message routing purposes.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Output: Return value = 0 Operation was successful Return value ≠ 0 Operation failed. Value specifies the error type usSduTag Pointer to a word containing a reference of the corresponding SDU tag which was generated by the NCL API for this command to the RPM. Receive Data From RPM Applications can call this function to obtain data sent from the RPM.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Input: dwTimeOut The time (in milliseconds) to wait for the next message. Use 0 to return immediately or FFFFFFFF (hexadecimal) to hang on indefinitely for a message. The calling thread will be suspended until a message arrive or the time-out period has elapsed, whichever occurs first. ucStructId Pointer to a byte where the structure ID can be stored.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide }; /* Use 1 byte alignment for the following structures */ #pragma pack(1) /* Product ID structure */ typedef struct NCLProdId { BYTE hw_platform; BYTE rf_protocol; BYTE ncl_compliance; BYTE release_level; }NCLProdId; /* NCL version structure */ typedef struct NCLVersion { char major[2]; char minor[2]; }NCLVersion; /* RPM ID structure */ typedef struct NCLRpmId { BYTE b_val[4]; }NCLRpmId; /* Config block s
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI BYTE WORD BYTE BYTE BYTE }NCLChanBlock; radio_in_range; radio_channel; attribute; protocol; rssi; #define MAX_GROUP_LLIS #define LLI_BYTE_WIDTH #define NCL_NUM_CHANNELS 64 8 8 /* Group LLIs array */ typedef struct NCLGroupLlis { BYTE lli[MAX_GROUP_LLIS][LLI_BYTE_WIDTH]; BYTE num; }NCLGroupLlis; /* Channel Table */ typedef struct NCLChannelTable { WORD BYTE num; }NCLChannelTable; channel[NCL_NUM_CHANNEL
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide BYTE rpm_vid[2]; NCLGroupLlis rpm_gid; WORD max_data_size; BYTE rx_status; BYTE tx_status; BYTE antenna; BYTE radio_in_range; WORD ob_msg_count; WORD ib_msg_count; BYTE flow_control; BYTE rcv_mode; BYTE event_states; WORD radio_channel; NCLChannelTable chan_table; NCLChannelTable dchan_table; NCLConfigBlock config_block; NCLStatusBlock status_block; NCLChanBlock chan_block; BYTE bat_level; NCLWaveSettings
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI typedef struct NCLMsg { BYTE is_message; /* If FALSE, only len and buf components are valid.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Status Request (Wavenet Technology specific) Response Structure Description WN_GET_STATUS_RADIO NCLWaveRadio Get RPM Radio Status WN_GET_STATUS_BATTERY NCLWaveGen Get RPM Battery Status WN_GET_STATUS_ONTIME NCLWaveGen Get RPM on-time status WN_GET_STATUS_CONFIG NCLWaveGen Get RPM configuration status Prototype: int nclGetStatus (word *usSduTag, byte ucVendor, byte ucType, byte ucRequest); De
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Set Configuration ITEMS Within the RPM By default the modem will have the receiver and transmitter enabled and the RX notification event enabled. Modem Configuration items via NCL are TBA and will be restricted to service personnel. Reset RPM The application can call this function to reset the RPM.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Register Event Callback Function Since the RX events will be posted to private Receive MSMQ queues the VDD is not required to support callback functions. Applications can call the API function ‘nclReceiveData()’, to wait on response and event messages from the RPM on their on account.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI usSduTag Pointer to a word containing a reference of the corresponding SDU tag which was generated by the NCL API for this command to the RPM. Get Error Description The application can call this function to obtain a string representation for a specified error code.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Error Code Value Description range NCL_ERR_PACKET_ERROR Error Not Listed 'Z' All other values Execution error: SDU data corruption detected Unknown error Prototype: char * nclGetErrorDescription (int iErrorCode); Description: Return a pointer to a character string describing the specified error code. Input: iErrorCode Integer specifying the error code for which a string description is required.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Input: usAppName usWakeupReason Pointer to a buffer specifying the full path name (Null terminated) of the application to execute on a wakeup.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Input: usSetting If this value is zero, the RPM should power down else it should power up Output: Return value = 0 Operation was successful Return value ≠ 0 Operation failed. Value specifies the error type Send Generic NCL Command To RPM The application can call this function to send application specific commands to the RPM.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI usVersion Set this value to zero to request the VDD DLL version or to any other value to request the server application version Output: Return value = 0 Operation was successful Return value ≠ 0 Operation failed.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide When you are using a TCP/IP connection to the network switch or RNG, communication will be via some form of TCP/IP link. This may be via an Ethernet card or through a modem connection running SLIP or PPP. The appropriate drivers will need to be configured for the Ethernet card, and TCP/IP will need to be configured as a network protocol.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI Definitions for all SCR message structures can be found in the file scrapi.h. (SCR SDK) Network Independent Messages The SCR API provides several network independent message types. These message types represent basic functions within the SCR protocol that are applicable to all DataTAC network types.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Coupled with the interchangeable use of the message structures SCRack, SCRhc, and SCRab is the function scr_NakReasonText().
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI SCR_DI Disconnect Indication SCR_AR Activity Request SCR_AC Activity Confirmation (response to AR) SCR_RS Receiver Suspend SCR_RR Receiver Resume DataTAC® 5000 and DataTAC® 6000 Network Messages The following message types are common to the DataTAC 5000 and 6000 networks: SCR_MI Message Indication message for receiving data from a wireless device.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide application, it must set the first two characters of the data header to the session number. For example, a data header of Al routes data on session A1, and a data header of TEI routes data on session TE. To simplify porting of applications between different network types, the use 3-character data headers, such as TEI.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI int lrc; lrc = scr_Init(SCR_DATATAC_4000); if (lrc == SCR_ERROR) { exit(0); } /* perform other SCR operations */ . . . } scr_Encode() Prototype: int scr_Encode(byte *l_buf, SCRMsg *l_msg) Description This routine encodes a SCRMsg structure into an SCR encoded data buffer. This routine transparently converts and encodes IB, OB, AB, HC, HR, and MI messages for the correct network type.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide /* initialize message structure */ lmsg.msg_type = SCR_TO_NET; /* send data to client device */ lmsg.u.tonet.lli = 0xEE021234; /* set device LLI to send to */ lmsg.u.tonet.ack = SCR_TONET_ACK_NONE; /* no acknowledgment */ lmsg.u.tonet.data_header = “BB1”; /* Note: On a DataTAC 4000 or 6000 network, this message */ /* will be routed on host slot 1.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI error Return value > 0 Operation was successful .and the decoded message is returned in l_msg. Example #include { SCRMsg lmsg; /* SCR message struct */ byte lbuffer[SCR_MAX_LEN];/*buffer for received SCR msg int llen; /* length of received SCR msg int lused; /* return code from scr_Decode */ */ */ . . . /* receive data into lbuffer */ llen = x25recv( . . . lbuffer, . . . . .
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide *l_msg The SCRMsg structure to have its internal memory allocations freed. Note that the SCRMsg structure itself is not freed. Output: None Example Refer to the example for the function scr_Decode() on the previous page. scr_EncodeLogin() Prototype: int scr_EncodeLogin(byte *l_buf, char *l_hostid, char *l_passwd) Description For DataTAC® 5000 Networks Only.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI /*llen will be zero, so we do not */ /*need to send the login message. */ /* For DataTAC S000, send encoded login message to RNG */ x25_send(. . . [buffer, lien, . . .) } . . . } scr_Print() Prototype: void scr_Print(FILE *l_fp, SCRMsg *lmsg) Description This routine prints an ASCII representation of the SCR message structure to the given file.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Shown here are several examples of possible output from the scr_Print() function: FROM_NET Message The FROM_NET message is printed as an OB message for a DataTAC 4000 network. *** OB message *** LLI 80051234 Data header - BB1 Data – 0 54 68 69 73 20 69 73 20 73 6F 6D 65 20 64 61 74 This is some 10 61 2E data. For DataTAC 5000 and DataTAC 6000 networks, a FROM_NET message is printed as an MI message.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI scr_NakReasonText() Prototype: char *scr_NakReasonText(char *l_reason_code) Description This routine converts a response code from an HC or AB message into a text string describing that code. The returned pointer is a pointer to a static text string within the library. This string must not be overwritten or freed. This string pointer will stay valid for the duration of the program's execution.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide scr_ACReasonText() Prototype: char *scr_ACReasonText(char *I_reason_code) Description For the DataTAC 5000 Network Only. This routine converts a reason code from an Activity Confirmation (AC) message into a text string describing that code. The returned pointer is a pointer to a static text string within the library. This string must not be overwritten or freed.
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI For DataTAC 5000 Dynamic Routed Sessions Only This routine converts a reason code from a Disconnect Indication (DI) message into a text string describing that code. The returned pointer is a pointer to a static text string within the library. This string must not be overwritten or freed. This string pointer stays valid for the duration of the program's execution.
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 164 BM210012WT27
Boomer II User Manual & Integrator’s Guide ________________________________Appendix C – Sample Programs Appendix C – Sample programs Sample programs are provided with the SDK. The purpose of these sample programs is to show how a complete working client server application can be built using the SDK NCL API with the client program and the SDK SCR API with the server program.
Appendix C – Sample Programs________________________________ Boomer II User Manual & Integrator’s Guide The Settings tab displays the modems current profile (i.e. Channel list, RD –Lap version, etc), whether the modem is on or off, the modems power save mode, and (if supported), its vibrator mode. The Status tab displays the modem’s current channel (if registered) and its RSSI level.
Boomer II User Manual & Integrator’s Guide ________________________________Appendix C – Sample Programs The Messages tab allows a user to send and receive messages from the channel the device is currently registered on. The About tab displays the version number of ModemInfo, copyright information, and the web address of Wavenet Technology.
Appendix C – Sample Programs________________________________ Boomer II User Manual & Integrator’s Guide Server Application The server program is a Windows NT command line program that connects to the DataTAC® network switch and waits to receive data from wireless client devices. Any data received from wireless clients is echoed back to the same client on the same session. The server program can handle simultaneous connections from multiple clients.
Boomer II User Manual & Integrator’s Guide ________________________________Appendix C – Sample Programs using scr_EncodeLogin() with the host ID and password as specified by the command line parameters. The encoded login message is then sent to the RNG. Before the program exits, the connection to the RNG is closed. No special SCR processing is needed here. Data Transfer zSendData() is a function that sends data to the RNG, using TCP/IP or X.25 as appropriate.
Appendix C – Sample Programs________________________________ Boomer II User Manual & Integrator’s Guide scr_NakReasonText(); /* returns NULL if no error occurred */ if (an error occurred){ Print reason text } else{ Report successful delivery of message } break; case SCR_FROM_NET: /* Received inbound message*/ prepare message "TO_NET" /*echo data back to the client*/ break; case SCR_CI: /* Connect indication DataTAC 5000 only */ Report 'LLI x has connected' break; case SCR_DI: /* Disconnect indication Data
Boomer II User Manual & Integrator’s Guide _______________________________ APPENDIX D – Wavenet Loader Appendix D - Wavenet Application Loader The Application Loader software is used to upgrade the resident software installed on your Wavenet OEM modem. For optimum performance ensure that you are using the latest application version. This appendix, for your convenience, explains the procedure for updating the Application Loader software and has a troubleshooting section to assist with any problems.
APPENDIX D – Wavenet Loader _______________________________ Boomer II User Manual & Integrator’s Guide Note: The message shown above will appear if you are attempting to upgrade using ApploaderM408.exe with a BM2 modem. 7. The following screen is typically displayed. Displays the current version of Application software on your modem. Select the appropriate com port on your PC that the modem is connected to. Click the Download Application button to download the latest version.
Boomer II User Manual & Integrator’s Guide _______________________________ APPENDIX D – Wavenet Loader 12. Click and the download window will read the modems application version and redisplay it. 13. A message is then displayed in the status bar, informing you that that the application software on the modem is up to date. 14. Click the modem. to exit the program.
APPENDIX D – Wavenet Loader _______________________________ Boomer II User Manual & Integrator’s Guide This message (or similar) will appear if you have attempted to upgrade your modem with the incorrect Application Loader file. The letter preceding the three numerical characters at the end of the Apploader file name denotes which modem the file is appropriate for, i.e. BM2 for the Boomer II OEM modem.
Boomer II User Manual & Integrator’s Guide ________________________APPENDIX E - Numeric Conversion Chart Appendix E - Numeric Conversion Chart Binary/Octal/Decimal/Hex/C/ASCII Conversion Table Binary 00000000 00000001 00000010 00000011 00000100 00000101 00000110 00000111 00001000 00001001 00001010 00001011 00001100 00001101 00001110 00001111 00010000 00010001 00010010 00010011 00010100 00010101 00010110 00010111 00011000 00011001 00011010 00011011 00011100 00011101 00011110 00011111 00100000 00100001 00100
APPENDIX E - Numeric Conversion Chart________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 176 BM210012WT27
Boomer II User Manual & Integrator’s Guide __________________________________ APPENDIX F - Specifications Appendix F - Specifications Physical Properties Weight < 50g Size (L x W x H) 70mm x 52mm x 9mm Communication Protocols Modem to radio network protocol RD-LAP 3.1, 3.2, 3.3 and MDC 3.3 Modem to terminal (e.g. handheld) protocol NCL 1.
APPENDIX F - Specifications __________________________________ Boomer II User Manual & Integrator’s Guide Synthesiser Frequency range 806 – 825MHz (A), 890 – 902MHz (B) Channel spacing 25kHz (A) 12.5kHz (B) Frequency Error (-30º ~ +60ºC) ±1.5ppm (<1300Hz) (A) ±0.8ppm (750Hz) (B) Transmitter Frequency range 806 – 825MHz (A), 896 – 902MHz (B) Channel spacing 25kHz (A) 12.5kHz (B) Data rate MDC 4.8kbps (A) RDLAP 9.6kbps (A) RDLAP 19.2kbps (A) RDLAP 9.6kbps (B) Modulation 2-Level FSK MDC 4.8 2.
Boomer II User Manual & Integrator’s Guide ______________________________________APPENDIX H - Glossary Appendix H - Glossary ACK ADC ALC ANSI AOC ASIC ATE BGA BER BNC Bps BSC CCR CHRONOS CLK CMOS CNTL COM CPU CQA CNTL CSA DAC DB DBc DBm DCD Debounce Desense DISC DOS DTE DTR DTU DVM EEPROM EIA EMA EMI EPC EPROM ERP ESD ESN FCC FET FIFO FNE FPC BM210012WT27 Acknowledgment Analog-to-digital converter Automatic level control American National Standards Institute Automatic output control Application-specific
APPENDIX H - Glossary______________________________________ Boomer II User Manual & Integrator’s Guide FracN FRU FSK GaAs GND GPIB GTEM HCT Host HP I/O IB IC Inbound IP IR LC LED Li-ion LLI LNA MDC MFR MPS NAK NatSim NCL NiCad / NiCd NiMH NPN NSI OB OEM op-amp OSMT Outbound PCA PCB PC Card PCMCIA PDA PDU PIC PLL p/n PMIT POST Ppm QFP Wavenet Technology Fractional division synthesizer IC Field-replaceable unit Frequency shift keying Gallium arsenide, a semi-conducting material Ground A type of ATE interfa
Boomer II User Manual & Integrator’s Guide ______________________________________APPENDIX H - Glossary R&D RAM Rayleigh RC RD-LAP RF RFI RGxxx RMA RNC RPM RS-232 RSSI RTU Rx SAP0 SAR Schottky diode SCR SDK SDU SFR SINAD SMA SMB SNR SPDT SPI SRAM TBD TNC Transorb TTO Tx UART UL VCC VCO VDD Vpp VSWR WDG Wireline XIP ZIF BM210012WT27 Research and development Random-access memory A measure of multi-path fading depth of a signal Resistor-capacitor Radio Data-Link Access Procedure Radio frequency Radio-frequen
APPENDIX H - Glossary______________________________________ Boomer II User Manual & Integrator’s Guide Wavenet Technology 182 BM210012WT27
