Wavenet Technology BM2800D BOOMER II DATA TAC WIRELESS OEM MODEM MODULE User Manual Boomer II Integrators Guide

Download:
Mirror Download [FCC.gov]
Document ID	373806
Application ID	f4UVVBseatUOZDFOuO2WAg==
Document Description	revised users manual
Short Term Confidential	No
Permanent Confidential	No
Supercede	No
Document Type	User Manual
Display Format	Adobe Acrobat PDF - pdf
Filesize	75.05kB (938074 bits)
Date Submitted	2003-11-14 00:00:00
Date Available	2003-11-11 00:00:00
Creation Date	2003-11-14 16:42:14
Producing Software	Acrobat Distiller 4.05 for Windows
Document Lastmod	2003-11-14 10:18:02
Document Title	Boomer II User Manual & Integrators Guide
Document Creator	Microsoft Word 9.0
Document Author:	Wavenet Technology Pty Ltd Wa

User Manual
and
Integrator’s Guide
Boomer II OEM Modem
Modules:
BM2-800D
BM2-900D
Revision 3.7
November 2003
© Wavenet Technology Pty Ltd
ACN 079 965 003
Publication No. BM210012WT37
Published November 2003
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. Performance
figures quoted are typical values and subject to normal manufacturing and service tolerances.
Wavenet Technology Pty Ltd reserves the right to alter, without notice, the equipment, software or
specification to meet technological advancement.
Microsoft, Windows and the Windows logo are registered trademarks or trademarks of Microsoft
Corporation in the United States and other countries. Other product and company names herein may be
the trademarks of their respective owners.
Whilst every precaution has been taken in the preparation of this document, neither Wavenet
Technology Pty Ltd nor any of its representatives shall have any liability to any person or entity with
respect to any liability, loss or damage caused or alleged to be caused directly or indirectly by the
information contained in this book.
Published by Wavenet Technology Pty Ltd.
This product is a modular transmitter approved under FCC Part 2 and Part 90 rules.
800MHz Modem Module - FCC ID: PQS-BM2800D
900MHz Modem Module - FCC ID: PQS-BM2900D
This device complies with Part 15 of the FCC rules. Operation is subject to the following two
conditions:
(1) This device may not cause harmful interference, and
(2) This device must accept any interference received including interference that may cause undesired
operation.
This product is approved under Industry Canada (IC) RSS119 rules.
800MHz Modem Module - IC: 4062A-BM28001
900MHz Modem Module - IC: 4062A-BM29001
Canadian Representative for Industry Canada correspondence is Jay Sarkar, 15 Parkside Cresent,
Nepean Ontario, Canada K2R 7N3 Telephone: 613-225-2812, Fax: 613-225-6140.
Boomer II User Manual & Integrator’s Guide __________________________________________________ Contents
Contents
Introduction ......................................................................................................6
Modem Features ..........................................................................................7
Wireless Applications ...................................................................................8
Developer Support .......................................................................................9
Integrator Developers Kit..............................................................................9
Compliance Statement ...............................................................................10
Information for Your Safety.........................................................................11
The Integrator’s Task .....................................................................................13
Plan the Product and Create the Design ....................................................14
Develop and Validate the Hardware...........................................................17
Develop Supporting Applications Software.................................................18
Test and Approve the Product....................................................................18
Environmental Issues .................................................................................19
Regulatory Requirements...........................................................................21
Installing the Modem......................................................................................27
Mounting the Boomer II OEM Modem to Your Device................................28
Connecting the Data Interface Port ............................................................29
Selecting & Positioning the Antenna ..........................................................38
Supplying Power ........................................................................................44
Using the Modem Test Jig .............................................................................55
Features .....................................................................................................55
Exploring the Boomer II Test Jig ................................................................56
Initial Calibration.........................................................................................59
Fitting the Boomer-II Modem ......................................................................59
Software Development Tools.........................................................................61
Wavenet SDK.............................................................................................61
Wavenet Commander ................................................................................65
Wavenet Application Loader.......................................................................69
Integration Testing .........................................................................................73
Hardware Integration..................................................................................73
Desense and EMI.......................................................................................74
Regulatory Compliance ..............................................................................75
Application Software...................................................................................76
Final Assembly ...........................................................................................76
End User Problem Resolution ....................................................................76
OEM Service Depot Repair ........................................................................77
BM210012WT37
Copyright Wavenet Technology © November 2003
Contents __________________________________________________ Boomer II User Manual & Integrator’s Guide
Appendix A - NCL Interface ...........................................................................79
Generic NCL (Native Mode) .......................................................................79
Wavenet Specific NCL Extensions .............................................................84
Appendix B – SDK NCL-API and Port Server ................................................95
Multisession API.........................................................................................95
Application Interface...................................................................................97
Appendix C – SDK Sample programs..........................................................114
Appendix D - Application Development........................................................118
Roaming Issues........................................................................................119
Power Management .................................................................................123
Wireless Data Systems Considerations ...................................................125
Appendix E - Message Routing and Migration .............................................128
Standard Context Routing (SCR) .............................................................129
DataTAC Messaging (DM) .......................................................................130
Other Development Issues .......................................................................130
Appendix F – Guide to Desense ..................................................................132
Noise Sources ..........................................................................................133
Receiver Susceptibilities...........................................................................133
Measurement Techniques ........................................................................133
Alternate Measurement Method ...............................................................134
Methods of Controlling Emissions ............................................................135
RF Network Issues ...................................................................................137
Antenna ....................................................................................................138
Desense Summary...................................................................................138
Appendix G - Numeric Conversion Chart.....................................................140
Appendix H - Specifications .........................................................................142
Appendix I - Glossary...................................................................................144
Copyright Wavenet Technology © November 2003
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction
BM210012WT37
Copyright Wavenet Technology © November 2003
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide
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 an Enterprise Application Server running
wireless applications or as the RF communications enabler device for
telemetry products. There are two versions available,
800MHz version (A band) and
900MHz version (B band)
Messages from the end user are sent from the host/terminal through the
serial interface, and are transmitted by the modem when it is in
network contact. Messages to the end user are received and
acknowledged by the modem, then passed to the host/terminal.
Within an area of coverage, the modem performs auto-roaming (autoscanning, channel selection, and registration on a new channel). The
modem operates in either battery save or non-battery save modes, as
instructed by the network and overridden by the host/terminal. The
modem determines which RF protocol to use, based on the attributes
specified by the configured channel list, and dynamic channel
information from the network.
The modem interfaces to the host/terminal by using the data interface
port. The protocol supported over this link is the Native Control
Language (NCL). An emulated Hayes protocol is also supported.
Although the modem has embedded software, it has no built in
application software. All application software must be separately
installed and run from the host/terminal to which the modem is
connected. A Software Development Kit (SDK) is available and
described later in this manual to assist this process.
A picture of the Boomer II OEM Modem Module is shown below.
RF Connector
LED
Window
Data Interface Port
Copyright Wavenet Technology © November 2003
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction
This manual contains the following major sections:
Section 1:
Introduction
Section 2:
The Integrator’s Task
Section 3:
Installing the Modem
Section 4:
Modem Test Jig
Section 5:
Wavenet Software Tools
Section 6:
Integration Testing
In addition useful reference information has been included in the
appendices.
Modem Features
The Boomer II OEM Modem is approximately the size of a credit card
and just 9mm thick. The modem is easily connected to many other
devices and can be incorporated into a variety of package formats. The
modem has a TTL serial port.
The Boomer II OEM Modem has the following features:
Serial communications interface port (TTL level)
running an NCL protocol (An emulated Hayes compatible
protocol is also supported).
Indicator lights shows the status of the network coverage and
power supply
Four configurable digital input/output lines for external
control/monitoring
Software configurable RF calibration adjustments to suit
specific networks
High sensitivity reception
Small footprint and low profile design
Low-voltage and low standby current consumption for battery
based products
Auto-wake up of host/terminal on incoming messages
Roaming capabilities as used in DataTAC system
Modem is always online using the DataTAC network
Easy to install, service and update
BM210012WT37
Copyright Wavenet Technology © November 2003
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide
Wireless Applications
Wireless applications in which the Boomer II OEM Modem may be
used include the following:
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.
Point of Sale
The modem can perform handshaking and complete verification of all
data transmitted through the wireless network whilst providing
convenient operator mobility such as open air events or conferences.
Vending Machines
Vending machines can also utilise radio data technology. Many
machines already transmit usage and refill requirements to company
head offices via standard telephone lines. Radio modems allow vending
machines to be placed in areas with poor access to telecommunications
infrastructure, providing a cost-effective alternative to installing new
telephone lines. On refilling, only the required refills will be
despatched to the required sites maximising truck carrying capacity and
consequently efficiency.
Alarm Detection
Conventional telephone wire connections are slow to dial out and can
burn before the emergency call can be placed. Laws in many states and
countries require businesses to have an on-line dial out fire alarm
system. The Boomer II OEM Modem offers a real solution to this
problem.
Parking, Buses and Ticketing
Ticketing machines are being be converted to cashless operation. The
Boomer II OEM Modem is the best alternative to facilitate the
introduction of this cashless technology.
Copyright Wavenet Technology © November 2003
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction
Developer Support
A complete developers program is offered by Wavenet to assist
integrators in the design, testing and implementation phases of their
wireless applications. This includes a developer’s kit, modem software
tools, sample source code and prototyping components. Wavenet’s
experienced team of RF and software engineers are available to give
technical support as required.
Integrator Developers Kit
To facilitate the rapid development and deployment of wireless
applications, Wavenet has 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. The
kit contains the following components:
Evaluation Board for interface to a PC for testing (Boomer-II
Modem Test Jig)
Power cable for connection to a variable power supply
800 MHz (blue tip) or 900 MHz (red tip) ¼ wave whip antenna
Antenna cable
PC Serial interface cable
5 sample FPC strips for prototyping purposes
5 sample FPC connectors for prototyping purposes
Software Developers Kit on CDROM containing Integrators
Guide and User Manual, Modem communications software,
device drivers and sample source code
System Requirements
The minimum system requirements of a host/terminal emulation PC in
order to utilise the Integrator Developers Kit are:
Intel compatible Pentium computer or higher
Windows 2000 or later
16MB RAM (memory) minimum, 32MB recommended
1MB available hard disk space
9-pin serial Port using a 16550 UART
3.5-inch Disk Drive
CD-ROM drive
BM210012WT37
Copyright Wavenet Technology © November 2003
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide
Compliance Statement
The Wavenet Boomer-II OEM Modem Module has been tested and
found to comply with the limits for a class B digital device, pursuant to
Part 15 of the FCC rules. These limits are designed to provide
reasonable protection against harmful interference in a residential
installation.
This modular transmitter is only approved for OEM integration into
final products that satisfy MPE categorical Exclusion Requirements of
2.1091 of the FCC rules. Accordingly the final product and its antenna
must operate with:
A. A minimum separation distance of 20 cm or more from all
persons using an antenna with gain not exceeding 3dBd
(or 5 dBi) in fixed or mobile applications or,
B. A minimum separation distance of 25 cm or more from all
persons using an antenna with gain not exceeding 6 dBd in
fixed applications only or,
C. A minimum separation distance of 35 cm or more from all
persons using an antenna with gain not exceeding 9 dBd in
fixed applications only or,
D. A minimum separation distance of 50 cm or more from all
persons using an antenna with gain not exceeding 12 dBd in
fixed applications only.
Note: The use of an antenna with gain greater than 5dBi for Mobile
applications will require an MPE measurement to satisfy the RF
Exposure requirements of 2.1091 of the FCC rules and notification of
the separation distance to all users and applicable documentation.
Separate approval is required for this module to operate in portable
products with respect to 2.1093 of FCC rules.
Wavenet has obtained certificates of Technical Acceptability for use in
Canada in accordance with the Radio Standards Procedure RSP-100
and Radio Standards Specification RSS119, Issue 3.
This equipment generates, uses and can radiate radio frequency energy
and, if not installed and used in accordance with the manufacturer’s
instructions, may cause interference harmful to radio communications.
There is no guarantee however, that interference will not occur in a
particular installation. If this equipment does cause harmful
interference to radio or television reception, which can be determined
by turning the equipment off and on, the user is encouraged to try to
correct the interference by one or more of the following measures:
Reorient or relocate the receiving antenna.
Increase the separation between the equipment and receiver.
Connect the equipment into an outlet on a circuit different from
that to which the receiver is connected.
Copyright Wavenet Technology © November 2003
10
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________________________ Introduction
Consult your supplier or an experienced radio/TV technician
for assistance.
Warning: Changes or modifications to this unit not expressly
approved by the party responsible for compliance could void the user’s
authority to operate this equipment.
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. For example, fuel depots
(fuel storage and distribution areas), chemical plants, and locations in
which hazardous or combustible gases may be present and where
blasting operations are in progress.
Do not use the modem in an aircraft. Such use may affect aircraft
instrumentation, communication and performance and may be illegal.
Be aware that the modem may interfere with the functionality of
inadequately protected medical devices, including pacemakers.
Additionally, the effect of the radio signals from the modem on other
electronic systems, including those in your car (such as electronic fuelinjection systems, electronic anti-skid braking systems, and electronic
cruise-control systems) may affect the operation of these systems,
which should be verified before use in the applications
Do not place the modem on an unstable surface. It may fall and damage
the equipment.
Never push objects of any kind into the modem through openings as
they may short out parts that could result in a fire or electrical shock.
Never spill liquid of any kind on the modem. Do not use the modem
near water (for example near a bathtub or sink, in a wet basement, near
a swimming pool etc.). The modem should be situated away from heat
sources.
Disconnect the modem from the power source before cleaning. Do not
use liquid or aerosol cleaners. Use a damp cloth to clean the unit.
Disconnect the modem from the power source and contact your
supplier if:
Liquid has been spilled or objects have fallen onto the modem.
It has been exposed to rain or water.
It has been dropped or damaged in any way.
It does not operate normally by following the instructions
contained in this manual.
It exhibits a distinct change in performance.
Failure to observe all these instructions will void the limited warranty.
BM210012WT37
11
Copyright Wavenet Technology © November 2003
Introduction ________________________________________________ Boomer II User Manual & Integrator’s Guide
Copyright Wavenet Technology © November 2003
12
BM210012WT37
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/terminal
Understanding RF Design
Provides the required
network coverage.
Sets end-user performance
criteria.
Reduces risk of costly
redesigns.
Provides reliable operation
through a state-of-the-art
functional interface.
Software & Hardware
Helps ensure longer service
life and fewer field returns.
Because wireless data communication technologies are usually
described using a unique variety of jargon, buzzwords, and technical
details, it is sometimes hard to know where to start. You may also have
difficulty evaluating this technical information when you find it.
As an OEM integrator, you must accurately choose where and how a
wireless technology will facilitate communication for your application.
You will also have to evaluate which technical considerations will give
your product an edge over the competition.
To successfully integrate the Boomer II OEM wireless modem into the
host/terminal, you must perform the following tasks:
Plan the product and create the design
Develop and validate the hardware
Develop supporting applications software
Test and approve the product
As you review these tasks, allow sufficient time for such required
activities as the regulatory approval process. Identify critical path
activities up front.
BM210012WT37
13
Copyright Wavenet Technology © November 2003
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.
Develop a Usage Model
The usage model answers the question, “How will the end product be
used (portable or mobile; 8 hours, 7 days a week; and so on)?”
Perhaps the most important enabler of success is a clear determination
of how the final product is to be used. This steers the development
process, because all design considerations drive toward meeting the
needs of the final user. For example, design issues related to a mobile
device, such as alternator noise and vibration, are completely different
from considerations required for a fixed-point telemetry application
powered by a solar panel. Defining what is and what is not important to
the end user helps to make the critical engineering trade-off decisions
that are inevitable in every product design.
Develop a Message Model
The message model defines how many messages are sent/received and
how often. To create the message model, determine how much and
how often data will be sent in each of the uplink (terminal to network)
and downlink (network to terminal) directions.
Answer the question, “Is there a requirement for the terminal to be on
and able to receive 8 hours a day, or does the user turn the unit on only
when making a query to the Enterprise Server Application?” The
answer has a direct bearing on the battery size and capacity
requirement for powering the device. The amount of data sent and
received is relevant in calculating the cost of airtime and deciding on
which type of network connection to use. In short, the message model
is required source data for making many engineering design decisions,
especially in calculating such values as sleep time versus wake time
and in determining battery capacity requirements.
For additional information, refer to section “Message Traffic Model”
on page 46. The typical approach to creating the model is to define the
peak and average network throughput requirements based on input
from the user. Wavenet Technology is able to provide current
consumption figures for each of the various modes of operation
(receive and transmit, for example) and explain the functionality of the
network Power Save protocol.
The network throughput of the host/terminal depends on many factors
in addition to the raw throughput of the radio channel. For example, in
addition to the overhead involved in forward error correction and
Copyright Wavenet Technology © November 2003
14
BM210012WT37
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. The service strategy must consider all
potential service situations and evaluate them in light of the usage
model.
To ensure that a final product can be efficiently serviced, you must
design for service-ability early in the development process. At a
minimum, you must develop a functional service strategy that contains
a well-considered procedure for performing unit-level screening. The
test must primarily determine whether a fault lies with the modem or
with the product. The test must also screen for network problems and
human error.
Wavenet provides an evaluation board (a standalone test jig) and
various software test utilities. The evaluation board provides a
mounting platform and electrical interface to the modem. Testing is
performed much more efficiently while the modem is still integrated
within the host/terminal, whether for a factory end-of-line test or while
at the user’s site.
For your product to allow integrated testing of the modem, you are
required to provide modem pass-through mode and utilise Wavenet
Commander software. See “End User Problem Resolution” on page 76.
Without pass-through, the modem must be mounted on the evaluation
board for diagnostics and troubleshooting. Pass-through mode also
allows for modem software upgrades.
A thoroughly developed OEM serviceability plan typically includes a
needs assessment for developing software utilities that can assist in
identifying communication problems between the host/terminal and the
modem and between the modem and the RF network.
These utilities must be able to send commands to the modem, evaluate
the modem responses, perform network connectivity testing, and verify
data communication with the network.
The utilities can be developed using NCL. This link-layer protocol set
provides the capability to monitor and evaluate the modem’s operating
condition and all communications to and from the network Enterprise
Server Application. NCL 1.2 uses a command-response functional
model. First, the network Enterprise Server Application asks for
modem status and status of network connectivity.
The modem then responds with its status and the state of network
connection management.
Such a software utility is essential for field service engineers and shop
technicians to diagnose problems with the product and to troubleshoot
a problem to a failed assembly or mismanaged communication link.
BM210012WT37
15
Copyright Wavenet Technology © November 2003
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. Is it the network, wireless
modem, or the host/terminal that is not working as expected? Often it
can be a user’s misunderstanding of how to use the product.
Regardless, remote troubleshooting is essential to reducing the number
of returned products and lowering service costs, particularly if the
host/terminal must be disassembled for removal of the modem.
Wavenet recommends that your product application (both at the
terminal and Enterprise Server Application ends) incorporate sufficient
problem diagnostic software to determine the cause of the problem
remotely. Often, the best approach is to incorporate progressively
deeper loop back tests to determine the point at which the
communication link fails.
As stated elsewhere, you need to make this remote diagnostic
functionality be part of your standard software load.
End User Support
You have two choices in dealing with an integrated modem that needs
to be swapped out and returned for service:
Decommission the modem and re-use the LLI
Replace the modem
If you decommission the modem Id (the LLI) from the defective unit
and transfer it to a replacement unit, the user and the network operator
are unaffected. This can only be done by an authorized Wavenet
service centre with the appropriate permissions and authority. If you
simply swap the defective unit with a replacement, the user must notify
the network operator.
Investigate and Obtain Regulatory Approval
Most countries where the final product will be sold currently require
approval from the local government regulatory body. It is your
responsibility to investigate and obtain the proper regulatory approval
and certification for each country in which the product is sold.
Regulatory issues are discussed in more detail in “Regulatory
Requirements” on page 21. In addition, see “Regulatory Compliance”
on page 75.
Copyright Wavenet Technology © November 2003
16
BM210012WT37
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. Here again, the usage and message models are necessary to
calculate issues such as battery size, heat dissipation, isolation from
EMI, and physical mounting of the unit to ensure proper grounding.
Hardware design is your responsibility. Wavenet can provide
recommendations where applicable and may also assist with
verification of EMI-caused desense once the modem is integrated into
the host/terminal.
Consider Power Supply Options
Power supply requirements vary according to the usage and message
models. Beyond accounting for the current drain of the modem in its
various operating modes, consider ripple and noise on the power lines,
and the ability to supply sufficient instantaneous current to allow
proper operation of the transmitter. Also, ensure that the power supply
can accommodate the highest power consumption under transmit
conditions and that the voltage does not fall below the minimum levels
at the modem terminals. (Remember voltage drops can occur in the
interconnectivity wiring and this must be kept as short as possible.)
Together, these requirements define the type and size of power supply
to use with the modem. These issues are discussed in more detail in the
sections “Supplying Power” on page 44 and “Batteries” on page 51.
Important: Avoid use of switching power supplies. They can easily
cause RF noise that desenses the modem.
Select the Source Antenna
The ERP (Effective Radiated Power) generated by the antenna must
meet the requirements of the various network operators. Consider these
network requirements when you select an antenna system. See
“Connecting & Positioning the Antenna” on page 38.
Set Up a Development Test Environment
A number of development test aids are available to assist in hardware
and applications development. Wavenet can provide both the modem
hardware and an evaluation board. The evaluation board is a specially
developed circuit board with test points and jumper switches. The
BM210012WT37
17
Copyright Wavenet Technology © November 2003
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 73.
Supplementing the test environment, the network operator sometimes
provides a live development network, one separate from the production
network on which you can develop and test your application.
Develop Supporting Applications Software
To develop supporting applications software, perform the following
steps:
Select a communications model
Develop end-to-end applications software
Select a Communications Model
Select a communications model. Most vertical market applications use
fleet (SCR) connections to a single Enterprise Server Application,
whereas horizontal applications typically use a gateway to allow
connection to the Internet or other external networks. See “Air
Interface Protocols” on page 25.
Develop End-to-End Applications Software
In addition to coding the product-specific features for your application,
you are urged to incorporate RF-specific reporting and monitoring
features, such as received signal strength (RSSI), channel quality, and
in-range/out-of-range conditions. Many applications track the number
of packets sent and received and the various events and status
indicators available from the modem. The Boomer II modem uses a
packetised serial interface (Native Control Language 1.2) to allow the
application to simultaneously monitor RF-related information and
application-specific data.
Test and Approve the Product
To test and approve the product, perform the following steps:
Perform EMI and desense testing
Set up a final test environment
Install and field test the product
Perform EMI and Desense Testing
Proper modem operation requires that you minimize EMI
(electromagnetic interference) radiated from your product’s platform.
Excess noise significantly reduces the wireless modem’s ability to
receive, making the network less likely to be heard.
Copyright Wavenet Technology © November 2003
18
BM210012WT37
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task
Wavenet provides a test facility for measuring host/terminal emissions
and subsequent modem desense of integrated host/terminals. See
“Desense and EMI” on page 74. In addition, see “Guide to Desense” on
page 132.
Set Up a Final Test Environment
To ensure proper assembly of the final product (antenna properly
connected, serial port operational, and so on), perform an end-to-end
test that proves the final product can receive and transmit at the
required signal levels.
In locations where the final assembly test is performed within network
coverage area, this test is relatively simple. In some countries the
network operator may provide a dedicated test network for this
purpose. You should consult with the relevant network operator for
assistance prior to any testing commencing on a live or test network. In
locations where network coverage is not available, or for products to be
shipped to another country, it is necessary to test by secondary means.
The final assembly test must verify that all connections to the modem
are made correctly. Testing on a network is not required. See “Final
Assembly” on page 76, and “End User Problem Resolution” on page
76.
Install and Field Test the Product
When the product is shipped to a site, it is installed or mounted in a
particular location, one that might restrict RF communications. The
service question is whether the behaviour of a dysfunctional product is
caused by poor coverage or a network service provider is down. To
guarantee that the modem is located in an area of good coverage and
that an end-to-end loop back message is possible, your product needs a
software application to perform the test.
Your most effective approach to field testing is to include an
installation test procedure as part of your standard software load. See
“Final Assembly” on page 76 and see “End User Problem Resolution”
on page 76.
Environmental Issues
The Boomer II OEM modem is designed for a combination of easy
serviceability and general ruggedness but are designed to be housed in
a host/terminal. The modem is tested to conform to the environmental
levels (for example, industrial use specifications and PC card
standards) that meet the intended applications of most integrators. If
you need additional ruggedness and safety in your products, you must
engineer the environmental characteristics of your host/terminal to
achieve a special safety rating.
General Precautions
Minimise handling of static sensitive modules and components.
BM210012WT37
19
Copyright Wavenet Technology © November 2003
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide
Wear a grounded anti static wrist strap while handling static
sensitive components.
Do not bend or stress the modem in any way.
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. Although the Boomer-II
modem has been designed with a high level of ESD protection you
should observe the following handling precautions when servicing
host/terminal devices:
Always wear a conductive wrist strap.
Eliminate static generators (plastics, Styrofoam, and so on) in
the work area.
Remove nylon or polyester jackets, roll up long sleeves, and
remove or tie back loose hanging neckties.
Store and transport all static sensitive components in ESD
protective containers.
Disconnect all power from the unit before ESD sensitive
components are removed or inserted, unless noted.
Use a static safeguarded workstation, which can be set up by
using an anti static kit. This kit typically includes a wrist strap,
two ground cords, a static control table mat, and a static control
floor mat.
When anti static facilities are unavailable use the following techniques
to minimize the chance of damaging the equipment:
Let the static sensitive component rest on a conductive surface
when you are not holding it.
When setting down or picking up the static sensitive
component, make skin contact with a conductive work surface
first and maintain this contact while handling the component.
If possible, maintain relative humidity of 70-75% in
development labs and service shops.
Copyright Wavenet Technology © November 2003
20
BM210012WT37
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/terminal. The
specific details for achieving regulatory approval vary from country to
country.
Worldwide, government regulatory agencies for communications have
established standards and requirements for products that incorporate
fixed, mobile, and portable radio transmitters. The Boomer-II OEM
modem is certified in specific regional markets to levels of compliance
appropriate for an integrated device.
Modem Only Certification
The non-integrated modem meets the regulatory requirements for the
countries listed below (but related certification does not necessarily
exist):
Country
Regulation
Agency
Related
Requirements
Modem
Model
Approval
Number
Australia
Australian
Communications
Authority (ACA)
FCC compliance is
accepted
Boomer-II 800MHz
Not applicable
Industry Canada (IC)
RSS119 – Radio
Performance
Boomer-II 800MHz
4062A-BM28001
Boomer-II 900MHz
4062A-BM29001
Boomer-II 800MHz
PQS-BM2800D
Boomer-II 900MHz
PQS-BM2900D
Canada
United States
of America
Federal
Communications
Commission (FCC)
FCC CFR Title 47,
Part 15 Conducted
and Emitted
Radiation Class B
Boomer-II 900MHz
FCC Part 90 – Radio
Performance
Full Product Certification
As the integrator, you must determine what additional specific
regulatory requirements are required for the country in which your
product is sold. This means, your product must be individually
certified, even though the Boomer II OEM Modem Module may
already be approved. The certification process includes submittal of
prototype products and acceptable test results.
Integrators can use Boomer II OEM Modem Module certifications to
facilitate this integrated-product approval process. Upon request,
Wavenet can send copies of the certifications and related information.
Be prepared for the certification process for your product to take from a
few weeks to several months. Its duration can be affected by safety
requirements, the type of product, and the country in which you are
seeking approval.
BM210012WT37
21
Copyright Wavenet Technology © November 2003
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide
Country Requirements
The country requirements given below are provided as a general guide
to the certification processes in the regions and countries given. You
are strongly encouraged to use the services of a consultant or a fullservice 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.
United States of America
The Federal Communications Commission (FCC) requires application
for certification of digital devices in accordance with CFR Title 47,
Part 2 and Part 15. A Wavenet Boomer-II OEM Modem Module is part
of a complete system and certain testing is necessary for the integrated
product.
FCC Part 15, Class A/B certification must be performed with the
maximum configuration used and include all peripherals of the
integrated product. The application for certification must refer to the
approval data on file for the particular Boomer-II Modem Module, as
shown in the following example. Include the following language in the
documentation inserting the name of the integrated product in place of
XXX below:
“The Wavenet Boomer-II OEM modem module is a
subassembly of XXX and has FCC Identifier PQS-BM2800D”
(or PQS-BM2900D as appropriate)
FCC Part 2 certification requires all integrated products to have
routine environmental evaluation for radio-frequency (RF) exposure
prior to equipment authorization or use in accordance with FCC rules
2.1091 and 2.1093 and FCC Guidelines for Human Exposure to Radio
Frequency Electromagnetic Fields, OET Bulletin 65 and its
Supplement C.
For “portable devices”, defined in accordance with FCC rules as
transmitting devices designed to be used within 20 cm of the user body
under normal operating conditions, Specific Absorption Rate (SAR)
testing must be performed and the unit re-submitted for separate FCC
certification approval. An exposure limit of 1.6 W/kg will apply to
most OEM integrated applications.
It is mandatory for portable integrated products such as handheld and
body-worn devices to comply with FCC guidelines for Specific
Absorption Rate (SAR) requirements. Refer to OET Bulletin 65 and
Supplement C (June 2002). The submission should include end product
information, end product SAR/MPE test report, and a reference to the
Wavenet Boomer-II OEM Modem Module FCC ID for all other
Part 90 requirements.
Copyright Wavenet Technology © November 2003
22
BM210012WT37
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task
For “mobile or fixed devices”, defined as transmitting devices
designed to be generally used such that a separation distance of at least
20 cm is maintained between the body of the user and the transmitting
radiated structure, Maximum Permissible Exposure (MPE) limits may
be used with field strength or power density limit of 0.537 mW/cm2 at
806 MHz or 0.597 mW/cm2 at 896 MHz.
Output is specified at the antenna terminal of this module. This
modular transmitter is only approved for OEM integration into final
products that satisfy MPE categorical Exclusion Requirements of
2.1091 of the FCC rules. Accordingly the final product and its antenna
must operate with:
A. A minimum separation distance of 20 cm or more from all
persons using an antenna with gain not exceeding 3dBd
(or 5 dBi) in fixed or mobile applications or,
B. A minimum separation distance of 25 cm or more from all
persons using an antenna with gain not exceeding 6 dBd in
fixed applications only or,
C. A minimum separation distance of 35 cm or more from all
persons using an antenna with gain not exceeding 9 dBd in
fixed applications only or,
D. A minimum separation distance of 50 cm or more from all
persons using an antenna with gain not exceeding 12 dBd in
fixed applications only.
Note: The use of an antenna with gain greater than 5dBi for Mobile
applications will require an MPE measurement to satisfy the RF
Exposure requirements of 2.1091 of the FCC rules and notification of
the separation distance to all users and applicable documentation.
Separate approval is required for this module to operate in portable
products with respect to 2.1093 of FCC rules.
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
configurations the MPE limits will not be exceeded. In this case, the
following clause should be included in the installation and user
documentation:
"To satisfy FCC RF exposure requirements a separation
distance of XX cm or more should be maintained between the
antenna of this device and persons during device operation. To
ensure compliance, operations at closer than this distance is not
recommended.”
Where the actual separation distance (XX) corresponds to the specific
antenna configuration used as previously detailed.
BM210012WT37
23
Copyright Wavenet Technology © November 2003
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide
It is a requirement for integrated product certification that you provide
the following statement in user documentation:
“Regulatory Notice of Compliance
This equipment has been tested and found to comply within the
limits for a Class B digital device, pursuant to Part 15 of the
FCC Rules. These limits are designed to provide reasonable
protection against harmful interference in a residential
installation.
This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used in accordance with the
instructions, may cause harmful interference to radio
communications. However, there is no guarantee that
interference will not occur in a particular installation. If this
equipment does cause harmful interference to radio or
television reception, which can be determined by turning the
equipment off and on, the user is encouraged to try to correct
the interference by one or more of the following measures:
Reorient or relocate the receiving antenna.
Increase the separation between the equipment and
receiver.
Connect the equipment into an outlet on a circuit
different from that to which the receiver is connected.
Consult the dealer or an experienced radio/TV
technician for help.”
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-BM2800D.” (or PQS-BM2900D as
appropriate)
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.
The FCC does not permit use of an FCC identifier until a Grant of
Equipment Authorisation is issued. If you display a device at a trade
show before the FCC has issued a grant, the following statement must
be prominently displayed:
“This device has not been approved by the Federal
Communications Commission. This device is not, and may not
be, offered for sale or lease, sold or leased until the approval of
the FCC has been obtained.”
Copyright Wavenet Technology © November 2003
24
BM210012WT37
Boomer II User Manual & Integrator’s Guide ____________________________________________ Integrator’s Task
Canada
Industry Canada (IC), formerly the Department of Communications,
requires certification for all radio transceivers as either type-approved
or technically accepted.
If you do not make any physical or electrical changes to the Boomer II
OEM modem and you add an antenna externally to your host/terminal,
you are not required to make a formal application to Industry Canada,
because Boomer II OEM modems continue to be covered under the
original Radio Equipment Certificate of Type Approval.
Most of the tests required for FCC applications can be used for
Industry Canada applications. IC requires additional tests, which
distinguishes their certification process as unique.
The Radio Standards Procedure RSP-100 describes the procedure for
obtaining certification of radio equipment and labelling requirements.
These documents are available upon request from Industry Canada in
Ottawa or from their website at
http://spectrum.ic.gc.ca/~cert/certprocedures_radio_e.html .
Labelling
Industry Canada requires OEM products to be labelled as follows:
IC: XXXX-BM2800D
Or,
IC: XXXX-BM2800D
Where XXXX represents the number supplied to the OEM by Industry
Canada.
Air Interface Protocols
Data exchange protocols transport data between the host/terminal and
the network. Within the radio portion of the network, between the
device and the base station, specialized RF protocols (RD-LAP 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.6, RD-LAP 19.2, or MDC 4800 protocols and an internal
800, or 900MHz radio to operate over 12.5 or 25kHz RF channels. The
network-specific configuration is constant for all like devices on the
network and includes the channel list and the system ID.
The modem has dual protocol capability on DataTAC 4000 systems in
the United States and Canada. The modem’s RF protocol is based on
the attributes specified by the configured channel list, and dynamic
channel information from the network.
On DataTAC 5000 systems, only the RD-LAP protocol is supported.
The modem performs auto-roaming (that is, auto-scanning, channel
selection, and registration on a new channel). Battery-save operation
(Power Save protocol) is supported within most DataTAC networks.
BM210012WT37
25
Copyright Wavenet Technology © November 2003
Integrator’s Task ____________________________________________ Boomer II User Manual & Integrator’s Guide
Network profiles
The networks in use in different countries each have a different list of
channels and system parameters required for access to that network.
These parameters must be configured in the modem. The Boomer II
modem is able to store these parameters for up to 10 networks, and
through NCL commands, the user can choose between them so that the
correct parameters are used for the user’s current location. The
parameters relating to a particular network form what we call a profile.
The Boomer II modem is supplied to customers with between 1 and 10
of these profiles, depending on the international roaming needs of the
customer. The default profile will also be set according to the
customer’s requirements, but is traditionally set to the correct
parameters for use on the USA’s Motient network. For details on the
NCL commands to view the profile list, and set the currently active
profile, please see the WN_PROFILE setting under Appendix A.
RD-LAP Network Operation
The RD-LAP 9600 and 19200 protocols are used by DataTAC 4000
and 5000 networks. The modem supports both continuously keyed,
multiple channel (MFR) and intermittently keyed, SFR (single
frequency reuse) network configurations, depending on the network
type. The RD-LAP protocol specifications provide the reference RF
protocol link-access procedures supported by the wireless modem.
While on the network, the modem performs auto-roaming and batterysave (Power Save protocol) functions.
MDC 4800 Network Operation
The MDC 4800 protocol is available exclusively on Motient (United
States) and Bell Mobility (Canada) networks. The modem supports
intermittently keyed, SFR network operation.
Note: On Motient and Bell Mobility networks the modem operates in
either MDC 4800 mode or RD-LAP 19200 mode, as provided by local
coverage, however, it is recommended contact be made with the
relevant network operators to confirm specific details.
Copyright Wavenet Technology © November 2003
26
BM210012WT37
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. Specific
attention must be paid to the following support mechanisms:
Mechanical mounting
Serial interface and control
Antenna
DC power
Software
Desense control (see page 132 for further information)
The OEM wireless modem is well suited for mobile or fixed
applications. Ruggedised and capable of operating in extreme
environments, the modem can provide communications for a wide
variety of products.
Handheld Portable Terminal Use
Without question, handheld designs produce the most hostile
environment for an integrated modem. A handheld device, such as a
portable terminal, is typically battery powered, subjected to
temperature extremes, and designed to be physically robust.
When designing portable devices, you must consider the following
issues:
DC power noise levels on the host/terminal interface
Minimum operating voltage levels
Shutdown procedures
Device internal ambient temperature
Antenna gain and proximity to user
Repair and reprogramming facilities (pass-through mode of
operation)
Mechanical design for drop, vibration, dust, salt, and liquid spill
Note: Regarding the mechanical design, the Boomer II OEM modem is
designed assuming that the host/terminal controls these conditions.
Fixed Mount Usage
Fixed-mount usage eliminates most of the mechanical constraints of
handheld designs, although the requirements still apply. Fixed-mount
units are sometimes AC-line powered and require filtering to eliminate
the 50Hz or 60Hz noise that can impair modem operation, depending
upon country of use.
BM210012WT37
27
Copyright Wavenet Technology © November 2003
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.
Supply Levels and Noise
Special care is required to ensure the modem is not subjected to DC
voltages exceeding specifications. This could create costly damage to
the RF section of the modem. Adhere to the power supply noise
specifications in your design.
Noise
Vehicular installations can be noisy.
Antenna
The antenna must be mounted like any other cellular or land mobile
radio antenna. Usually the vehicle roof provides a good ground plane
unless it is fabricated of non-metallic material such as fibreglass.
Mounting the Boomer II OEM Modem to Your Device
Before using your modem you must:
Mount the Boomer II OEM Modem to your device
Connect the Data Interface Port
Connect and position the antenna
Supply power
A picture of the Boomer II OEM Modem is shown below.
RF Connector
LED
Window
Data Interface Port
Copyright Wavenet Technology © November 2003
28
BM210012WT37
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 vibration to the unit. There
should be an adequate supply of airflow to ensure the modem’s
temperature limits are not exceeded.
To ensure ease of access for installation and troubleshooting, locate the
modem within the product in such a way that serial I/O and antenna
connections are readily accessible. Quick access to the modem allows
it to be efficiently removed, probed, and functionally tested.
The Boomer II OEM Modem has an M2 Mounting Bolt hole in each
corner, which should be used to bolt the modem onto an appropriate
surface. The hole pattern is four holes in a 60mm X 46mm X 42mm
trapezoid, with each hole to suit an M2 (2.0mm) bolt. Refer to the
following diagram.
52
46.0 CTRS
70
Hole diameter:
4 x 2.30mm
Fixing screw
size: M2
42.0 CTRS
Top View
Side View
Mounting Details
Connecting the Data Interface Port
There are two connectors to interface the Boomer II OEM Modem with
your device.
RF Connector (described in the next section), and
Data Interface Port
The data interface port is used to interface the modem to a serial
computing device and a power supply. The power supply requirements
are described in the next section.
A flat 30-way Flexible Printed Circuit (FPC) cable (approx 0.3 mm
thick with 0.5 mm centreline spacing) is used between the Boomer II
OEM Modem’s data interface port and the host/terminal. The
connector specification is given below.
BM210012WT37
29
Copyright Wavenet Technology © November 2003
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/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.
Pin 1
Data Interface Connector and Pin Numbering
The pin assignment of the Data Interface Connectors is shown in the
following table.
Copyright Wavenet Technology © November 2003
30
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Data Interface Pin Descriptions
Pin
Signal
Description
Signal
Reset State
DCD
Data Carrier Detect
Output
High Impedance
RXD
Receive Data
Output
High Impedance
TXD
Transmit Data
Input
100k pull up to 3.3V
DTR
Data Terminal ready
Input
100k pull up to 3.3V
GND
Ground
Ground
0V
DSR
Data Set Ready
Output
High Impedance
RTS
Request to Send
Input
100k pull up to 3.3V
CTS
Clear to Send
Output
High Impedance
RI
Ring Indicator
Output
High Impedance
10
HCRESET
Modem Reset
Input
40-80k pull up to 3.3V
11
TEST PIN
Do not connect
12
HOSTPWR_ON
Modem Power on/off
Input
High Impedance
13
LED0_MSGWTG
Message Waiting
Output
High Impedance
14
LED1_INRANGE
In Range
Output
High Impedance
15
LED2_LOWBAT
Low Battery
Output
High Impedance
16
SS0/RXD2
Status Signal 0
Bi-directional
100k pull up to 3.3V
17
SS1/TXD2
Status Signal 1
Bi-directional
100k pull up to 3.3V
18
SS2
Status Signal 2
Bi-directional
100k pull up to 3.3V
19
SS3
Status Signal 3
Bi-directional
100k pull up to 3.3V
20
HOST 3.8V
Supply Voltage
Supply
3.4 – 4.2V
21
HOST 3.8V
Supply Voltage
Supply
3.4 – 4.2V
22
HOST 3.8V
Supply Voltage
Supply
3.4 – 4.2V
23
HOST 3.8V
Supply Voltage
Supply
3.4 – 4.2V
24
TEST-PIN
Do not connect
25
HOST GND
Ground
Ground
0V
26
HOST GND
Ground
Ground
0V
27
HOST GND
Ground
Ground
0V
28
HOST GND
Ground
Ground
0V
29
TEST-PIN
Do not connect
30
TEST-PIN
Do not connect
Warning: Do not connect the TEST-PIN terminals (pin 11, 24, 29 and
30) or the modem may malfunction.
Note: The voltage range of most of the modem input pins is typically
0-3.3V, however, 0-5V can be used for compatibility with conventional
logic, unless otherwise stated.
A description of the above pins follows.
BM210012WT37
31
Copyright Wavenet Technology © November 2003
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. To turn the modem
off it must be actively pulled low to ground. The electrical interface
specification and equivalent circuit is as follows:
Modem On/Off Control Equivalent Circuit
Modem On/Off Control Electrical Characteristics
Parameter
Input Voltage
Range
Low
High
0-3.3 V OR 0-5V
0.4 V (max)
1.0 V (min)
400 µA (max)
100 µA (max)
Input Current
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 and HOST_3.8V power is removed, 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.
Copyright Wavenet Technology © November 2003
32
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Modem Reset Input
The reset input line (HCRESET) is an active low input signal (TTL
compatible) and is fitted with a 6.8kΩ series resistor and clamp diode
to the internal supply line for input protection. Internally it is passively
pulled high (after the series resistor) to the supply rail (3.3V) and is
asserted with an actively driven low signal to ground. The electrical
interface specification and equivalent circuit is as follows:
Reset Input Equivalent Circuit
Reset Electrical Characteristics
Parameter
Input Voltage
Range
Low
High
0-3.3 V OR 0-5V
0.5 V (max)
2.0 V (min)
200 µA (max)
200 µA (max)
Input Current
Pulse width
5mS (min)
Serial Communications Interface
The modem communicates with the controller using the Data Interface
Port connection interface. The asynchronous serial interface on the
Boomer II OEM Modem operates at 3.3V and can be controlled by a
wide variety of micro controllers and microprocessors. The modem can
be connected directly to a micro controller or through a universal
asynchronous receiver/transmitter (UART) to a microprocessor data
bus.
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 protocols supported over this link are the Native Control Language
(NCL), and an emulated Hayes AT compatible protocol. The data
format for both NCL and Hayes is: 8 data bits, no parity, 1 stop bit.
The serial interface lines (RXD, TXD, DCD, DTR, DSR, RTS, CTS,
RI) are TTL compatible. They are fitted with a 33Ω series resistor and
clamp diode to the internal supply line for protection. The electrical
interface capability, equivalent circuit and operation of these lines is
summarized in the tables below:
BM210012WT37
33
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Serial Communications Equivalent Circuit
Serial Communications Electrical Characteristics
Parameter
Range
Low
High
0-3.3 V OR 0-5V
0.8 V (max)
2.5 V (min)
0 – 3.3 V
0.5 V (max)
2.3 V (min)
Input Current
100 µA (max)
100 µA (max)
Output Current
3.2 mA (max)
1.6 mA (min)
Input Voltage
Output Voltage
Note: DCD and INRANGE outputs share the same output line from the
micro-processor , and therefore the combined current consumption of
that line must not exceed 2mA.
Serial Communications Interface Definitions
J1
Pin #
Signal
Description
Signal
Active State
DCD
Data Carrier Detect
Output
Low when modem in-range
RXD
Receive Data
Output
Low when active
TXD
Transmit Data
Input
Low when active
DTR
Data Terminal Ready
Input
Low when ready
DSR
Data set ready
Output
Low when ready
RTS
Request to send
CTS
Clear to send
Copyright Wavenet Technology © November 2003
Input
Output
34
High when host/terminal
requires data throttling
High when modem requires
d t th ttli
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
J1
Pin #
Signal
Description
Signal
Active State
data throttling
RI
Ring indicator
Output
Pulses Low when messages
are waiting
Status Input / Output lines
Note: Not currently supported but may be added in future releases.
The status lines (SS0 to SS3) may be software configured for bidirectional operation. Each line has a 100kΩ pull-up resistor, 33Ω
series resistor and clamp diode to the internal supply line for
protection. The electrical interface capability, equivalent circuit and
operation of these lines is summarized in the tables below:
Status Input/Output Equivalent Circuit
Status Input/Output Electrical Characteristics
Parameter
Range
Low
High
0-3.3 V OR 0-5V
0.8 V (max)
2.5 V (min)
0 – 3.3 V
0.5 V (max)
2.3 V (min)
Input Current
100 µA (max)
100 µA (max)
Output Current
3.2 mA (max)
1.6 mA (min)
Input Voltage
Output Voltage
BM210012WT37
35
Copyright Wavenet Technology © November 2003
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 Indicators
The modem provides three on-board indicators (LEDs), for diagnostic
monitoring purposes as well as three modem controllable LED outputs
through the Data Interface Connector.
On-Board LED Indicators
The on-board LED’s are visible through a small window in the case of
the modem and are defined as below.
On-Board LED Indicator Definitions
LED Indicator
Colour
POWER
Operating Mode
Off
On
Flashing
Green
Power off
Power normal and
locked on channel
Power normal and
scanning channels
TRANSMIT DATA
Red
No activity
N/a
Data Transmitted
RECEIVE DATA
Green
No activity
N/a
Data Received
Note: The LED’s may be disabled to minimise power consumption.
Refer to Appendix A - NCL Interface. All LED’s will flash on start-up
and the Receive and Transmit LED’s will flash on power down
regardless of the state of the LED disable control.
Transmit
Power
Receive
Position of On-Board LED Indicators
Copyright Wavenet Technology © November 2003
36
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
LED Output Lines
In addition to the on-board LED’s 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. The electrical interface capability, equivalent
circuit and operation of these lines is summarized in the tables below:
LED Output Lines Equivalent Circuit
LED Interface Electrical Characteristics
Parameter
Output Voltage
Range
Low
High
0 – 3.3 V
0.5 V (max)
2.3 V (min)
3.2 mA (max)
1.6 mA (min)
Output Current
Note: DCD and INRANGE outputs share the same output line from the
microprocessor and therefore the combined current consumption of
that line must not exceed 2mA.
LED Interface Definitions
J1
Pin #
Signal
Description
Signal
Active State
13
LED0_MSGWTG
Message
waiting
Output
Low when message waiting
14
LED1_INRANGE
In range
Output
Low when modem in-range
Output
Low when battery is less than
3.5V,
High when battery is greater
than 3.6V
15
LED2_LOWBAT
Low battery
Low Battery
The Low Battery signal is held active low whenever the supply voltage
drops below an acceptable level (less than 3.5V) and deactivated when
the voltage level becomes acceptable again (greater than 3.6V). The
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
BM210012WT37
37
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
very fast transition between voltages, it may take up to 20 seconds for
the modem to confirm a change in battery status.
Message Waiting
The Message waiting signal is held active low whenever there is at
least one complete message waiting in the outbound buffers (including
the reread buffer).
In-Range
The In Range signal is held active low whenever the modem is in
range. It tracks the function of the Data Carrier Detect (DCD) signal.
Selecting & Positioning the Antenna
Use this information to assist you in selecting the appropriate antenna
to incorporate into your product package. For specific detailed
information, Wavenet recommends that you use the expertise of an
antenna design engineer to solve individual application concerns. Also
always consult the appropriate technical representative of the target
network operator prior to selecting and / or designing the antenna, so
that it will pass network certification requirements.
Antenna Safety
The design of the integrated product must be such that the location
used and other particulars of the antenna comply with the appropriate
standards of the country in which the host/terminal is to be used.
The integrator should refer to the statement of Compliance on page 9 of
this manual and Regulatory Requirements section on pages 21-26 for
country requirements.
Mobile and Portable Devices
In the environment where portable devices are in use, many variables
exist that can affect the transmission path. In this case, it would be
preferable to use a vertically polarized, omni directional antenna.
Antennas for portable devices include the following designs:
Internal antenna (invisible or pull-up)
An internal antenna must provide a gain sufficient to meet network
specifications. Cable routing from the modem to the antenna needs to
avoid RF sensitive circuits and high level, high-speed clock circuits.
Consider:
The location of the antenna to avoid RFI to a computing device.
Good shielding to the display and other RF-sensitive
components
The most efficient method of cable routing
Otherwise, antenna gain can be offset by cable loss. A typical coaxial
cable is very thin, such as RG178B used in portable devices, and cable
loss can be 1dB or more per metre. Some coaxial cable manufacturers
Copyright Wavenet Technology © November 2003
38
BM210012WT37
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.
External antenna, removable and directly connected to the device
You can design a portable device that can use an off-the-shelf, plug-in
antenna, such as a ¼ wave monopole or ½ wave dipole antenna.
Typical gain of these omni directional antennas is 0dBi and 2.14dBi,
respectively.
Cabling demands the same consideration as an internal antenna
application. In a typical laptop application, the antenna must be placed
as far as possible from a display to avoid deflection. This usually
causes a deep null in radiation patterns.
External, remote antenna
For remote antenna application use the same design approach as
internal designs, including the RF cable routing of the external
connector. You can choose an off-the-shelf mobile antenna of omni
directional ½ wave length.
A double braid coaxial cable such as RG223 from the device to the
antenna is recommended if the cable length is more than a metre. The
difference in cable loss between low cost RG58 and the more
expensive RG223 is approximately 4.5dB per 30 metres. If the cable
must be routed through noisy EMI/RFI environments, a double braid
cable such as RG223 can reduce radiation and pick-up by 30 to 40dB.
Fixed Devices
Fixed data device applications use the same design recommendations
as a portable device with a remote antenna.
As for the RF connector of an external antenna, whether it is a plug-in
type or a remote type, the most economical and practical choice is a
TNC threaded connector. TNC has a good frequency response to
7GHz, and leakage is low. A mini UHF threaded connector provides
adequate performance and is an economical choice. If the size of the
TNC and mini UHF connectors becomes critical, consider an SMA
threaded connector or an SMB snap fit connector. (The SMB connector
does not accept an RG58 or RG223 cable).
Selecting an Antenna
The requirements for the antenna used with the Boomer II OEM
Modem are:
Antenna Gain:
BM210012WT37
Up to a 12dBd maximum gain antenna
can be used using the module FCC
approvals alone without separate
equipment approval for the host/terminal.
with separation distances as per the
39
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Compliance Statement on page Error!
Bookmark not defined.
Impedance:
50Ω
Centre Frequency:
833MHz ± 5MHz (for 800MHz modem)
921MHz ± 3MHz (for 900MHz modem)
Frequencies of operation:
806 to 825MHz (for 800MHz transmit)
851 to 870MHz (for 800MHz receive)
896 to 902MHz (for 900MHz transmit)
935 to 941MHz (for 900MHz receive)
Acceptable return loss:
VSWR < 1.5 or RL < -14dB (recommended)
VSWR < 2.0 or RL < -10dB (minimum)
The power output of the Boomer II OEM Modem is nominally 1.8W at
the antenna port. The antenna gain or loss will affect this value.
For reference Wavenet used the following ¼ wave whip antennae for
FCC certification and these are included in the Integrator Developer
Kits;
800 MHz modem: Radiall/Larsen - SPWH20832 (blue tip)
900 MHz modem: Radiall/Larsen - SPWH20918 (red tip)
Copyright Wavenet Technology © November 2003
40
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Connecting the Antenna
The Boomer II OEM Modem Module provides an MMCX RF
connector located at the top of the unit, to attach to the antenna cable.
The antenna does not plug directly into the modem but uses an antenna
cable to interface between the device and the modem.
The antenna cable should be a low loss, 50Ω impedance and have a
MMCX plug that can mate with the modem’s MMCX socket. It is
recommended that a Huber+Suhner connector be used to connect to the
modem as below:
11 MMCX series
Straight Connector
16 MMCX series
Right Angle Connector
If an extension cable is required to the antenna, it should be low loss, as
short as possible and an impedance of 50 ohms. Proper matching
connectors should be used, as each connector introduces a return loss
and reduces performance.
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. Typically, a metal case of a computing
device and its internal components may attenuate the signal in certain
directions. This is undesirable as the sensitivity and transmit
performance of the Boomer II would be reduced. However, careful use
of metal used for the ground plane for an antenna can improve the
antenna gain and the coverage area for the system.
If your device is designed to sit on a surface, the antenna should be
positioned as far from the bottom of the device as possible. This is to
reduce the radio frequency reflections if the device is placed on a metal
surface.
If your device is hand held or is worn next to the body, the antenna
should be positioned to radiate away from the body.
The integrator should refer to the statement of Compliance on page 9 of
this manual and Regulatory Requirements section on pages 21-26 for
country requirements.
BM210012WT37
41
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Source Based Time Averaging Function
For portable or handheld applications the integrated host/terminal must
comply with OET Bulletin 65 and Supplement C (June 2002) with
respect to Specific Absorption Rate (SAR) requirements.
The Boomer-II modem module operates on a packet data network
which sets the timing of most aspects of the RF signalling protocol.
The shortest transmit event over which the Boomer-II modem has
control is a transmit transaction which is comprised of a series of
transmit pulses.
For portable or handheld applications a source based time averaging
function has been incorporated in the Boomer-II modem firmware.
This function limits the transmit duty cycle by controlling the timing of
when transmit transactions are initiated and the delay period between
them.
When a data transmission occurs, the actual transmit time is recorded.
Subsequent data transmissions are inhibited until a delay period (idle
time) has elapsed to ensure the average duty cycle of transmissions is
less than the preset “Duty Cycle” limit. Any delayed user data that is to
be transmitted will be buffered until it is permitted to be sent.
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 data
Determine actual
Transmit_Duration
Set Idle_Time =
Duty_Factor *
Transmit_Duration
Source Based Time Averaging Transmit Algorithm
Copyright Wavenet Technology © November 2003
42
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
The Boomer-II modem module has an overall transmit Duty Cycle
limitation of 30% (maximum) to physically protect the modem
hardware.
The default Duty Cycle preset in the factory at the time of manufacture
is 10%. Other duty factors and SAR evaluation must be addressed at
the time of OEM integration into any final host/terminal product and is
the responsibility of the OEM Integrator.
The algorithm and preset Duty Cycle is recorded in the module
firmware at the time of manufacture and cannot be altered by the end
user.
BM210012WT37
43
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
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.2A maximum if antenna mismatched)
Transmit Duration:
32ms (minimum)
7s (maximum)
Duty Cycle
30% (maximum) data dependant
Receive Current
85 mA (maximum)
Standby Current
4.6 mA (maximum)
Add ~1.2mA if LED’s enabled
Off current consumption:
100 µA (nominal)
Power Supply Ripple:
< 15mV peak to peak
Design Considerations
The power supply is one of the key issues of design of wireless
terminals.
Due to the burst nature of transmit periods the power supply must be
able to deliver high current peaks for short periods of 32ms to a
maximum of 7 seconds (RD-LAP 9600 bps) or for 20 seconds (MDC
4800 bps). During this time the drop in the supply at the module itself
must not exceed 200mV (total at the module), such that at no time
module shall module supply drop below 3.4V and ripple must not
exceed 15mVp-p during transmit.
The maximum transmit current into a matched antenna is 1.6A,
however, this can increase if antenna mismatch occurs.
Wavenet recommends designing a robust power supply that can
provide adequate power under non-ideal conditions such as an
improperly matched antenna, where current can be up to 2.2A.
It is recommended that for ensuring power supply margin the following
be done:
A short FPC cable (e.g < 100mm) is used to minimise power
supply voltage drop during transmission.
Copyright Wavenet Technology © November 2003
44
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
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.2A for up to 20 seconds and
with a duty cycle (set by data usage) ~ 30% maximum.
Multiple pins are assigned to both power and ground
connections for the modem. Connection of all designated pins
to the appropriate supply or ground in the host/terminal is
necessary to accommodate modem current requirements.
The host/terminal must provide a continuous supply.
The modem is fully compliant with the DataTAC Power Save
Management system. The modem exists in the lowest power state
possible while still providing uninterrupted service. By de-asserting
the HOSTPWR_ON signal, the modem disconnects from the
network then enters a near-zero power state. The modem resets if
the power source is cycled. This can cause network service issues,
since the modem might not have had a chance to de-register. The
modem spends the majority of time in sleep mode.
Conservation
In installations requiring power conservation (such as, when the
modem is powered from a battery or solar cell), you must monitor
modem power consumption in various operating states. Even though
the Boomer II OEM modems are designed for minimal power
consumption, by using the network Power Save protocol offered by
DataTAC networks you can further reduce power consumption.
Another power saving idea is to activate the modem only when it is
needed.
Note: The on-board LEDs may be disabled to minimise power
consumption. Refer to Appendix A - NCL Interface. All LEDs will
flash on start-up and the Receive and Transmit LEDs will flash on
power down regardless of the state of the LED disable control.
Power Save Protocol
The modem typically uses current provided by the host/terminal
battery. For the product to be usable for a reasonable period in portable
applications, the host/terminal battery power must be conserved. To
meet this requirement, the modem uses DataTAC Power Save protocol.
The Power Save Protocol defines the following four modem power
consumption states:
BM210012WT37
45
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Off
The modem is turned off or the host/terminal (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.
Power Profile
The modem’s power consumption profile depends on the usage and the
network configuration of the Power Save protocol.
For example, the following numbers present a typical profile for the
Boomer II modem based on reasonably heavy usage and assuming a
3.8V supply current: (Power Save Mode = Maximum)
80 % Sleep @ 4.4 mA typical
19.9 % Receive @ 76 mA typical
0.1% Transmit @ 1.6A typical
The actual percentage of total time spent in each state (transmit,
receive, sleep) is a function of the following variables.
Network configuration
On networks supporting Power Save operation, the network
configuration impacts how long the modem must be in the sleep state.
Note: Neither Wavenet nor any developer has any direct control over
the network configuration. Networks supporting Power Save are
typically configured to preserve the battery life of modems of their
subscriber base.
Message traffic model
The message traffic model defines how many messages are transmitted
and received, and the average length of the messages sent and received
in a given working day. For instance, a dispatch application could have
a message traffic model as follows:
Messages transmitted in 8 hour day: 25
Average length of transmission: 120 bytes
Messages received in 8 hour day: 10
Average length of received message: 30 bytes
This analysis of message traffic allows the power consumption profile
to be assessed in terms of percentage of time spent transmitting,
receiving, and sleeping. (For more information, see Develop a Message
Model on page 14.)
Usage of group LLIs
Copyright Wavenet Technology © November 2003
46
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Some applications require the use of group LLIs, such as a stock
quotation broadcast service. Each active group LLI (in addition to the
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).
Power Control
The host/terminal provides the supply rail (HOST 3.8V) to the modem
through the Data Interface Connector.
The host/terminal turns the modem ON by asserting the
HOSTPWR_ON signal.
The host/terminal 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.
ESD protection is provided on all power supply lines and I/O lines.
Power-Up Sequence
Reference should be made to the Power-UP Timing Diagram below
when reading the following Power-UP Sequence description.
To turn the modem ON, power must be applied (HOST 3.8V) and the
host/terminal asserts the HOSTPWR_ON signal.
The modem contains an internal voltage detector and reset delay circuit
to generate a reset signal for the CPU to ensure orderly and reliable
software initialisation.
An externally controllable reset signal (HCRESET) is optionally
available if the host/terminal wants reset synchronisation or to force a
modem reset while power is still applied.
If the HCRESET signal is used, once it is de-asserted the modem CPU
will be able to initialise.
Once out of reset the first operation is the boot-up of the modem CPU.
At this time CTS is momentarily asserted, then de-asserted. After a
successful boot up, the CPU starts the modem initialisation sequence.
After the initialisation sequence, the Native Mode interface and the
serial interface are active.
Following successful initialisation, the modem asserts DSR and
performs the initialisation protocols for both the DTE interface and the
RF network. After successfully initialising the DTE interface, the
modem asserts CTS. After the network ACK of the registration
sequence, DCD is asserted.
BM210012WT37
47
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Power-Up Timing Diagram
Optional Delay
HOST 3.8V
HOSTPWR_ON
Modem Internal Power
HCRESET (Optional)
Optional
Delay
140 ~ 280 ms
Reset Delay
~ 300 ms
Initialisation
Modem Internal Reset
Boot Stage
CTS
Modem is now
software controlled
Modem is now
Operational
DSR
Network Connect
DCD
IN RANGE
LED’s
Note: HCRESET, CTS, DSR, DCD, the LEDs and the internal modem reset are all
active low signals.
Power Up Diagram Callouts
Power is supplied to the modem
The HOSTPWR_ON signal is asserted to turn on the modem.
The HCRESET signal is de-asserted.
The internal modem reset is released to allow the modem boot up
sequence.
The modem exits the boot load state, is operational and is ready to
communicate with the DTE.
Copyright Wavenet Technology © November 2003
48
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Power Down Sequence
The host/terminal 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.
The soft shutdown process starts when the HOSTPWR_ON control
line is de-asserted. The shutdown process consists of the modem first
de-registering from the network and de-asserting the DCD line. Next, it
saves the modem configuration and network channel information. The
modem then de-asserts the DSR line, signalling the modem is no longer
in a ready state. This process can take a few seconds to complete.
At this point, the host/terminal can remove the power from the modem
and still maintain most of the modem settings and last registered
network channel. The modem can be left with power applied and
HOSTPWR_ON de-asserted.
The reset line HCRESET can be asserted at this time in preparation for
the next power-up sequence. This is optional and is intended for
rebooting the modem only. Resetting the modem causes a cold start
and flushes the saved modem settings.
The following diagram shows the sequence for these actions.
Power-Down Timing Diagram
HOSTPWR_ON
DCD
Network Deregistration
RF Protocol Requirement
DSR
Modem internal power control
Modem software is
Operational
Modem Internal Power
Note: DSR and DCD are active low signals.
BM210012WT37
49
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Power Down Diagram Callouts
HOSTPWR_ON is de-asserted from the host/terminal 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.
The modem starts the soft shutdown process. The battery status
indicator pulses quickly until the shutdown steps are complete.
The modem initiates the deregistration process from the network
and upon completion de-asserts DSR and DCD. DCD signifies
network detachment, and DSR shows the modem’s readiness state.
After deregistration, the internal modem CPU power-on signal is deasserted. This deactivates the internal modem power rail to the
radio.
At this point you can optionally de-asset HOSTPWR_ON signal to
the modem and assert the HCRESET line to the modem.
Copyright Wavenet Technology © November 2003
50
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Batteries
The Boomer II OEM Modem may be powered by batteries if used with
a handheld device.
For battery operated devices, battery selection is a critical decision,
requiring consideration of many factors. These include cell size,
internal impedance, charging requirements, and susceptibility to
common battery phenomena, such as memory effect or overcharging.
Each of these factors is discussed in detail in this section.
The selected battery must be able to meet the Boomer II power
requirements as mentioned previously.
Three prevailing battery technologies exist today:
Nickel cadmium (NiCad) batteries may be used for devices
requiring wide temperature ranges.
Nickel metal hydride (NiMH) and
Lithium ion (Li+) batteries may also be used for devices utilised
above 0ºC. Specifications for these batteries should be obtained
from the manufacturer.
NiCad
Most mature technology
Lower energy density (energy/volume) than NiMH or Li-ion
Available in all cell sizes, including AA, 2/3A, 4/5A, A, 4/3A,
and so on. This represents the greatest number of packaging
options.
Exhibits a memory effect when not occasionally discharged
below the lower extent of its operating voltage. The memory
effect reduces the usable capacity of each battery cell.
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. Then enter a slight overcharge
condition, where the voltage actually begins to decrease prior to
terminating battery charging. NiCad is the most robust battery
technology available today for non vehicular applications.
NiCad can withstand over charging, over discharging, and harsh
environments with reasonable resilience.
Raw battery cells or battery packs can be purchased from
suppliers
BM210012WT37
51
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
NiMH
Mature technology with potential for improvements in battery
chemistry and energy density over the next five years
Higher energy density than NiCad, but lower than Li-ion
Available in standard sizes AA, 2/3A, 4/5A, A and 4/3A and
some prismatic (rectangular) configurations
Exhibits the memory effect in a manner similar to NiCad
technology, but at a less pronounced level
Internal impedance of 35-49µΩ per 1.2V cell
Typical cell voltages are 1.2V, with multiple cells used to
obtain higher operating voltages
Earlier NiMH battery chemistry could be damaged by high
current discharge pulses. Newer battery chemistry has
eliminated this problem. When purchasing batteries of this type,
determine if high current pulse discharging is an issue.
Typical charge method is dT/dt, where T is temperature. As the
battery reaches full charge, any further energy is dissipated as
heat. A temperature threshold is used to terminate the charge
cycle in conjunction with voltage monitoring. NiMH is more
sensitive to overcharging then NiCad and exhibits decreased
capacity if repetitively overcharged.
Raw battery cells or battery packs can be purchased from
suppliers.
Li-ion
Reasonably mature technology leaving lots of potential for
increased capacity
Higher energy density than either NiCad or NiMH
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. Li-ion
batteries are very susceptible to damage due to over discharge
and high current pulses. As a result, manufacturers recommend
that a protection circuit be added to battery pack designs. The
resultant internal impedance of a battery pack with protection
circuitry can reach the 500mΩ level.
Typical cell voltages are 3.6V with multiple cells used to obtain
higher operating voltages.
Copyright Wavenet Technology © November 2003
52
BM210012WT37
Boomer II User Manual & Integrator’s Guide _________________________________________________Installation
Li-ion batteries are very sensitive to over-discharge and
represent a hazard if not properly designed with protection
circuitry.
Typical charge method is constant-voltage, constant-current.
Applying Battery Technologies
When reviewing different battery technologies, consider the following
characteristics of OEM devices incorporating wireless data modems.
Current drain is not constant
Typically, battery manufacturers specify the battery discharge profiles
by assuming a constant-current drain model. In a wireless data system,
the constant current drain model no longer applies. There are three
levels of current drain contributions that can be expected: sleep,
receive, and transmit. The modem cycles through these different states
throughout the time it is powered on and in contact with the wireless
network. To determine the realistic battery life or capacity for your
product, you must contact the battery manufacturer or experiment by
transmitting for various durations.
Peak currents during transmissions
Since transmissions are typically short, the resultant current drain
during transmissions can be viewed as current pulses. These pulses
must be considered when selecting the proper battery technology, since
not all technologies are equally tolerant of current pulses.
Additionally, the internal impedance of the battery must be taken into
account at the peak currents during transmissions, since this is the time
when the largest voltage drop occurs across the battery terminals.
Adequate supply guard-band must be designed in to ensure that the
modem and any other circuitry in the final product are not reset during
transmissions.
Messaging model
To determine the required battery capacity for your product, you need
to define the messaging model for your target market. In regard to
battery selection, the messaging model details the following
information:
Optimal number of hours per day of use prior to recharging the
battery
Number of messages transmitted per hour
Number of messages received per hour
Average length of transmitted messages
Using this information and the typical current drains of the modem and
other circuitry present in your product, you can define the requirements
for battery supply voltage and capacity.
BM210012WT37
53
Copyright Wavenet Technology © November 2003
Installation_________________________________________________ Boomer II User Manual & Integrator’s Guide
Battery Recharging
Plug-in Supplies
A mains plug-in supply must be designed to ensure that voltage spikes,
lightening and other power fluctuations cannot damage the Boomer II.
Transient voltage protection zener diodes or other spike arrestor
circuits may be added to keep the inputs within the power requirements
mentioned previously. These should have a value of 20V and be placed
on the supply side of the regulator circuit.
Automotive Supplies
Extra protection is required from an automotive supply to protect the
Boomer II OEM Modem from power fluctuations when used in an
automobile.
The electrical transient conditions (e.g. battery jump start), may
damage the modem if not adequately clamped and filtered.
Environmental Considerations
The environmental requirements of the Boomer II OEM Modem are as
follows:
Operating Temperature:
-30° to +60°C
Storage Temperature:
-40° to +70°C
Relative Humidity
0 to 95% non-condensing
These limits should not be exceeded in the intended application.
Copyright Wavenet Technology © November 2003
54
BM210012WT37
Boomer II User Manual & Integrator’s Guide ____________________________________________ Modem Test Jig
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.
The test jig acts as a temporary host/terminal for the modem and
provides access points to the radio’s communication port, allowing you
to monitor activity with a logic probe, multimeter or oscilloscope.
Features
All Input/Output Lines configurable by jumpers and/or
accessible through parallel FPC connector.
On-board dual RS232 Serial Communication interface ports
with DB9 connectors
Through the SPY MODEM connector, you can monitor the data
transmitted from the modem (RX, DSR, and CTS).
Through the PORT 2/SPY PC connector, you can monitor the
data transmitted from the PC (TX, RTS and DTR), or talk to the
second serial port of the modem. You can make this choice by
putting all five jumper links on the right or left side of the RDW
header connector near the port.
Switches and LED indicators on SS0 - SS3 modem I/O lines.
On-board voltage regulator for Boomer II OEM supply rail.
On-board LEDs for three external signals:
Low battery
Message waiting
In range
On-board antenna matching network allowing conversion from
MMCX to SMA connectors.
Test Jig Updates
From time to time updates may be provided for the Boomer-II test jig
and these should be implemented as per the Update Notice. If you are
unsure if your test jig incorporates all the latest updates please contact
Wavenet Technology.
BM210012WT37
55
Copyright Wavenet Technology © November 2003
Modem Test Jig ____________________________________________ 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.15A Fuse
5X20mm
Port 2 / SPY PC Interface
DB9 Connector
8-way
DIP switch
SPY Modem Interface
DB9 Connector
ADJ VCC
52-pin header connector
Ground
test pin
Host PC Interface
DB9 Connector
Audio In
BNC Connector
Audio Out
BNC Connector
Boomer II
Parallel 30-pin FPC Connector
For signal access
On-board
LED indicators
Lower 30-pin FPC Connector
For connection to modem
SMA
Antenna
socket
SMA
Modem
socket
On / Off switch
Switches the power to the test jig on or off.
DC Jack
Provides power to the test jig. (3.8V)
DIP Switch
8-way DIP switch used to configure the test jig.
The following table shows the DIP switch configuration.
Dip
Switch #
Signal
On
PA7
Always leave this switch in the OFF position
OFF
OSC OFF
Always leave this switch in the ON position
ON
SS3
3V
10k Pull down to GND
OFF
SS2
3V
10k Pull down to GND
OFF
SS1
3V
10k Pull down to GND
OFF
SS0
3V
10k Pull down to GND
OFF
H-P-ON
Turn the modem off
Turn the modem on
OFF
RESET
Keep modem reset
Keep modem in working status
OFF
Copyright Wavenet Technology © November 2003
Off
56
Default
Position
BM210012WT37
Boomer II User Manual & Integrator’s Guide ____________________________________________ Modem Test Jig
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.exe” can be
used to view the data.
SPY Modem
Connector
DB9 connector, used to spy on the RS-232 data
sent by the modem to the DTE (using DSR, RX,
CTS and GND signals).
An analyser program such as “spy.exe” can be
used to view the data. A communication program
such as “HyperTerminal” can be of limited use if
the data spied upon contains a lot of alphanumeric ASCII characters.
Host PC Connector DB9 connector, used to connect serial port 1
(of 2) of the modem to the DTE. The default
values for this RS-232 connection is 9600bps, 8
bits, no parity, 1 stop bit.
This port can also be used to download new
modem software to the Boomer II.
Parallel FPC
Connector
30-way FPC (Flexible Printed Circuit) connector
used for signal access.
Lower FPC
Connector
30-way FPC (Flexible Printed Circuit) connector
used to connect the Boomer II to the test jig.
Modem Connector
Used to connect the Boomer II’s antenna socket
to the antenna connector.
Antenna Connector Used to connect the external antenna.
LEDs
There are eight LEDs used to indicate the
following:
Power
Low Battery
In Range
Message Waiting
SS0
SS1
SS2
SS3
BM210012WT37
57
Copyright Wavenet Technology © November 2003
Modem Test Jig ____________________________________________ 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Ω.
3 RDW Header
Connector
Connectors used for jumpers (supplied).
For Port 2 use, all the jumpers are positioned
from the centre column to the left hand column.
3 RDW
Header
connector
For Spy PC use, all the jumpers are positioned
from the centre column to the right hand column.
3 RDW
Header
connector
52-pin Header
Connector
Connector used for jumpers (supplied).
All the jumpers are connected as default.
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Copyright Wavenet Technology © November 2003
DCD
RX
TX
DTR
GND
DSR
RTS
CTS
RI
RESET
H-P-ON
MSGWTG
INRANGE
LOWBAT
SSO/RX2
SS1/TX2
SS2/CTS2
SS3/RTS2
3.8V
3.8V
3.8V
3.8V
GND
GND
GND
GND
58
BM210012WT37
Boomer II User Manual & Integrator’s Guide ____________________________________________ Modem Test Jig
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. Adjust the trim pot marked ADJ VCC to make sure the voltage
on the test pin next to the ADJ VCC is 3.3V.
3. Keep all of the switches on the dipswitch in the off position
(except DIP switch 2) for normal modem operation.
Fitting the Boomer-II Modem
With the power off,
1. Connect the Boomer II OEM modem to the lower FPC
connector on the test jig using a 30-way FPC cable.
Use the following procedure to insert the cable into 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. Ensure that the cable is inline with the connector and
insert the FPC cable into the connector with the
conducting surface of the cable facing downwards.
FPC conductor side
BM210012WT37
59
Copyright Wavenet Technology © November 2003
Modem Test Jig ____________________________________________ Boomer II User Manual & Integrator’s Guide
c. Press down the lock lever.
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. Remove the cable after the lock is released.
2. Install an antenna to the modem. Use either the on-board SMA
connection and an adapter cable between the modem MMCX
connector and the test jig SMA connector, or connect directly to
the modem itself.
3. Connect the PC serial cable to the DB9 connector marked
“PC”.
4. After making sure the power supply is set with the operating
voltage range of the modem switch the power supply on.
5. Select the DIP switch labelled H-P-ON to the ON position. The
green Power LED on the modem should illuminate.
You are now ready to communicate with the modem using the
PC as a host/terminal. The modem should be able to talk to the
PC by using Wavenet Commander software, or other NCL
protocol software. If the modem is in Hayes compatible mode,
then a terminal program will suffice.
Copyright Wavenet Technology © November 2003
60
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Wavenet Software Development Tools
Software Development Tools
Wavenet SDK
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 Software Architecture
The SDK is built on a client-server architecture. The server application
allows multiple client applications simultaneous access to the modem
The sample ‘ModemInfo’ application is an example of a client
application. The ‘PortServer’ application acts as the server.
SDK Contents
The SDK contains the following components:
Integrators Guide and Users Manual for Boomer II OEM
modem (This manual)
“Wavenet Commander” software
Wavenet Commander is a modem application development and
diagnostic communications tool that runs on a Windows PC and
allows communication with the modem via the Boomer II Test
Jig. It provides a means for users to become familiar with the
modem and uses NCL protocol to communicate with the
modem.
NCL API for Windows:
The NCL API fro Windows is the wireless client component of
the SDK. It provides routines for sending and receiving data
using an NCL compliant Radio Packet Modem (RPM).
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 included in the NCL_API directories.
ModemInfo
A directory structure containing source files and executable
for the sample ModemInfo Client application.
PortServer
A directory structure containing a serial port sever. The
serial port server runs as a service on your PC and allows
multiple Clients to access the modem via a serial port. Note
the port server has no user interface, and runs as a service.
BM210012WT37
61
Copyright Wavenet Technology © November 2003
Wavenet Software Development Tools___________________________ Boomer II User Manual & Integrator’s Guide
Run as PortServer comx: Where "x" is the PC
communications port the modem is attached to via a
Boomer II Test Jig. If no command line parameter is
specified, 'PortServer' assumes that 'com1' is to be used.
Note: The port server must be running for the Client
applications to work with the Multisession VDD. The port
server must not be running for the Client applications to
work with the Singlesession VDD.
Virtual Device Driver (VDD) - \Multisession VDD\
A directory structure for the VDD library containing
functions required for client applications to communicate
with the modem (i.e. Send, Receive etc) via MSMQ and the
PortServer services. The VDD consists of the following
files:
•
VDD.dll: Dynamic Link Library. Ensure that a
copy of this file is in the client's
application path.
•
VDD.lib: Library used by the linker when
building client applications.
•
Nclapi.h:
Header file containing the function
prototypes exported by the DLL.
Virtual Device Driver (VDD) - \Singlesession VDD\
A directory structure for the VDD library containing
functions required for a client application to communicate
with the modem without the use of MSMQ or the
PortServer services. When using this VDD, ensure that the
Portserver is not running. The VDD consists of the
following files:
•
VDD_SS.dll:
Dynamic Link Library. Ensure
that a copy of this file is in the client's
application path.
•
VDD_SS.lib:
Library used by the linker when
building client applications.
•
Nclapi.h:
Header file containing the function
prototypes exported by the DLL.
NCL API for DOS:
This directory provides supplementary DOS based NCL sample
code and a sample client application which may be useful for
application developers who wish to write their own low-level
NCL drivers and applications and is provided as a guide. This
directory contains its own documentation.
Copyright Wavenet Technology © November 2003
62
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Wavenet Software Development Tools
System Requirements
The minimum system requirements of a host/terminal emulation PC in
order to utilise the Software Developers Kit are:
Intel compatible Pentium computer or higher
Windows 2000 or later
Microsoft Message Queue (MSMQ)
16MB RAM (memory) minimum, 32MB recommended
1MB available hard disk space
9-pin serial Port using a 16550 UART
3.5-inch Disk Drive
CD-ROM drive
Wavenet Commander will run on Windows 98 and later revisions,
however, the PortServer and ModemInfo requires the Microsoft
Message Queue (MSMQ) service running on the target PC. MSMQ is
included in Windows NT4, Windows 2000, and Windows XP. MSMQ
is not available for WIN98, WINME, or WIN95. If you do not have
Microsoft Message Queue installed on your machine, you might
receive an error message indicating that a file, mqoa.dll, is missing
when you try to compile code that uses the message queue.
Installing Message Queuing Services on Windows 2000 and XP
For Windows 2000 users, on the Start menu, choose Settings
and then choose Control Panel.
For Windows XP and later, on the Start menu, choose Control
Panel.
In Control Panel, choose Add/Remove Programs and then
choose Add/Remove Windows Components.
In the Windows Component Wizard, choose Message Queuing
Services from the Components list.
Click Next, and then follow the remaining steps.
Installing Message Queuing Services on Windows NT4
Download and install Windows NT4 Option Pack from the
Internet at
http://www.microsoft.com/NTServer/nts/downloads/recommended/NT4Opt
Pk/default.asp.
Be sure to select to install Microsoft Message Queue Server 1.0.
All code was developed using Microsoft Visual C++ Version 6.0, for
Microsoft Windows WIN98/NT/2000.
BM210012WT37
63
Copyright Wavenet Technology © November 2003
Wavenet Software Development Tools___________________________ Boomer II User Manual & Integrator’s Guide
Server Initialisation
The port server must be running for the Client applications to work.
‘PortServer.exe’ takes the desired serial port name as a command line
parameter. If no command line parameter is specified, ‘PortServer’
assumes that ‘com1’ is desired. Start the server application by running
‘PortServer.exe’. If com2 is connected to the modem, run the server as
following: PortServer com2.
This server application does not have a user’s interface. The only way
to ensure that it is running is to view the active processes on the
Windows Task Manager.
VDD Library
The VDD library contains all tools required for client-server
communications by using the MSMQ service to deliver messages to the
other party. All client applications are required to open a session with
the server application if it wants to communicate with the modem. By
using the VDD library this process message delivery is transparent for
the client.
Please refer to Appendix B – SDK NCL-API and Port Server and
Appendix C – SDK Sample programs for additional information on the
Boomer II SDK contents.
Copyright Wavenet Technology © November 2003
64
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Wavenet Software Development Tools
Wavenet Commander
The radio service utility software “Wavenet Commander” enables a
user to exercise and configure Wavenet Modems. This software runs
under Windows 95, 98, NT, or 2000.
Wavenet Commander 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.
Wavenet Commander is issued as an install shield and will create the
following files in the user designated installation directory:
WC_End_User.wcu
The executable file
user_defined.def
Definition file for User Scripts
ncl_generic.def
Default NCL Commands.
Refer to Appendix A - NCL Interface for the NCL command list.
A typical screen shot from Wavenet Commander is shown below.
BM210012WT37
65
Copyright Wavenet Technology © November 2003
Wavenet Software Development Tools___________________________ Boomer II User Manual & Integrator’s Guide
Operations
Wavenet Commander display is broken up to four quadrants as
follows:
Upper-Left
Upper-Right
“Modem Info” Tree View
“Modem Info” Property View
The modem Type and display options
are represented as Tree view. Use the
mouse to select the following modem
information views.
Displays the associated property pages
as selected by the quick link in the tree
view.
Settings:
Basic Modem settings
Versions: Modems Versions
Messages: Send / Receive Messages.
Status:
Modem Status.
For each view there are various
associated property pages
Lower-Left
Lower-Right
TTY Control View
Edit View
TTY setting control allowing users to
choose what kind of information they
want to see in the Lower-Right hand
quadrant. Allows the user clear the
window, Issue User defined and
standard NCL commands.
Edit view displaying raw and/or
interpreted data flowing between the
modem and the PC.
On start-up the user is presented with an icon in the tree view
representing the type of modem Wavenet Commander was last
connected to. To check /adjust the communication port settings, press
the Hot Key F6 or click on the connect icon in the toolbar. Choose the
modem communications port when prompted and following view will
be displayed.
Note: The base station port is for Depot Test Mode, which is not
available in the user version
Copyright Wavenet Technology © November 2003
66
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Wavenet Software Development Tools
Ensure the test jig with the modem is powered up and connected (Serial
cable from PC port of the Test Jig to your PC’s Communication port)
and the above the communication settings are correct for your set-up.
Modem Info Tree View
ModemInfo uses the NCL API to interface to the DataTAC® network.
Modem Info allows the user to view the modem’s current status, to
send and receive messages on the current channel the device is
registered to. The options displayed in the tree include the following:
Settings: Allows the user to select an operational profile (i.e. Channel
list, RD –Lap version, etc), and the modems power save mode (if
required). The user can also set the notification events, and adjust the
channel list.
Versions: Displays the devices LLI, serial number, software version,
modem configuration version and the hardware platform.
Messages: Allows a user to send and receive messages from the
channel the device is currently registered on.
Status: Displays the modem’s current channel (if registered) and its
RSSI level. If the device is not registered, it will be in scan mode,
scanning the channels from the channel list in its current profile.
Modem Info Property View
The property view is dependant on the tree view. The following
property pages are displayed for each tree view.
Settings: The user can select, the network profile, and if required the
modems power save mode.
•
Network Profile: The current network profile is displayed. The
user can select a profile via the profile display list when this field is
selected. Note the device must be registered with the appropriate
network provider for the device to log on.
•
Power Save: The user can select the devices power save mode as
required. Note in some networks power save mode is not
supported.
Versions: Displays the devices LLI, serial number, hardware platform
and software version.
Messages: Allows a user to send and receive messages from the
channel the device is currently registered on. Type the required
message in the send message window and then click on the 
button. Any received data messages will be displayed in both the
received message window and the Edit View Window. Note your
modem must be registered on a channel.
Status: Displays the modem’s RF-Protocol, channel, RSSI, In Range
Status, Base Station ID the modem is registered on, and the modems
power source level.
BM210012WT37
67
Copyright Wavenet Technology © November 2003
Wavenet Software Development Tools___________________________ Boomer II User Manual & Integrator’s Guide
TTY Control View
The TTY control View allows the user to perform the following:
•
Display detailed commands and responses. The commands to the
modem and the responses from the modem are displayed in Hex
format. A maximum of 200 bytes is displayed per command or
response.
•
Allows the user to enable / disable the wc.log file. The log file will
contain the information displayed in the Edit View window for
future reference.
•
Allows the user to run standard NCL command by selection of the
 button. The user can edit the ncl_generic.def file
with an external editor as required.
•
Allows the user to run a user defined NCL command by selection
of the  button. The user can modify the
user_defined.def file using an external editor as required. Details
on how to generate a user command are contained in the def file.
•
Clear the Edit View screen by selection of the 
Button.
Edit View
The Edit View displays the commands issued to the modem and the
modems responses. Wavenet Commander will where possible interpret
the modem’s response, and display the response in detail; otherwise the
response will be displayed as hex bytes. From this window the user can
issue some basic commands that include the underscore ‘_’ command
which will get the modems status and the exclamation command “|” for
the modem settings. Pressing ‘?’ will display basic help.
Hot Keys
Wavenet Commander has the following Hot Keys.
•
F4 Standard NCL command Selection.
•
F5 User NCL Command Selection
•
F6 Communication port configuration.
Copyright Wavenet Technology © November 2003
68
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Wavenet Software Development Tools
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 explains the procedure for updating the Application
Loader software and has a troubleshooting section to assist with any
problems.
Updating Application Loader Software on Your Modem
The Application Loader software may be used for all Wavenet
modems. The procedure is the same for all modems but some of the
screens may differ in appearance.
Follow the procedure below to check the software version currently
loaded on your modem and if necessary, to upload the modem
application.
1. Connect the Boomer II to the Test Jig as described on page 22.
2. Connect the Data Communications Modem connector to the
Boomer II Test Jig’s PC connector.
3. Connect the Data Communications PC connector to a COM
(serial) port on your computer. Note that the Data Comms PC
connector is a 9-pin plug. If your computer has a 25-pin serial
port you will need a 9-pin to 25-pin adapter.
4. Switch the modem on.
5. Switch your PC on.
6. From the PC, open the appropriate Application Loader
(Apploader) file for your modem.
The letter(s) preceding the three numerical characters at the end
of the Apploader file name denotes which modem the file is
appropriate for, BM2 for the Boomer II OEM modem.
The three numerical characters at the end of the file name show
the version number of the application software, i.e.
408 is software version 4.08 and
233 is software version 2.33
If you select the incorrect Apploader file for your modem the
following typical message will be displayed.
BM210012WT37
69
Copyright Wavenet Technology © November 2003
Wavenet Software Development Tools___________________________ 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.
Select the
appropriate
com port on
your PC that
the modem
is connected
to.
Click the
Download
Application
button to
download
the latest
version.
Displays the current
version of Application
software on your
modem.
7. The following screen is typically displayed.
Displays the new
application available.
Status bar.
8. Select the appropriate PC communications port to which the
modem is connected.
9. If the program recognises that the version of Application you
are attempting to install is later than the version currently
installed, the Download Application button will become
enabled. A message is displayed in the status bar advising that
the application software versions differ and requesting that you
press the Download Application button to update.
If the program recognises that the version of Application you
are attempting to install is earlier than the version currently
installed, the Download Application button will remain
disabled. A message is displayed in the status bar advising that
the application software version on the modem is up to date and
requesting that you exit the program.
10. Click
to update the Application software.
A progress bar is displayed informing you of the progress of the
update, and the modems TX led will flash as the modem is
being loaded.
11. After the application has been updated, the modem is
automatically switched off. A message is displayed prompting
you to switch the modem on again.
12. Click
and the download window will read the modems
application version and redisplay it.
Copyright Wavenet Technology © November 2003
70
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Wavenet Software Development Tools
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. This will automatically reset
Troubleshooting
You shouldn’t encounter any problems updating the Application
Loader software, however the following messages may appear.
This message will appear if the modem is disconnected during the
download. Ensure that all the connections between the PC and the
modem are secure, check the battery connections, ensure the modem is
switched on and follow the instructions in the message to try again.
This message will appear if the modem is disconnected whilst running
the Application Loader. Ensure that all the connections between the PC
and the modem are secure, check the battery connections and ensure
the modem is switched on.
BM210012WT37
71
Copyright Wavenet Technology © November 2003
Wavenet Software Development Tools___________________________ 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
Application loader file name denotes which modem the file is
appropriate for, i.e. BM2 for the Boomer II OEM modem.
Copyright Wavenet Technology © November 2003
72
BM210012WT37
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing
Integration 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 has been integrated
properly into the host/terminal.
Proper testing throughout the development and integration cycle
ensures that the final product works in both normal and exceptional
situations. These tests are provided in several stages as follows:
1. Hardware integration
2. Desense and EMI
3. Regulatory compliance
4. Application software
5. Final assembly
6. End user problem resolution
7. OEM service depot repair
Hardware Integration
To ensure that the integration effort is carried out properly, monitor all
relevant engineering standards, requirements, and specifications. In
addition, perform functional tests during product development to
validate that the integrated package performs as designed.
Enabler Functions
To test the interaction between the modem and host/terminal, your
product must be able to perform the following:
Turn the various hardware components on and off. This
capability helps to isolate possible desense and other emissions
problems. (See “Desense and EMI” on page 74.)
Pass data through the host/terminal between the modem and the
test platform. This allows external programming and
configuration software to communicate with the modem while
it is integrated within the host/terminal. For microprocessorbased products, pass-through mode uses software emulation
involving the host/terminal processor, which passes full-duplex
serial port data to and from the integrated modem. Otherwise,
pass-through mode is implemented in hardware by level
shifting between the 3.3V CMOS levels and the 12V RS-232
levels generally found on PCs.
Specific Tests
In addition to the various tests that exercise your own circuitry, such as
power-on self-test, design tests that ensure proper interaction between
BM210012WT37
73
Copyright Wavenet Technology © November 2003
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide
the modem and host/terminal. Ensure that the following hardware
integration issues are evaluated:
RF Immunity
RF transmissions of the modem do not interfere with operation of the
host/terminal.
Electrical Signalling
Power sources and interface are functionally compatible between the
host/terminal and the modem.
Physical Parameters
Physical configuration of the modem inside the host/terminal provides
adequate ventilation, mounting, shielding, and grounding.
Antenna Performance
Integrated antenna system meets the required ERP specifications,
VSWR specifications, antenna propagation patterns and any applicable
network operator requirements.
ESD Requirements
Host/terminal design protects the modem from ESD.
RF Re-radiation
Host/terminal does not allow spurious emissions in excess of 60dBc, as
caused by carrier re-radiation (for 3V/m fields).
Desense and EMI
Any host/terminal in which the modem is integrated generates some
EMI (electromagnetic interference), which tends to desensitise the
modem’s ability to receive at certain frequencies.
Wavenet can provide a facility for testing the amount of desense that
your modem experiences while in a host/terminal. Specifically, modem
receiver sensitivity is recorded while operating with the host/terminal
under test. For this test, you provide an integrated product, including
antenna, power supply and any peripherals. Wavenet Technology then
produces a test graph that reports the amount of desense. All desense
testing is generally performed at Wavenet Technology’s facilities.
To prepare for the desense test, provide Wavenet with hardware to
generate EMI that is representative of the final product, including the
cables, power supplies, and other peripheral devices. The host/terminal
must supply the modem the appropriate power requirements. The
host/terminal hardware must be running its CPU, LEDs, and serial
ports, etc (if so configured).
You must supply either the pass-through mode functionality (“Enabler
Functions” on page 73) or provide physical access the serial port of the
Copyright Wavenet Technology © November 2003
74
BM210012WT37
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing
modem . The ability to turn on and off the various circuits in the
host/terminal allows for the identification and analysis of the
host/terminal 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 “Guide to
Desense” on page 132.
Regulatory Compliance
Most countries where the final product will be sold generally require
approval from the local government regulatory body. In the US, the
FCC requires that two individual requirements be met before the final
product can be certified. The first test, the FCC Part 15 qualification,
requires you to prove that the product electronics hardware does not
yield local radiation capable of affecting other equipment, such as TVs,
computer monitors, and so on.
The second test (FCC Part 90) requires you to prove when the modem
transmits, it remains properly in its allocated channel spacing, and does
not produce spikes or splatter in other frequencies. Wavenet undergoes
FCC testing with the modem stand-alone to ensure compatibility with
these requirements. But since the eventual transmit capability of the
modem is highly integrated with the power supply and antenna system
of the host/terminal, the fully integrated product must be submitted for
final regulatory approval.
In addition, regulatory bodies can require the wireless modem to
transmit random data patterns on specific frequencies while
incorporated in the host/terminal. The Boomer-II OEM modem
incorporates special debug modes to allow this kind of testing,
provided the host/terminal application can issue the required
commands to the modem.
The entire regulatory process can take many months to complete and
should start early in the development cycle. The exact regulatory
requirements of each country change from time to time. For efficient
regulatory processing, it is recommend to use the services of
specialized regulatory consultants to determine the specific
requirements at the time of manufacture.
To prepare for regulatory testing, you need to integrate the passthrough mode into the product design (see “Enabler Functions” on page
73). Wavenet provides the ability to key and dekey the radio at the
required frequencies and modulation levels from an external PC via the
pass-through mode.
For further information about regulatory compliance, refer to
“Regulatory Requirements” on page 21.
BM210012WT37
75
Copyright Wavenet Technology © November 2003
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide
Application Software
Tests need to verify the communications links between the
host/terminal and the modem and between the modem and the network,
as follows:
Software Driver Configuration
Ensure that the host/terminal can enable the modem serial port to
permit the host/terminal and modem to communicate. This test verifies
that the driver software functions well and is configured properly.
Network Configuration
Determine if the host/terminal can use the modem to communicate with
a DataTAC® network. This test uses existing network software in an
attempt to communicate with a specific network.
The final application must be able to respond correctly under all
adverse network conditions, not just the ideal case. To achieve this, the
application software has to be systematically tested against all possible
failure and exception conditions. Situations such as low battery, out of
range, host/terminal down, unexpected data, maximum message size,
maximum peak/sustained throughput, and other conditions must not
cause the host/terminal application to fail. Each condition must have a
specific remedial action to alleviate it.
Final Assembly
A final assembly test should be performed before shipment to ensure
all components are working properly and issues such as crimped
antenna cables, lose connections, and improper software load are
resolved. During final assembly, the modem may send and receive a
loopback message of maximum size. The successful return of the sent
message proves the product can transmit and receive correctly.
Testing within areas lacking network coverage or for products shipped
to another country requires a different approach. Wavenet can help you
set up a closed loop final test system, using a base station and PC-based
software to emulate a network.
End User Problem Resolution
When the final product is in the hands of the end user, testing must
quickly isolate the cause of the problem in the field. For example, is the
problem caused by the host/terminal, the modem, the network, the
configuration or a user error? Can the problem be fixed locally or does
the unit need to be returned for service?
It is very time consuming and expensive to send products to service,
especially if the problem is caused by a temporary network or
Enterprise Server Application outage. For this reason, you should
design the application to allow for end-user problem determination.
Copyright Wavenet Technology © November 2003
76
BM210012WT37
Boomer II User Manual & Integrator’s Guide ___________________________________________________ Testing
Effective tests provide a systematic, positive acknowledgment from
each of the network components. For example:
Test 1
Is the OEM module able to pass its own self test?
Test 2
Is the OEM module able to communicate with peripherals?
Test 3
Is the OEM module able to communicate with the integrated
modem?
Test 4
Is the modem able to hear the network?
Test 5
Is the modem registered and allowed to operate on the
network?
Test 6
Is the gateway (if present) up and running?
Test 7
Is the Enterprise Server Application up and running?
OEM Service Depot Repair
When a host/terminal is returned for service, the first requirement is to
determine whether the modem must be sent on to Wavenet for
inspection and/or repair. To set up for this test, you need to have an
evaluation board, a known-good Boomer II OEM modem (for
comparison), a power supply, Wavenet Commander software and an
end-to-end test setup. The end-to-end test can employ either a live
network or an over-the-air test involving a communications monitor
that can transmit and receive at the appropriate frequencies. The
objective is to test the suspect modem in a known-good environment,
in which all other components are known to be operational.
If the modem has been determined to be faulty it should be returned to
the place of purchase for inspection and repair.
BM210012WT37
77
Copyright Wavenet Technology © November 2003
Testing ___________________________________________________ Boomer II User Manual & Integrator’s Guide
Copyright Wavenet Technology © November 2003
78
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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-.pdf
Please note that the Boomer II modem can also be configured to
approximate a Hayes protocol. See the document “BM2100ATWT04
Boomer-II AT Communications API” available from Wavenet for
further information.
Generic NCL (Native Mode)
Command SDUs (CMND, ASCII A)
Commands
Value
SEND
ASCII 1
Parameters
Send message.
READ_MSG
ASCII 2
Read queued message in RPM. True only if confirmed delivery mode
enabled.
CTL_EVENT
ASCII 3
GET_STATUS
ASCII 4
Sub-values and Descriptions
Event Report SDUs.
Control event.
Get RPM status/configuration.
R_CONFIG_BLOCK
ASCII A
Get RPM configuration block.
R_RF_BLOCK
ASCII A
Vendor-specific: Get RF status block.
R_STATUS_BLOCK
ASCII B
Get RPM status block.
R_PROD_ID
ASCII C
Get RPM product ID:
RF_RDLAP_9.6
RF protocol is RD-LAP 9600.
ASCII 0
RF_RDLAP_19.2
RF protocol is RD-LAP 9200.
ASCII 1
RF_MDC4800
RF protocol is MDC 4800.
ASCII 2
RF_DUAL
Dual RD-LAP 9.2/MDC4800.
ASCII 3
NCL_PRE1.2
NCL support is R1.0 or R1.1.
ASCII 0
NCL_1.2
NCL support is R1.2.
ASCII 2
R_SYSID
ASCII C
Vendor-specific: Get system ID of current RF system.
R_SW_VERSION
ASCII D
Get software version number.
R_RPM_ID
ASCII E
Get RPM address.
R_RF_BLOCK_SHORT
ASCII E
Vendor-specific: Get short form of RF status block.
ASCII F
Reserved.
R_MAX_DATA_SIZE
ASCII G
Get SDU data limit.
R_RPM_GID
ASCII H
Get RPM group IDs.
R_WAN_TYPE
ASCII I
Get WAN Type Code.
R_RF_VERSION
ASCII J
Get RF protocol version number.
R_VENDOR_ID
ASCII K
Get vendor information: VEND_MOTOROLA Vendor is Motorola
ASCII 0
ASCII
L..Z
Reserved.
ASCII a
Get mode of notification to the DTE for received SDUs.
R_RCV_MODE
BM210012WT37
Value
79
Copyright Wavenet Technology © November 2003
Appendix A - NCL INTERFACE ________________________________ Boomer II User Manual & Integrator’s Guide
Commands
SET_CNF
Value
Parameters
Value
Sub-values and Descriptions
R_RX_STATUS
ASCII b
Get receiver enable status.
R_TX_STATUS
ASCII c
Get transmitter enable status.
R_ANTENNA
ASCII d
Get antenna selection status.
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.
R_RADIO_CHANNEL
ASCII j
Get current radio channel.
R_CHAN_BLOCK
ASCII k
Get RPM RF channel status block.
R_RF_STATISTICS
ASCII l
Get RPM RF statistics block.
R_BAT_LEVEL
ASCII m
Get battery status.
ASCII n..x
Reserved.
R_DCHAN_TABLE
ASCII y
Read dynamic channel table.
R_CHAN_TABLE
ASCII z
Read static channel table.
ASCII 5
Set modem configuration.
S_RCV_MODE
ASCII A
Select the confirmed/unconfirmed Receive Data mode.
S_INACTIVITY_
TIMEOUT
ASCII A
Vendor-specific: Set read time for outbound packet.
S_TX_CONTROL
ASCII B
Enable/disable the transmitter.
S_RX_CONTROL
ASCII C
Enable/disable the radio.
S_FLOW_CONTROL
ASCII D
Select the flow control method:
FLOW_NONE
No flow control.
ASCII 0
FLOW_XONXOFF
XON/XOFF
ASCII 1
FLOW_RTSCTS
RTS/CTS
ASCII 2
S_RADIO_CHANNEL
ASCII E
Select the radio channel.
S_CUR_CNF
ASCII F
Save the modem configuration
R_DEF_CNF
ASCII G
Restore the modem configuration
R_STO_CNF
ASCII H
Read the modem configuration:
CNF_EVENT_
Event control flag
FLAGS
settings
ASCII 0
CNF_DELIVERY_
Outbound SDU del.
MODE
mode
CNF_RADIO_
Radio control
ASCII 2
S_RX_CONTROL
ASCII C
S_TX_CONTROL
ASCII B
ASCII 1
CONTROL settings:
S_POWER_SAVE
ASCII I
Set the Power Save mode.
S_ROAM_MODE
ASCII J
Set the roaming mode:
ROAM_
Set to manual.
ASCII 0
Set to automatic.
ASCII 1
MANUAL
ROAM_AUTO
Copyright Wavenet Technology © November 2003
80
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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.
ASCII 6
Reset RPM.
FLUSH_INBOUND
ASCII 1
Flush inbound message queue.
FLUSH_OUTBOUND
ASCII 2
Flush outbound message queue.
FLUSH_BOTH
ASCII 3
Flush inbound and outbound message queues.
RESET_WARM
ASCII 4
Warm start RPM.
RESET_TRANS
ASCII 5
Reset to Transparent Mode, if Transparent Mode is supported.
RESET_FULL
ASCII 6
Full reset of RPM.
RESET_NCL
ASCII 7
Reset NCL interpreter only.
RESET_OFF
ASCII 8
Power off the RPM.
RESET_DIAG
ASCII A
Vendor-specific: Cause DTE to enter diagnostic mode.
ASCII
A..Y, 7..9
Reserved.
ASCII Z
Vendor-specific command.
Event Report SDUs (EVENT, ASCII B)
Events
Value
Event Report
Enable
Bit
RCV_MSG_
ASCII A
RCV_MSG_DATA_
$10
Received message
data.
$08
Received message
notification. True only
if confirmed delivery
mode enabled.
$04
Physical-level
transmitter event.
DATA
RCV_MSG_
RX_EVENT
Value
BIT
ASCII B
NOTIFICATION
TX_EVENT
Parameters
RCV_MSG_
NOTIFY_BIT
ASCII C
ASCII D
TX_EVENT_BIT
RX_EVENT_BIT
Descriptions
TX_KEYED
ASCII 1
Transmitter keyed.
TX_DEKEYED
ASCII 2
Transmitter dekeyed.
$02
Physical-level receiver
event.
RX_IN_RANGE
ASCII 1
RF in range.
RX_OUT_OF_RANGE
ASCII 2
RF out of range.
RX_PWR_SAVE_
ASCII 3
Power saving enabled.
ASCII 4
Power saving disabled.
RX_ACTIVE
ASCII 5
Device in active state
on RF channel.
CHAN_DISALLOWED
ASCII 6
Device disallowed on
ENABLED
RX_PWR_SAVE_
DISABLED
BM210012WT37
81
Copyright Wavenet Technology © November 2003
Appendix A - 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. Cannot
ACK, transmitter
disabled. PDU
discarded.
Control event.
CONNECT
VENDOR
ASCII 1
HW_LOW_BATT
RCV_TX_DISABLED
CONTROL
Flash LED for
registration denial.
Hardware event.
HW_SELF_TEST
RCV_ERR
ASCII 7
ASCII 1
NCL connect between
RPM and DTE .
ASCII
H..Y, 1..9
Reserved.
ASCII Z
Vendor-specific event.
Response Status SDUs (RESP, ASCII C)
Responses
Value
SUCCESS
ASCII 1
Parameters
Description/Error Code
Successful.
IBQ_FLUSHED
XFAIL
Value
ASCII a
Error code. Pending SDUs in inbound queue flushed;
transmitter disabled. Used only if the RPM cannot support
message buffering while transmitter disabled.
ASCII 2
Command execution error. Note the following error codes:
NO_RESPONSE
ASCII A
No response from network.
NO_ACK
ASCII B
Negative ACK received.
HOST_DOWN
ASCII C
Host access is down.
NOT_REGISTERED
ASCII D
RPM not registered.
LOW_BATTERY
ASCII E
Low battery—cannot transmit.
IBQ_FULL
ASCII F
RPM inbound queue is full.
TX_DISABLED
ASCII G
Radio transmitter is disabled.
BUSY
ASCII H
Resource is unavailable.
NOT_AVAILABLE
ASCII I
Unimplemented services.
HW_ERROR
ASCII J
Generic error.
INVALID_MODE
ASCII K
Invalid mode of operation.
NO_MESSAGES
ASCII L
No outbound messages available.
MSGS_PENDING
ASCII M
Cannot execute command due to pending inbound messages.
SW_ERROR
ASCII N
Software error.
OUT_OF_RANGE
ASCII O
RF not in range.
PACKET_ERROR
ASCII Z
SDU data corruption. True only if confirmed delivery mode
enabled.
Copyright Wavenet Technology © November 2003
82
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - NCL INTERFACE
ASCII
P..Y, 1..9
SYNTAX
VENDOR
ASCII 3
ASCII Z
BM210012WT37
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.
83
Copyright Wavenet Technology © November 2003
Appendix A - 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.
Command Description
Ncl String
Get radio status
ZF?r
Get modem battery status
ZF?v
Get modem “on” time
ZF?t
Get saved modem configuration settings
ZF?u
Get modem serial number:
ZFts
Set modem configuration parameters, eg:
ZF^[2 Byte ID][2 byte Length][Val]
* Power save mode.
ZF^p\00\00\01[new mode (byte)]
* Select new active profile.
ZF^f\00\00\01[new profile (byte)]
* NCL receive message notify timer.
ZF^n\00\00\02[2 bytes time (msec)]
3. Generic “Set RPM
configuration” command
type 2.
Set modem configuration parameters, eg:
4. Generic “Get RPM
configuration” command.
Get modem configuration, eg:
* LED disabling.
ZF5F[1 Byte ID][Val]
ZF5F\45\00[dis/enabled (byte)]
ZF$[2 Byte ID]
* Power save mode.
ZF$p\00
* Get list of profiles, number of
ZF$f\00
profiles and currently selected active
profile.
ZF$n\00
* NCL receive message notify timer.
GET STATUS COMMANDS:
This command allows the DTE to request the current status and
configuration settings of certain aspects of the modem.
FORMAT:
WN_GET_STATUS Command Syntax (NCL string “ZF?…”):
CMND
Length
VENDOR
‘Z’
SDU Tag
‘F’
VEND_WAVENET
‘?’
Status
Request
WN_GET_STATUS
WN_GET_STATUS Response Syntax:
RESP
Length
SDU Tag
VENDOR
‘F’
‘1’
Response
data
...........
VEND_WAVENET
Copyright Wavenet Technology © November 2003
84
SUCCESS
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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”).
SUCCESS is followed by a block of status information as shown
below:
WN_GET_RADIO Response Format:
RSSI [2 bytes]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Reserved (ignore) [1 byte]
Current Frequency [4 bytes]
Current Channel [2 bytes]
Current Base Station ID [1 unsigned byte]
Where:
RSSI:
Two byte signed integer representing the
strength of the received signal from the
base station measured in dBm. A typical
value could be -90.
Current Frequency:
Four byte unsigned integer representing
the frequency of the inbound signal in Hz
for the channel the modem is currently
scanning or locked on to.
Current channel:
Unsigned word (2 bytes) representing
current channel.
Current Base Station ID:
Unsigned byte representing
current base station ID.
BM210012WT37
85
Copyright Wavenet Technology © November 2003
Appendix A - 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:
Battery Voltage (2 bytes)
Battery Percentage
Where:
Battery Voltage:
Two byte unsigned integer representing
the Voltage of the battery in mV.
Estimate of the remaining capacity of the
battery. This value ranges from 0 to 100
(unsigned byte).
Battery Percentage:
WN_GET_TIME:
“ZF?t”).
Get modem time information (NCL string
SUCCESS is followed by a block of status information in the format
shown below:
WN_GET_TIME Response Format:
Elapsed Time [4 bytes]
Elapsed Time is a four byte unsigned integer, which represents the
number of milliseconds, which have passed since the modem was last,
turned on or reset. It is accurate to within 50ms of when the last byte
of the request message was received by the modem.
Copyright Wavenet Technology © November 2003
86
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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:
LLI [4 bytes]
Serial Number [16 bytes]
.......
Reserved (ignore)
Home System Prefix
Home System ID
Home Area ID
5 Reserved bytes (ignore)
NCL Confirmation Mode
NCL Rx Control
NCL Tx Control
NCL Event Flags
Number of Group LLIs (n)
Group LLIs [4*n bytes]
Number of static channels (m)
Static channels [2*m bytes]
Reserved (ignore) [17 bytes]
.............
Where:
LLI:
Four byte unsigned integer (the standard
NCL command 4E also gives the LLI
number back).
Serial Number:
ASCII string containing the serial number
of the modem. Unused bytes are zeros.
The NCL command ZFts also gives the
serial number back.
NCL Confirmation Mode:
Default start-up state for the
confirmation mode of the NCL layer. It
is a zero for unconfirmed mode, or a one
for confirmed mode.
NCL Rx Control and NCL Tx Control:
Indicate the start-up state for the NCL
settings for RX_STATUS and
TX_STATUS respectively. A zero
BM210012WT37
87
Copyright Wavenet Technology © November 2003
Appendix A - 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.
The bits are as follow:
Bit 7 - Reserved (ignore)
Bit 6 - Rx_Error
Bit 5 - Control
Bit 4 - Rcv_Msg_Data
Bit 3 - Rcv_Msg_Notify
Bit 2 - Tx
Bit 1 - Rx
Bit 0 - Hwr
Number of Group LLIs: Number of Group LLI fields which
follow.
Group LLIs:
Each is a four byte unsigned integer. The
number of Group LLIs is given in the
previous field.
Number of Static Channels:
Number of channel fields
which follow.
Static Channels:
Each is a two byte unsigned integer. The
number of Static Channels is given in the
previous field.
WN_GET_SERIAL: Get modem serial number (NCL string “ZFts”).
SUCCESS is followed by a block of status information in the format
shown below:
WN_GET_SERIAL Response Format:
Modem serial number [10 bytes]
The modem serial number is unique to each modem and consists of
ASCII characters. The tenth character is typically a null termination
character.
Generic set RPM Configuration command type 1
(WN_SET_PARAM):
This command allows the DTE to set the configuration settings of
certain aspects of the modem.
Copyright Wavenet Technology © November 2003
88
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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. Please note that all multiple byte fields are stored MSB
first. Numbers prefixed with “0x” are expressed as hexadecimal.
“Byte” (optionally followed by a sequence number) is used to indicate
a single byte.
Parameter Number
A 16-bit field, which is unique to each
parameter, used to differentiate them.
A 16 bit field, which indicates the length
of the following parameter, in bytes.
The actual bytes set for the parameter.
The format is parameter specific.
Parameter Length
Parameter Contents
The Parameter Name is a label used to refer to particular parameters,
and is used as a definition for the parameter number.
WN_SET_PARAM:
Set Modem Configuration (NCL string
“ZF^[2 byte parameter number][2 Byte
parameter length][parameter block..]”).
Parameter name :
Parameter number :
BM210012WT37
WN_PWR_SAVE_MODE
0x7000 (“Byte1Byte2”)
89
(ASCII 0x70 = ‘p’)
Copyright Wavenet Technology © November 2003
Parameter
contents …
Appendix A - 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).
Parameter name:
Parameter number :
Parameter length :
Parameter contents:
WN_PROFILE
0x6600 (“Byte1Byte2”) (ASCII 0x66 = ‘f’)
0x0001 (“Byte3Byte4”)
One unsigned byte with the number of the new
active profile.
See the Network Profiles section on page 26 for
more information.
Note:
Parameter name:
Parameter number :
Parameter length :
Parameter contents:
Copyright Wavenet Technology © November 2003
WN_MSG_RX_NOTIF_TMR
0x6E00 (“Byte1Byte2”) (ASCII 0x6E = ‘n’)
0x0002 (“Byte3Byte4”)
One unsigned word (2 bytes) containing the
number of milliseconds between message
notifications to the Palm. The maximum setting is
65 seconds (65000 milliseconds).
90
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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.
Command Format:
CMND
Length
SDU Tag
VENDOR
‘Z’
‘F’
‘5’
‘F’
Parameter
ID
Parameter contents …
VEND_WAVENET
Response Syntax:
RESP
Length
SDU Tag
VENDOR
VEND_WAVENET
SUCCESS
OPERAND DESCRIPTIONS AND RESPONSES:
There is currently only one such “Set configuration - type 2” command.
Parameter ID:
Parameter contents:
WN_LEDS_OFF
16 bit (2 byte) field indicating a TRUE or
FALSE condition. TRUE (0x0001)
indicates the LEDs are disabled. FALSE
(0x0000) indicates normal LED
operation. The default is FALSE.
This command sets whether the modem’s LEDs are operational.
If they are disabled with this command, then they still flash on
powerup and powerdown, however they are inactive at all other
times. This mode allows the modem to conserve about a
milliamp of current, and is particularly suited for applications
where the modem LEDs are not visible to the user.
BM210012WT37
91
Copyright Wavenet Technology © November 2003
Appendix A - 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”).
FORMAT:
WN_GET_PARAM Command Syntax (NCL string “ZF$…”):
CMND
Length
SDU Tag
VENDOR
‘Z’
‘F’
VEND_WAVENET
‘$’
Parameter number
WN_GET_PARAM
WN_GET_PARAM Response Syntax:
CMND
Length
SDU Tag
VENDOR
‘Z’
‘F’
VEND_WAVENET
‘$’
Parameter
Length
Parameter
Value
SUCESS
OPERAND DESCRIPTIONS AND RESPONSES:
The various Vendor Parameter values that can be requested are listed
in the previous section (“Generic set RPM Configuration command”).
The responses to these commands obey the WN_GET_PARM response
syntax as shown above. The one exception is the “Get Active Profile”
command, which returns more than just the “active profile”:
Parameter Number
A 16-bit field, which is unique to each
parameter, used to differentiate them.
Parameter Length
A 16 bit field, which indicates the length
of the following parameter, in bytes.
Parameter Value
The actual value of the parameter. The
format is parameter specific.
WN_ PROFILE Get list of profiles from modem (NCL string
“ZF$f\00” with “\00” representing one byte with value of zero).
SUCCESS is followed by a block of information in the format shown
below:
Copyright Wavenet Technology © November 2003
92
BM210012WT37
Boomer II User Manual & Integrator’s Guide ________________________________ Appendix A - 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.
Active profile number: Unsigned byte giving the number (or index) of
the currently active profile.
Profile name:
Null terminated string of 24 bytes of length
(the string may be shorter than the 24 bytes as
long as it is followed immediately by the null
termination character). The 24 bytes do not
include the null termination character.
NCL Label Values
Please note the following additions/clarifications to the NCL Label
Values Table:
CMND
RESP
SUCCESS
VENDOR
VEND_MOTOROLA
VEND_WAVENET
ASCII 'A'
ASCII 'C'
ASCII '1'
ASCII 'Z'
ASCII '0'
ASCII 'F'
WN_GET_STATUS
ASCII '?'
WN_GET_RADIO
ASCII 'r '
WN_GET_BATT_VOLT ASCII 'v'
WN_GET_TIME
ASCII 't'
WN_GET_SETTINGS ASCII 'u'
WN_GET_SERIAL
ASCII ‘s’
WN_SET_PARAM
ASCII ‘^’
WN_GET_PARAM
ASCII ‘$’
WN_PWR_SAVE_MODE
0x7000
WN_PROFILE
0x6600
WN_MSG_RX_NOTIF_TMR
0x6E00
WN_CMD
ASCII '*'
WN_LEDS_OFF
0x45
BM210012WT37
93
(eg NCL command ZF?r)
(eg NCL command ZF?v)
(eg NCL command ZF?t)
(eg NCL command ZF?u)
(eg NCL command ZFts)
(eg NCL cmd ZF^\04\00\00\01\09)
(eg NCL commandS ZF$..)
(eg NCL cmd ZF$\70\00 = ZF$p\00)
(eg NCL cmd ZF$\66\00 = ZF$f\00)
(eg NCL cmd ZF$\6E\00 = ZF$n\00)
(eg NCL commands ZF*..)
(eg NCL cmd ZF5F\45\00\00)
Copyright Wavenet Technology © November 2003
Appendix A - NCL INTERFACE ________________________________ Boomer II User Manual & Integrator’s Guide
Copyright Wavenet Technology © November 2003
94
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
Appendix B – SDK NCL-API and Port Server
The Native Control Language Application Programmer's Interface
(NCL API) is the client component of the SDK. The NCL API
provides routines for sending and receiving data messages through the
DataTAC wireless network, using a radio packet modem (RPM). It also
allows the client application to control configuration parameters of the
RPM and to retrieve status information from the RPM.
There are two options provided for using the NCL API.
1. The multisession API uses an autonomous “port server” which
communicates with the modem via a serial port, and with
multiple Windows applications using message queues (provided
by MSMQ) . This allows multiple applications to share the use
of the modem. The “port server” application must be started
independently, before an application using the API attempts to
communicate with the modem.
2. The single session API communicates with the modem directly
through the serial port. It does not require the use of the
MSMQ service, but only one application can use the modem at
a time.
Both of these APIs share the same application interface (except the
single session API has one extra optional function VDDOpenPort).
The differences are only in the way the communication with the
modem occurs, and whether multiple applications can share the
modem.
The APIs are implemented as a DLL library written in C++ for
windows using Microsoft~ Visual C++ Version 6.0.
The APIs are supplied as Virtual Device Drivers (VDDs) for a PC
(Win 98 or better) or a Pocket PC (Win CE Version 3.0 or better).
Multisession API
Implementation
The Multisession NCL API is implemented as a DLL library of written
in C++ for windows using Microsoft~ Visual C++ Version 6.0.
The NCL API communicates with PC or Pocket PC applications based
on the following model. Multiple applications can access the RPM via
NCL encoded messages.
BM210012WT37
95
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Layer 6 (Presentation)
Layer 5 (Session)
Level 4 (Transport )
MSMQ
MSMQ IN 1
TX Queue
MSMQ IN N
Message Router & NCL Interpreter
Layer 3 (Network)
Serial Port Drivers
Layer 2 (Data)
)))Li k)
Layer 1 (Physical)
Serial Port to modem
Wavenet NCL API Model
Logical Architecture
The following table lists the required functionality for the API per
layer. The code forms a DLL, with only a subset of functions available
for third party developers.
LAYER NAME
CONTENT
FUNCTION
7.
APPLICATION
Application specific data.
Applications are to initialise a RX MSMQ (Microsoft
Message Queuing system) queue and open a session
with the VDD by passing the RX queue handler.
6.
PRESENTATION LAYER
Unused
5.
SESSION LAYER
Unused
4.
TRANSPORT LAYER
Unused
3.
NETWORK LAYER
MSMQ is run as a device driver on the Pocket PC
and is run from power up (i.e. Non-suspend mode).
The VDD will post events (RCV messages etc) to all
application RX queues enabled for that event.
Responses to application requests will be posted to
the calling application RX queue.
Router
The VDD process TX requests via a FIFO queue to
the NCL Interpreter. The Host base routing or Peerto-Peer routing SDU formatting is contained in the
NCL interpreter.
2.
DATA LINK LAYER
NCL Interpreter &
Extender port – Serial
Driver.
Copyright Wavenet Technology © November 2003
96
Application NCL API function requests are processed
via a FIFO queue. RPM responses or received data is
tagged and encoded for the router as required Also
the UART DLL that handles the extender port UART
to modem communications resides in the link layer
modules..
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
LAYER NAME
1.
PHYSICAL / BIT TRANSFER
LAYER
CONTENT
FUNCTION
Extender Port to RPM.
9600, 8, 1, N on serial port and a wakeup line.
Wavenet’s current NCL API protocol stack is implemented with the
hierarchical structure. All DLLs including MSMQ files are included in
the install cabinet files for the VDD.
Message Router
The PC or PPC loads MSMQ as a device driver. Applications using the
modem must open a session with VDD by calling ‘VDDOpen()’ which
will create a private Receive MSMQ queue for the instance of the
application (client). The name of this private queue will be sent to the
serial port server (VDD) along with an open session request. The port
server will in turn create a private MSMQ queue to receive data from
the client. All Modem Events and response messages to be
communicated between the VDD and the application will be via the
receive queues. Transmit function requests from the applications
(clients) are queued by the VDD and are processed as a FIFO buffer by
the NCL interpreter. On Wakeup the VDD will be activated, if any
applications receive queues are open the RX event will be posted to
those queues. If no receive queues are active, the VDD will buffer the
RX events and start up the registered on_wakeup applications. After
the applications have successfully opened a VDD session the VDD will
pass the RX events to those applications.
NCL Interpreter
The NCL Interpreter strips NCL API function calls from application
messages, queue the calls and execute the calls on a FIFO basis.
Received messages will be queued and matched against an appropriate
request (if not an event), and passed to the router with the
corresponding tags.
Link Layer
The RPM communicates with a PC via a standard communications port
and a user supplied RS232 to CMOS level device. For the Pocket PC
(PPC) the RPM communicates via the PPC extender port UART. The
PPC performs an auto detect and wakeup when an attached modem
receives some data and the PPC is in suspend mode.
Application Interface
Opening a Session
Applications are required to first open a session with the VDD by
calling the API function ‘VDDOpen()’. Singlesession applications can
also call ‘VDDOpenPort()’. All other API functions will return an
error until an open session with the VDD is established using one of
these calls.
BM210012WT37
97
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Multisession API:
If successful this operation will result in the
creation of two MSMQ queues for use by the
client. One MSMQ will be used to send
messages from the VDD to the client and the
other for messages from the client to the VDD.
Note that the client does not deal with MSMQ
queues directly because all operations are
wrapped in API calls. The Multisession API can
only use the VDDOpen call. The VDDOpenPort
function is not available.
Single session API:
If successful this operation will result in the
opening of the “com1” serial port if VDDOpen is
used, or the provided serial port if VDDOpenPort
is used.
Prototypes:
int VDDOpen(void)
int VDDOpenPort(char *cPortName)
[singlesession API only]
Description:
Opens a session with the VDD.
Input to VDDOpen:
None
Input to VDDOpenPort:
cPortName
Null terminated string, naming the com port to use.
For example, “COM2”, “COM11”
Output:
Return value = 0
Operation was successful
Return value ≠ 0
Operation failed. Value specifies the error type
Copyright Wavenet Technology © November 2003
98
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
Close Session
Applications can call this function to close its session with the VDD.
An application should call this function before it terminates if a session
was earlier established with the VDD. The reason for this in the
multisession API is to ensure that all created MSMQ queues for the
client are deleted. This will prevent irrelevant/outdated messages from
being posted to inactive MSMQ queues. In the singlesession API, this
call will close the serial port, allowing another application to use it.
Prototype:
int VDDClose(void);
Description:
Close a session with the VDD.
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.
Prototype:
int nclSendData(word *usSduTag, byte *szHostId, byte ucIdLen, byte
*ucData, int iDatLen, bool bResend);
Response:
The VDD will track the response with the Host ID and SDU tag will
post the response to the corresponding RX queue for that session. The
application is responsible for reading and processing the response on
the RX queue. By calling ‘nclReceiveData()’.
BM210012WT37
99
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Description:
Send application data to the radio host identified by the host ID.
Input:
UsSduTag
Pointer to a word where the SDU tag can be stored
SzHostId
Pointer to a buffer specifying the Host identity. The Host ID is
typically 3 bytes in length for DataTac systems. The NCL API will
truncate Host ID’s longer than NCL_MAX_UH_LEN (63) bytes in
length.
UcIdLen
Total length of the session ID
UcData
Pointer to the data to be sent
IDatLen
Length of the data to be sent
BResend
Resend flag must be set to false, except if the packet of data is
being re-sent due to a failure of the previous send. Setting the
flag to true prevents the possibility of receiving duplicate packets
at the server application. This flag cannot be used for resending
data prior to the previous packet.
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.
This applies to both event and response type data from the RPM. Note
this is the only way to obtain response data originating from the RPM
as a result of issuing commands to it by means of other API functions
described in this document. The return code of all API functions
issuing commands to the modem only provides feedback about the
posted command. It does not guarantee delivery to the RPM. It is thus
imperative for applications to use ‘nclReceiveData()’ to obtain
feedback directly from the RPM on commands sent to it. Responses to
commands are asynchronous meaning multiple commands can be
issued to the RPM before the application needs to look at all the
responses. This is the reason why every command provides the
application with a copy of the unique SDU tag generated for the
command. Every response message contains the same SDU tag of its
associated command. The VDD uses the SDU tag to route response
messages to the originating application (client). The
‘nclReceiveData()’ function provides the SDU tag of the response
message. Applications can use these tags to tie up responses with
previously sent commands. One notable exception exist when the SDU
tag is equal to 65535 (FFFF hexadecimal). Only event messages
Copyright Wavenet Technology © November 2003
100
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
contain an SDU tag equal to 65535. The received event/ response
messages will be represented as an array of bytes which must be typed
cast to a structure identified by returned structure ID.
The RCV_MSG_NOTIFICATION event will be handled by the VDD,
which will read the messages from the RPM and pass the messages to
all clients with open sessions.
Other Event types shall be posted to all clients with open sessions
registered for that event. If no applications are registered for that event
the event will be disabled in the modem.
Prototype:
int nclReceiveData(DWORD dwTimeOut, BYTE *ucStructId, WORD
*usSduTag, int *iBufLen, BYTE *ucBuf);
Description:
Receive messages from the RPM.
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.
UsSduTag
Pointer to a word where the SDU tag can be stored
IbufLen
Pointer to a integer specifying the total size of ucBuf.
UcBuf
Pointer to the buffer (of size iBufLen) where receive data can be
placed
Output:
BM210012WT37
Return value = 0
Operation was successful
Return value ≠ 0
Operation failed. Value specifies the error type
UcStructId
This value identifies the structure of the data in ucBuf. See the
following paragraphs for details.
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.
IbufLen
Size (in bytes) of the data in ucBuf. Note: Buffer lengths of 0 is
possible – rely solely on the return value in such cases
UcBuf
Pointer to buffer containing the received data
101
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
/*** Define types for retrieving data from the RPM ***/
typedef unsigned char
typedef unsigned short
BYTE;
WORD;
/*Parameter Structure IDs - Do not alter sequence*/
enum
NCLNone_ID = 0,
NCLEvent_ID,
NCLProdId_ID,
NCLVersion_ID,
NCLRpmId_ID,
NCLConfigBlock_ID,
NCLStatusBlock_ID,
NCLChanBlock_ID,
NCLGroupLlis_ID,
NCLChannelTable_ID,
NCLWaveSettings_ID,
NCLWaveRadio_ID,
NCLWaveGen_ID,
NCLByte_ID,
NCLByte2_ID,
NCLWord_ID,
NCLMsg_ID,
NCLRaw_ID
/*additional structure IDs to be added here including vendor specific types */
};
/* 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 structure */
typedef struct NCLConfigBlock
Copyright Wavenet Technology © November 2003
102
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
NCLProdId
NCLVersion
NCLRpmId
WORD
WORD
}NCLConfigBlock;
/* Status block structure */
typedef struct NCLStatusBlock
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
WORD
WORD
WORD
}NCLStatusBlock;
/* Channel block structure */
typedef struct NCLChanBlock
BYTE
WORD
BYTE
BYTE
BYTE
}NCLChanBlock;
prod_id;
sw_version;
rpm_id;
reserved;
max_data_size;
rx_status;
tx_status;
antenna;
radio_in_range;
flow_control;
rcv_mode;
event_states;
ob_msg_count;
ib_msg_count;
radio_channel;
radio_in_range;
radio_channel;
attribute;
protocol;
rssi;
#define MAX_GROUP_LLIS
#define LLI_BYTE_WIDTH
#define NCL_NUM_CHANNELS 64
/* 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_CHANNELS];
/* Vendor Spesific: Wavenet Get Settings*/
typedef struct NCLWaveSettings {
BYTE
LLI[4];
BYTE
SerNum[16];
} NCLWaveSettings;
/* Vendor Spesific: Wavenet Get Radio Settings*/
BM210012WT37
103
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
typedef struct NCLWaveRadio {
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
BYTE
} NCLWaveRadio;
rssi[2];
reserved1;
reserved2;
reserved3;
reserved4;
reserved5;
reserved6;
reserved7;
reserved8;
frequency[4];
channel[2];
base_id;
/* Vendor Spesific: Wavenet Generic*/
typedef struct NCLWaveGen {
BYTE
byte[100];
} NCLWaveGen;
/* NCL status information structure */
typedef union NCLStatus
NCLProdId
prod_id;
BYTE
vendor_id;
NCLVersion
sw_version;
NCLRpmId
rpm_id;
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
wave_set;
NCLWaveRadio
wave_radio;
NCLWaveGen
wave_generic;
}NCLStatus;
/* Event Type */
typedef struct NCLEventType
BYTE etype;
/* NCL_RCV_MSG_DATA
/* NCL_MSG_NOTIFICATION
/* NCL_TX_EVENT
/* NCL_RX_EVENT
/* NCL_HW_EVENT
Copyright Wavenet Technology © November 2003
104
'A'
‘B’
'C'
'D'
'E'
Received message data
*/
Received Message notification */
Transmitter event
*/
Receiver event
*/
Hardware event
*/
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
/* NCL_RCV_ERR_EVENT
/* NCL_CONTROL_EVENT
'F'
'G'
Unreceivable Message Event
Control Event
*/
*/
BYTE EventCode;
/* NCL_MSG_NOTIFICATION_LEN N- Number of buffered msgs to be read */
/* NCL_TX_EVENT_KEYED
‘1’
Transmitter keyed
*/
/* NCL_TX_EVENT_DEKEYED ‘2’
Transmitter dekeyed
*/
/* NCL_RX_EVENT_INRANGE ‘1’
RF in range
*/
/* NCL_RX_EVENT_OUTRANGE ‘2’
RF out of range
*/
/* NCL_RX_EVENT_PSENAB ‘3’
Power Save enabled
*/
/* NCL_RX_EVENT_PSDISAB ‘4’
Power Save disabled
*/
/* NCL_HW_EVENT_STEST
‘1’
Self Test Failed
*/
/* NCL_HW_EVENT_LBATT
‘2’
Low battery
*/
/* NCL_HW_EVENT_MFULL
‘3’
Memory Full
*/
/* NCL_HW_EVENT_BATOK
‘4’
Battery Level OK
*/
/* NCL_HW_EVENT_MEMOK ‘5’
Memory Ok
*/
/* NCL_HW_EVENT_MEMOK ‘6’
Device shutdown is imminent
*/
/* NCL_RCV_ERR_EVENT_RTD ‘1’
ACK required PDU received but TX
disabled */
/* NCL_CONTROL_EVENT_C ‘1’
RPM / DTE connected
*/
}NCLEventType;
/* RCV_MSG_Data */
#define NCL_MAX_DATA_SIZE
#define NCL_MAX_UH_LEN
63
2048
/* max length of user header */
typedef struct NCLMsg
BYTE
is_message; /* If FALSE, only len and buf components are valid. */
BYTE
sessionID[NCL_MAX_UH_LEN + 1]; /* NULL terminated */
BYTE
msg_type; /* Used by NCL_DATATAC_5000 networks */
WORD
len;
BYTE
buf[NCL_MAX_DATA_SIZE];
} NCLMsg;
/* End of 1 byte alignment */
#pragma pack()
Get RPM Status Information
The application can call this function to obtain status information about
the RPM. The following types of status information can be obtained:
Status Request (non vendor
specific)
Response Structure
Description
NCL_R_CONFIG_BLOCK
NCLConfigBlock
Get RPM configuration block
NCL_R_STATUS_BLOCK
NCLStatusBlock
Get RPM status block
NCL_R_PROD_ID
NCLProdId
Get RPM product ID
NCL_R_SW_VERSION
NCLVersion
Get software version number
NCL_R_RPM_ID
NCLRpmId
Get RPM address
NCL_R_RPM_VID
NCLStatus.rpm_vid[2]
Get RPM VID address (MDC)
NCL_R_MAX_DATA_SIZE
NCLStatus.max_data_size
Get SDU data limit
NCL_R_RCV_MODE
NCLStatus.rcv_mode
Get mode of notification to
DTE f
i d SDU
BM210012WT37
105
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Status Request (non vendor
specific)
Response Structure
Description
DTE for received SDUs.
NCL_R_RX_STATUS
NCLStatus.rx_status
Get receiver enable status
NCL_R_TX_STATUS
NCLStatus.tx_status
Get transmitter enable status
NCL_R_ANTENNA
NCLStatus.antenna
Get antenna selection status
NCL_R_RADIO_IN_RANGE
NCLStatus.radio_in_range
Get radio in range status
NCL_R_OB_MSG_COUNT
NCLStatus.ob_msg_count
Get count of outbound
messages queued
NCL_R_IB_MSG_COUNT
NCLStatus.ib_msg_count
Get count of inbound
NCL_R_FLOW_CONTROL
NCLStatus.flow_control
Get flow control status
NCL_R_EVENT_STATES
NCLStatus.event_states
Get current event reporting
(enable/disable) state
NCL_R_RADIO_CHANNEL
NCLStatus.radio_channel
Get current radio channel
NCL_R_CHAN_TABLE
NCLChannelTable
Read radio channel table
NCL_R_CHAN_BLOCK
NCLChanBlock
Read the channel block
NCL_R_BAT_LEVEL
NCLStatus.bat_level
Read the battery level
NCL_R_RPM_GID
NCLGroupLlis
Get RPM group IDs
NCL_R_VENDOR_ID
NCLStatus.vendor_id
Get vendor identification
NCL_R_DCHAN_TABLE
NCLChannelTable
Read the D-channel table
NCL_R_RF_STATISTICS
Specific to RF protocol used:
RD-LAP [F] or MDC [G]
Read the RF statistics
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);
Description:
Command the RPM to send the requested status information.
Input:
usSduTag
Pointer to a word where the SDU tag can be stored
ucVendor
Vendor identifier. Use:
NCL_NO_VEND = 0 if not vendor specific or
NCL_VEND_WAVENET = ’F’ for Wavenet Technology specific
Copyright Wavenet Technology © November 2003
106
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
requests
ucType
The type of status information to retrieve from the RPM (Used by
Vendor specific requests). Set to zero for non-vendor requests or
WN_GET_STATUS = ‘?’ for Wavenet Technology specific
requests
ucRequest
The requested status information, as listed in one of the
appropriate tables above, to retrieve from the RPM.
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.
The response is posted to the corresponding RX queue associated with
the VDD session ID. If the session ID is not recognized all active RX
queues will be posted the response.
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. There are
several different levels of RPM reset commands that may be issued to
the RPM, as listed below:
Reset Level
Description
NCL_RESET_INBOUND
Flush the Inbound queue
NCL_RESET_OUTBOUND
Flush the Outbound queue
NCL_RESET_BOTH
Flush both the Inbound and Outbound queues
NCL_RESET_WARM
Warm start: flush queues, default Native settings, remain in
Native mode
NCL_RESET_TRANS
Not Supported
NCL_RESET_FULL
Full reset: Power-on reset
NCL_RESET_NCL
Reset NCL interpreter
NCL_RESET_OFF
Power off the RPM
Prototype:
int nclResetRPM (word *usSduTag, byte ucResetLevel);
BM210012WT37
107
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Description:
Command the RPM to perform a specified level reset
Input:
usSduTag
Pointer to a word where the SDU tag can be stored
ucResetLevel
The level of the Reset as listed in the above table
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.
The response is posted to the corresponding RX queue associated with
the VDD session ID. If the session ID is not recognized all active RX
queues will be posted the response.
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. The API function
‘nclReceiveData()’ will return within the time-out period specified, so
applications will not be hung-up indefinitely.
Enable / Disable Events
The application can call this function to enable or disable individual
event types being reported by the RPM. By default, only the Receive
Message Data event is enabled (NCL_RCV_MSG_DATA). All other
event types for an application are disabled unless they have been
specifically enabled / disabled using this function. The
NCL_RCV_MSG_NOTIF event is handled by the VDD, which will
post the received messages to all active RX queues (that have
NCL_RCV_MSG_DATA enabled) using the NCLRXDataID structure
type.
Prototype:
int nclSetEvent (word *usSduTag, byte ucType, byte ucSetting);
Description:
Enable / Disable event reporting by the RPM for the specified event
type.
Copyright Wavenet Technology © November 2003
108
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
Input:
iSessionID
VDD session ID
usSduTag
Pointer to a word where the SDU tag can be stored
ucType
The type of event to enable/disable:
NCL_RCV_MSG_DATA (Received message data)
NCL_TX_EVENT (Physical-level transmitter event)
NCL_RX_EVENT (Physical-level receiver event)
NCL_HW_EVENT (Hardware event)
NCL_RCV_ERR (Un-receivable message event)
NCL_CONTROL (Control event)
NCL_VEND_EVENT (Vendor specific event)
ucSetting
NCL_DISABLE
NCL_ENABLE
(Disable event reporting)
(Enable event reporting)
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.
Get Error Description
The application can call this function to obtain a string representation
for a specified error code.
Error Code
Value
Description
NCL_ERR_NONE
No error has occurred
NCL_ERR_SESSION_IS_CLOSED
-1
NCL API: Session has not been opened
NCL_ERR_SESSION_IS_OPEN
-2
NCL API: Session is already open
NCL_ERR_ENCODE
-3
NCL API: NCL Frame encoding error
NCL_ERR_DECODE
-4
NCL API: NCL Frame decoding error
NCL_ERR_PARAM
-5
NCL API: Invalid parameter passed
NCL_ERR_TIMEOUT
-6
NCL API: Time-out elapsed waiting for response
NCL_ERR_MSMQ_OPEN
-7
NCL API: An error occurred opening a MSMQ
NCL_ERR_MSMQ_CLOSE
-8
NCL API: An error occurred closing a MSMQ
NCL_ERR_MSMQ_SEND
-9
NCL API: An error occurred sending a MSMQ
NCL_ERR_MSMQ_RECEIVE
-10
NCL API: An error occurred receiving a MSMQ
NCL_ERR_MSMQ_CREATE
-11
NCL API: An error occurred creating a MSMQ
NCL_ERR_MSMQ_DELETE
-12
NCL API: An error occurred deleting a MSMQ
NCL_ERR_MSMQ_NAME
-13
NCL API: An error occurred searching for a MSMQ
NCL_ERR_MAX_CLIENTS
-14
NCL API: Maximum number of supported clients
reached
BM210012WT37
109
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Error Code
Value
Description
NCL_ERR_INVALID
'b'
NCL Syntax error: Invalid options
NCL_ERR_TOO_LONG
'c'
NCL Syntax error: Data too long
NCL_ERR_ES_NAME
'd'
NCL Syntax error: Invalid name
NCL_ERR_NO_RESPONSE
'A'
Execution error: No response from network
NCL_ERR_NO_ACK
'B'
Execution error: Negative ACK received
NCL_ERR_HOST_DOWN
'C'
Execution error: Host down
NCL_ERR_NOT_REGISTERED
'D'
Execution error: RPM not registered
NCL_ERR_LOW_BATTERY
'E'
Execution error: Low battery - can't transmit
NCL_ERR_IBQ_FULL
'F'
Execution error: RPM inbound queue full
NCL_ERR_TX_DISABLED
'G'
Execution error: Radio transmitter disabled
NCL_ERR_BUSY
'H'
Execution error: Resource unavailable
NCL_ERR_NOT_AVAILABLE
'I'
Execution error: Unimplemented services
NCL_ERR_HW_ERROR
'J'
Execution error: Generic
NCL_ERR_INVALID_MODE
'K'
Execution error: Invalid mode of operation
NCL_ERR_NO_MESSAGES
'L'
Execution error: No outbound messages available
NCL_ERR_MSGS_PENDING
'M'
Execution error: Pending inbound messages
NCL_ERR_SW_ERROR
'N'
Execution error: Software error has been
encountered
NCL_ERR_OUT_OF_RANGE
'O’
Execution error: Cannot send data when out of
range
NCL_ERR_PACKET_ERROR
'Z'
Execution error: SDU data corruption detected
Error Not Listed
All other
values
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.
Output:
WCHAR *
Pointer to a NULL terminated wide character (Unicode) string
describing the error
Copyright Wavenet Technology © November 2003
110
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
Register Wakeup Application
By default the VDD is executed on wakeup. In addition an application
can register to be executed on wakeup via the VDD. On wakeup the
VDD will post any Received data to the current active queues. If there
are no active queues the VDD will execute the Registered applications.
Once an application has initiated a successful VDD session (i.e. via
‘VDDOpen ()’ ) the VDD will post the Received data to the
applications RX queue. A timeout (Wktm = 10 seconds) will be used to
hold the data for an application to initialize and commence a VDD
session before the data is discarded. The default application will be the
Modem Information application as supplied as a sample application
with the VDD.
Prototype:
int nclRegWakeupApp (WCHAR *usAppName, WORD
usWakeupReason);
Description:
Register an application for wakeup when specified events occur.
Input:
usAppName
usWakeupReason
Pointer to a buffer specifying the full path name (Null terminated)
of the application to execute on a wakeup.
Logical OR the required reasons for wakeup from the following
values (exclude unwanted reasons):
WAKE_MODEM_INSERTION – Wakeup application when
modem is attached
WAKE_MESSAGE_RECEIVED – Wakeup application when a
message is received but no client applications are running
Output:
Return value = 0
Operation was successful
Return value ≠ 0
Operation failed. Value specifies the error type
Deregister Wakeup Application
The application can call this function to deregister an application that
was previously registered to wakeup.
Prototype:
int nclDeregWakeupApp (WCHAR *usAppName);
BM210012WT37
111
Copyright Wavenet Technology © November 2003
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Description:
Deregister a wakeup application.
Input:
usAppName
Pointer to a buffer specifying the full path name (Null terminated)
of the application to execute on a wakeup.
Output:
Return value = 0
Operation was successful
Return value ≠ 0
Operation failed. Value specifies the error type
Switch RPM On/Off
The application can call this function to switch the RPM on or off.
Prototype:
int nclSwitchRPMPower (word usSetting);
Description:
Switch the RPM power to the desired setting.
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.
Prototype:
int nclSendGenericCommand (WORD *usSduTag, BYTE ucLength, BYTE
*ucParam);
Description:
Copyright Wavenet Technology © November 2003
112
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
Send an NCL command to the RPM of which the payload contents consist of
data from the specified buffer.
Input:
usSduTag
Pointer to a word where the SDU tag can be stored
ucLength
Pointer to a byte specifying the total size of ucParam.
ucParam
Pointer to the buffer (of size ucLength) containing the data to be
send to the RPM
Output:
Return value = 0
Operation was successful
Return value ≠ 0
Operation failed. Value specifies the error type
Get Software Version
The application can call this function obtain the software version of the
server application or the VDD DLL.
Prototype:
int VDDgetVersion (WORD* usVersion);
Description:
Obtain the software version of the specified software entity.
Input:
usVersion
Set this value to zero to request the VDD DLL version or to any
other value to request the server application version
Output:
BM210012WT37
Return value = 0
Operation was successful
Return value ≠ 0
Operation failed. Value specifies the error type
usVersion
The upper 8 bits contain the major version and the lower 8 bits
contain the minor software version if the return value is zero
113
Copyright Wavenet Technology © November 2003
Appendix C – SDK Sample Programs ___________________________ Boomer II User Manual & Integrator’s Guide
Appendix C – SDK Sample programs
Sample programs are provided with the SDK. The purpose of the
sample programs is to show how a complete working client server
application can be built using the SDK NCL API with the client
program.
The sample programs demonstrate how to write a simple application
that allows a wireless client to send data to a central server application
and receive responses back from the central server application. The
sample programs are not intended to be a functional application, but are
intended to serve as a guide to writing applications and can be used as a
basis for developing more complex applications.
The information given in this section is intended to supplement the
source code for the applications by providing a high-level overview of
the source code.
The client application is called ModemInfo and uses the NCL API to
interface to the DataTAC® network. The sample client program
retrieves the modem’s current status, and enables the user to send and
receive messages on the current channel the device is registered to.
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.
Copyright Wavenet Technology © November 2003
114
BM210012WT37
Boomer II User Manual & Integrator’s Guide ___________________________ Appendix C – SDK Sample Programs
The Status tab displays the modem’s current channel (if registered) and
its RSSI level. If the device is not registered, it will be in scan mode,
scanning the channels from the channel list in its current profile.
The Versions tab displays the devices LLI, serial number, hardware
platform and software version.
BM210012WT37
115
Copyright Wavenet Technology © November 2003
Appendix C – SDK Sample Programs ___________________________ Boomer II User Manual & Integrator’s Guide
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.
Copyright Wavenet Technology © November 2003
116
BM210012WT37
Boomer II User Manual & Integrator’s Guide ___________________________ Appendix C – SDK Sample Programs
BM210012WT37
117
Copyright Wavenet Technology © November 2003
Appendix D - Application Development __________________________ Boomer II User Manual & Integrator’s Guide
Appendix D - 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 host/terminal
and the wireless modem. In this step you must consider the
interactions with the wireless modem, as established by the
NCL 1.2 reference specification and the vendor specific
extensions.
The second step involves addressing message routing
information to identify the message destination within the
DataTAC network.
Use the following suggestions to help you develop wireless enabled
applications.
Use Power Save mode of operation to extend battery life and
operational time for the user. We recommend that the
application does not modify this mode dynamically.
Use the Confirmed mode of operation to perform the following
functions:
•
Check the SDU checksum for validity.
•
Re-read SDUs received in error.
•
Read past the last message in Confirmed mode to make
sure the device buffer is fully flushed. If the buffer is not
flushed, the last message is held, consuming valuable
buffer space.
Anticipate new NCL command, event, and response codes:
•
Perform exact matches on event and response codes.
•
Discard any unknown event type.
•
Map any unknown XFAIL code to be a NAK.
Use SDU tags to uniquely identify application-generated SDUs.
Anticipate the user will move between IN_RANGE and
OUT_OF_RANGE conditions. This means you need to
provide:
•
A user indicator that identifies the current operating
status.
•
Recovery mechanisms when application transactions
fail as a result of losing network contact.
Copyright Wavenet Technology © November 2003
118
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Appendix D - Application Development
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.
In application development, addressing this temporary or longer term
gap in coverage, even in midst of an application transaction, is
essential.
You can address this consideration by providing a transport level
protocol that can account for the following roaming related situations
when used with a DataTAC wire-less modem:
Inbound SDU failure
Outbound SDU failure
Loss of network contact
These situations are discussed in detail from page 121.
In this case, the transport level protocol must have components both
within the server and client application environment. This transport
level protocol can be provided using existing third party software for
DataTAC systems. Alternatively, you can develop a transport level
protocol with your application in mind.
Roaming Requirements
The roaming algorithms for the wireless modem are described as
follows:
Note: In each case, re-establishing network contact requires the
wireless modem to scan all likely channels and to handshake with the
network.
Send a quick (bounded) response to SDU transmit requests
When the wireless modem loses network contact, SDUs are returned
with an out-of-range failure code. In this case, the wireless modem also
indicates that it is out-of-range via an NCL event. When network
contact is re-established, the wireless modem indicates an in-range
event. The client application then resubmits any SDU last rejected with
an out-of-range response.
Acquire the channel quickly
All channels are scanned quickly, starting with the dynamic channel
list that contains the last used channel and its neighbours. (This list is
broadcast periodically by the network.) If you cannot establish network
contact using the dynamic channel list, the wireless modem scans
quickly using the pre-programmed, network-specific static channel list.
If network contact is not established using either list, this sequence is
repeated after a delay interval. See “Conserve battery life when out of
range” below.
BM210012WT37
119
Copyright Wavenet Technology © November 2003
Appendix D - Application Development __________________________ Boomer II User Manual & Integrator’s Guide
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. This delay time is reset to one second by
establishing a network connection or by power-cycling the device.
Re-establish network contact following inbound SDU failure (no
response) and poor RF RSSI or signal quality
Any wireless modem experiencing a no-response inbound SDU failure
and either with RSSI or quality below the exit threshold level must reestablish network contact. If unable to re-establish network contact, the
modem indicates an out-of-range event. When network contact is reestablished, the wireless modem indicates an in-range event. The client
application then resubmits any queued inbound SDU last rejected with
an out-of-range response.
Re-establish network contact due to loss of outbound channel
The wireless modem attempts to re-establishes network contact
following loss of the outbound channel. If unable to re-establish
network contact, the modem indicates an out-of-range event, and
procedures to re-establish network contact are initiated. When network
contact is re-established, the wireless modem indicates an in-range
event. The client application then resubmits any queued inbound SDU
last rejected with an out-of-range response.
Seek and locate the preferred alternate channel when the existing
channel degrades to a marginal level
When the existing RF channel degrades to a marginal (but still usable)
level, the device periodically listens to neighbouring channels to
determine whether a preferred alternate channel exists. This action
occurs when the device would otherwise be sleeping, to prevent impact
to the device’s synchronized-receive capability with the network.
To be considered, a preferred alternate channel must meet the
minimum channel entry criteria and be 5 dBm better than the current
channel. If located, a full channel acquisition is performed to verify all
other aspects of the alternate channel before registering to the new
channel. This preferred-channel pre-roam algorithm is performed at
intervals that increase exponentially and with identical reset conditions.
See “Conserve battery life when out-of-range” above.
Copyright Wavenet Technology © November 2003
120
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Appendix D - Application Development
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. The
SDU may have been delivered; the acknowledgment might have been
the element that could not be successfully returned to the originating
device.
Inbound SDU failure, host down
This failure indicates that the internal network connection to the
application host computer is currently unavailable. Because DataTAC
networks are designed with very high reliability, this failure is
extremely rare.
Inbound SDU failure, low battery
The SDU could not be delivered due to a low battery condition. When
a low battery condition is reached, the radio network connection is
dropped until the low battery condition is corrected. (This can be
addressed by replacing the battery or, if trickle charging is enabled,
waiting for a sufficient charge level to be reached.)
Inbound SDU failure, inbound queue full
This response indicates that the maximum number (2) of SDUs are
already queued within the wireless modem. Another SDU can be
submitted when the NCL response for one of the pending SDUs has
been returned.
Inbound SDU failure, out of range
The wireless modem has either lost network coverage or is in the
process of re-establishing network contact. See “Loss of Network
Contact” on the following page.
Inbound SDU failure, transmitter disabled
This SDU failure code indicates that the radio transmitter has been
disabled, under application control, within the wireless modem. The
transmitter must be enabled prior to submitting an SDU.
Note: This could be the result of transmitting a Receiver Disable
command to the wireless modem. This command requires both
Receiver Enable and Transmitter Enable commands to recover twoway communications.
BM210012WT37
121
Copyright Wavenet Technology © November 2003
Appendix D - Application Development __________________________ Boomer II User Manual & Integrator’s Guide
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).
Note: When developing a centralized server and distributed-mobile
client wireless enabled application, outbound SDU failure is primarily
a server application issue.
When this occurs, the client and server transport levels must
resynchronise to a common level before proceeding. Such an
understanding might require retransmission of the transaction or
retransmission of the transport confirmation.
Loss of Network Contact
When a wireless modem experiences a loss of network contact, queued
SDUs are returned with the out-of-range response code and with outof-range event indicated. A loss of contact can occur for the following
reasons:
Moving beyond network coverage
When the device moves beyond the network boundary, network contact
loss could occur for an extended period. Depending upon the user route
and network coverage area, this interval could extend from a few
minutes to several hours (or longer). Once network contact is reestablished, the client and server application must be resynchronised if
applications transactions have failed during the interval. After network
contact has been announced, further delays should be minimised, as the
user becomes acquainted with the coverage area.
Moving between areas of network coverage
Small movements within the area of network coverage can result in the
loss and reacquisition of network contact, as a result of RF penetration
difficulties with specific network topology and terrain. It might take
from a few tenths of a second to a few minutes to recognize the channel
has degraded to an unusable level, to qualify a new channel, and to reestablish network contact. Again, the client and server application must
be resynchronised if application transactions failed during this interval.
Acquiring improved network coverage
A channel might originally have been marginal, or might have
degraded from a good to a marginal level, or might be negatively
impacted by the presence of other objects that influence its capability
to send and receive data. Under such circumstances, the wireless
modem seeks a preferred alternate channel, as previously described.
Usually this situation does not produce notification of network contact
and reacquisition.
Copyright Wavenet Technology © November 2003
122
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Appendix D - Application Development
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. The time between these
events (the assertion of the LOWBAT LED and the loss of network
contact) is much influenced by the battery technology and the level of
transmit activity within the wireless modem. A relatively inactive
device provides more warning time than an active device. Also, an
alkaline battery provides more warning than a NiCad battery.
Low buffers
If outbound SDUs remain unread within the wireless modem, its
outbound buffers are eventually filled. When this occurs, network
contact is dropped. Network contact is re-established when the internal
buffer pool within the wireless modem reaches a usable level, as a
result of SDU reads by the application. This situation never occurs
when the client application reads continuously to clear the wireless
modem of received outbound SDUs.
Receiver disabled
The client application can disable the wireless modem transceiver by
using the Receiver Disable NCL command. When this occurs, network
contact is dropped and the radio is turned off. Network contact is reestablished when the application issues the Receiver Enable, then the
Transmitter Enable NCL commands.
Power Management
The following modem power management options can be included in
an application to maximize battery life:
Power Save Mode
The wireless modem defaults to Power Save mode when turned on if
the network supports the Power Save protocol. If you are concerned
about latency of unsolicited outbound messages, you can turn off the
Power Save mode, but at the expense of consuming more battery
power. For details, refer to the NCL 1.2 command
S_POWER_SAVE_MODE. See “Battery Life Considerations” and
“Power Save Protocol” on the following page.
Dynamically modifying the Power Save mode of the device is not
recommended.
On/Off upon User Demand
To extend battery life, design the application to switch the modem on
and off as the usage need arises. This method is especially effective for
session-based, user-initiated applications.
BM210012WT37
123
Copyright Wavenet Technology © November 2003
Appendix D - Application Development __________________________ Boomer II User Manual & Integrator’s Guide
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.
Battery Life Considerations
In addition to specific power management options, some application
design decisions greatly affect battery life, as follows:
User traffic, amount and frequency
Commercially available compression techniques can significantly
reduce traffic volume, which improves device battery life and reduces
network usage costs. Power Save mode batches outbound traffic at a
periodicity equal to the network-defined Power Save protocol frame
size.
Data compression
Improve battery life by reducing and compressing the broad-cast
application data. Network usage costs can also be significantly reduced
as a result.
Power Save Protocol
The following points describe unique operational characteristics of
devices that are compliant with the Power Save protocol when
operating on a network, as compared to those that are not. Specific
Power Save timing parameters can vary by network, based on how the
network operator sets up Power Save protocol parameters.
Under Power Save protocol, unsolicited outbound traffic to a nonawake device is delayed. The worst case delay until the first transmit
opportunity is 128 seconds under DataTAC 4000 networks and 64
seconds under DataTAC 5000 networks. The average delay until the
next delivery opportunity is one half of the worst case time, given the
current network and device configuration.
In DataTAC 4000 systems, initial unsolicited outbound transmission
attempts are actually “ping” messages used to locate the device.
In DataTAC 5000 systems, unsolicited outbound messages (or
messages that have missed the previous transmit opportunity) are
delivered in the “root” (that is, home) window for the recipient device.
Once the device is thus awakened, it remains awake for about n
seconds after each message or ACK transmission from the device.
During the wake time the network delivers messages to the device as it
would to a device that is non-compliant with the Power Save protocol.
(Default n = 20 seconds for DataTAC 4000 networks and 8 seconds for
DataTAC 5000 networks.)
Roaming and location update reporting to the network happens more
slowly because the Power Save protocol device takes longer to respond
to changes in the RF environment. The infrequent worst case latency in
responding to external stimuli (resulting in either a location update or
Copyright Wavenet Technology © November 2003
124
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Appendix D - Application Development
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.
Limited Data Capacity on Radio Frequency Channels
The channels available to wireless modems are narrow-band and have
limited information carrying capacity (bandwidth) when compared to
traditional wire line communications. Additional capacity can be
gained only by increasing the number of channels, improving the
hardware technology, or by developing more efficient applications. As
a result of all these limitations, it is not surprising that wireless
networks are often more expensive to operate on a per-packet basis
than wire line Wide Area Networks (WAN). To address this concern,
the NCL has been designed to provide the most efficient way of using
the limited channel bandwidth.
Message Delivery Cannot Be Guaranteed
Because a wireless device can roam without restriction, it can exit the
network RF coverage area, leaving it unable to receive or successfully
transmit messages. When a device is outside the coverage area, the
applications are informed of failed inbound delivery. The application is
required to take appropriate recovery action.
Variation in Message Transit Times Across the Network
The time interval messages transit the network is affected by the RF
protocol, the message load on the network, and the length of a
message. These variations might need to be taken into account by the
application.
The following sections address some of these shortcomings in more
detail.
Application Efficiency
One goal of application development is to provide the required
functionality with the least amount of messaging. The consideration
here is to minimize the number of interactions in an information
exchange. Doing so addresses the limited data capacity and increased
costs of wireless messaging. In addition, the pricing structure of
network operators encourages efficient application design. In fact,
applications can be designed to use data compression or to apply
techniques that send only data fields that change between transactions.
Large Message Transfer
Message size is a key factor affecting response times in wireless data
systems. To efficiently accommodate typical data applications, the
BM210012WT37
125
Copyright Wavenet Technology © November 2003
Appendix D - Application Development __________________________ Boomer II User Manual & Integrator’s Guide
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. For MDC
4800 operation on DataTAC 4000 systems, the segmentation size is
256 bytes.
For example, a 600-byte user message or service data unit (SDU)
results in the delivery of two packets, or protocol data units (PDU), that
are reassembled in the wireless device. Each PDU requires a Radio
Data-Link Access Procedure (RD-LAP) acknowledgment from the
device, which takes a few seconds to complete. The fewer Plus in a
message, the shorter the delivery time. If messages larger than 2 kB are
to be sent across the system, the host and wireless device application
must provide the segmentation and reconstruction functions.
Message Transit Time
The time required for an inbound or outbound message to travel across
the network is primarily a function of the queuing delays associated
with each product in the network infrastructure and the message load
on the system. As system traffic builds, queuing delays increase for
outbound traffic, while the average time to access the inbound channel
increases, resulting in longer inbound message transit times.
Additional delays are encountered when the wireless terminal is in the
process of roaming from one cell on one radio channel to a cell on
another radio channel. If the cells are controlled by the same cell
controller, the delay time is quite short. The delay time can increase if
the cells are controlled by different cell controllers on different sub
networks.
For a DataTAC 5000 fixed-end system operating at full rated capacity,
the mean transit delay between a network host and a wireless device is
typically no more than four seconds.
The application developer must develop operational scenarios to
accommodate the variable transit time in the application design.
Copyright Wavenet Technology © November 2003
126
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________ Appendix D - Application Development
BM210012WT37
127
Copyright Wavenet Technology © November 2003
Appendix E – Message Routing and Migration_____________________ Boomer II User Manual & Integrator’s Guide
Appendix E - Message Routing and Migration
This section provides a brief overview to message routing across the
various releases of DataTAC® systems. As the developer and user
communities become more international in scope, successful
applications will be distinguished by their portability across existing
DataTAC networks.
Message Routing
Three versions of DataTAC systems are in operation worldwide, as
noted by where they are currently implemented:
DataTAC 4000 systems (North America)
DataTAC 5000 systems (Asia-Pacific and Middle East)
DataTAC 6000 systems (Europe)
The architectures of the three systems are basically alike. Although
they support different link layer protocols, the systems the systems
differ mainly in their message header syntax.
The distinction between host communications and peer-to-peer
messaging is also important. Separate DataTAC protocols support each
of these application models. The primary host communications mode is
Standard Context Routing (SCR), also known as fleet mode. Another
application mode is DataTAC Messaging (DM), which handles
messaging among terminals (subscriber units).
SCR and DM are the common sets of rules that describe how to format
message headers on DataTAC systems. Although the header format
differs slightly among DataTAC 4000, 5000, and 6000 systems, the
functional concepts of operation are the same. The exact SCR and DM
syntax for each system is available in their separate Host Application
Programmer’s Manuals.
Note: In this section “host” refers to the network fixed host.
“Terminal” refers to a subscriber device.
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.
Not all link layer protocols 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.25 is a popular choice for
developers looking for a worldwide connectivity solution.
Other supported protocols include:
DataTAC 4000 system
X.25, TCP/IP, LU6.2, leased line,
dial-up, RF-Loopback
DataTAC 5000 system
X.25, TCP/IP, SLIP
DataTAC 6000 system
X.25
Copyright Wavenet Technology © November 2003
128
BM210012WT37
Boomer II User Manual & Integrator’s Guide _____________________Appendix E – 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.
When a terminal sends a message to the host, the message must contain
a header that includes the sending terminal ID. This enables the host to
identify which terminal sent the message and which terminal the host is
to poll.
Motient
Message Switch
Motient Base
Matrix Switch
DataTAC System Architectures
Other header fields provide the host with options for instructing the
network on handling undeliverable messages. For example, the host
can ask the network to:
Provide a delivery status of messages.
Hold messages on the network for a later delivery.
Discard messages.
This header and instruction information is the basis of the SCR
protocol.
BM210012WT37
129
Copyright Wavenet Technology © November 2003
Appendix E – Message Routing and Migration_____________________ Boomer II User Manual & Integrator’s Guide
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 syntax.
Peer-to-peer communications uses two types of messages:
Generate (originator-to-network)
Receive (network-to-destination)
Each message type must include its own type of header. Within each
system, each type of header has small differences in syntax.
Other Development Issues
Localizing and testing your applications are not issues related
specifically to application migration. The following comments are
provided as a helpful reminder only.
Localizing an Application
Whether you are preparing your application for sale internationally or
developing it internally for an international company, consider
designing in international characteristics from the beginning, such as
character encoding, language enabling, and special text formatting.
While such an effort can take longer up front, any eventual re-porting
of the application will be much easier to manage.
Character Encoding
If your application supports languages that use Latin-based characters
(for example, English, Spanish, and German), design your application
for compatibility with 7-bit ASCII/ISO 646 and Latin 1/ISO 8859-1, 8bit display fonts.
If your application support dialects of non-Latin languages, such as
Chinese, Japanese, Korean, or Thai, design your application to work
with Unicode or another 16-bit character encoding standard. In
addition, provide your application with flexible keyboard mapping.
Language Enabling
Isolate all translatable strings, icons, and menus from your program.
Then the greater part of a localization effort will be translation, rather
than re-engineering. Allow for expansion of text strings during
localization. Most translations are longer than the original. Allow your
program to accept variable-length strings or use the international
language capabilities inherent in the application environment, such as
Windows 2000, Windows 95, Windows NT, or Windows CE.
Special Text Formatting
The display of dates, numbers, and monetary values varies among
locales. Support for these differences may be provided by your
Copyright Wavenet Technology © November 2003
130
BM210012WT37
Boomer II User Manual & Integrator’s Guide _____________________Appendix E – Message Routing and Migration
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.
Testing an Application
Virtually all public network operators have some testing or certification
procedure available to help ensure that your new applications behave
appropriately when brought onto the network. Many systems also have
test nodes, which allow program testing without risk of interrupting the
public network. Because each operator’s procedures and requirements
differ, check with the operator of your target network regarding their
individual certification procedure.
With the proper documentation, writing an application that will operate
on a wireless network anywhere in the world is not difficult. You don’t
have to develop an application on site in the region where it will
operate. For example, if your local and target networks are the same,
the logistics associated with testing the application are fairly minimal.
Testing an application for a distant target network requires a bit more
planning, since the network is not directly accessible from your
development site. In this case, two approaches are worth considering:
If your application is designed for a DataTAC network in
another country and your local network uses the same version
of DataTAC system as the target network, sign up with your
local network operator for service during development, test, and
support. When the application is complete, it is likely that the
target network operator will require validation or certification
tests. After having used your local network for development
tests, validation testing will probably be a straightforward
process.
If your local network is other than the target network, you
might still want to develop a local version of the application to
test the logic and performance of your program in a controlled
environment. (Be sure to get advanced approval from the local
operator to run your test version without it being validated.) In
this case, the target network will not be tested directly and more
verification testing will be required.
BM210012WT37
131
Copyright Wavenet Technology © November 2003
APPENDIX F – Guide to Desense ______________________________ Boomer II User Manual & Integrator’s Guide
Appendix F – Guide to 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/terminal, such as RF performance and inter-operability with the
host/terminal.
Specifically, this sections describes the following:
The term “desense”
Preferred test procedures
Acceptable levels of electromagnetic interference (EMI)
Approaches to solving desense problems
Pertinent radio and antenna issues
Note: This section considers, but does not attempt to resolve these
technical issues for a particular platform. That is beyond the scope of
this guide.
Receiver desensitisation occurs when an unwanted signal is present at
the radio receive frequency. The signal is usually the result of harmonic
energy emanating from a high frequency, non-sinusoidal source. This
noise desensitises or lowers the sensitivity threshold of the receiver.
The radio cannot differentiate between wanted and unwanted signals.
In frequency-modulated systems, the radio receiver can capture the
strongest signal present. If wanted and unwanted signals are present,
and there is not a significant difference in level, the unwanted signal
can overtake the receiver, effectively blocking the wanted signal see
the following diagram.
Wanted and Unwanted Signal Levels
Amplitude
Wanted Signal Level
Unwanted Signal Level
Fc
Frequency
Fc = Radio Receiver Channel Frequency
Copyright Wavenet Technology © November 2003
132
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________________ APPENDIX F – Guide to Desense
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). This means an interference signal that is more than
10dB below the wanted signal has little impact on the data receiver’s
data recovery. Any interfering source above this level creates desense,
reducing the radio’s sensitivity for data reception. For every one dB
above the threshold level, one dB of desense is created.
Noise Sources
CPU clocks, address and data buses, LCD refresh, switching power
supplies, and peripheral drivers are the primary contributors of EMI.
The frequencies of these emissions are often unstable. One reason for
this instability is that high stability clock sources are not a requirement
in host/terminal designs.
The frequency of sources drifts as a function of temperature, time, and
aging. Other sources by nature move within the frequency spectrum as
a function of time. The edges of clock signals create detectable
harmonics well into the 1GHz band. This presents a challenge in
measuring the effects of the emission, as one must first determine
where the emission exists in the frequency spectrum.
Noise from the host/terminal can conduct through the
electrical/mechanical interface or radiate electromagnetic fields that are
received by the modem antenna and impact the modem. The Boomer-II
OEM modem is specifically designed to minimize conducted noise.
Radiated electromagnetic fields emanating from the internal circuitry
are incident on the modem antenna. These fields then are converted to
noise power by the antenna and are incident on the receiver. The
physical interface signalling connection has less impact on the receiver
performance and can be electrically decoupled using passive
components.
Receiver Susceptibilities
The receiver is susceptible to being desensed within the channel
bandwidth and at intermediate frequencies used for down conversion.
Excessive noise on power supply pins can also create sensitivity
problems.
Measurement Techniques
Desense can be measured in one of the following ways:
Indirectly by recording the emission level from the
host/terminal and then calculating the effect on the modem.
BM210012WT37
133
Copyright Wavenet Technology © November 2003
APPENDIX F – Guide to Desense ______________________________ Boomer II User Manual & Integrator’s Guide
Directly by using packet error rate testing off air.
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. Bear in mind that some assumptions have to be made to
extrapolate the results and convert them to desense figures. Of course,
these assumptions can create some error in the prediction.
Alternate Measurement Method
Wavenet can performed desense testing on an integrated host/terminal
using a special facility. The best alternate methods for determining the
desense is to measure the signal the receiver port sees by using a
spectrum analyser (see below).
Measurement Antenna
LNA
(Minicircuits ZFL-1000GH)
Unit under Test
Coaxial connection to
measurement antenna
Spectrum Analyser Setup
Using a spectrum analyser with an input impedance of 50 W, connect
the antenna of the product under test to the analyser. If an antenna is
currently not developed, use a portable dipole antenna as a
measurement antenna.
The measurement apparatus is capable of measuring signals as low as 120dBm. A preamplifier is required to allow the spectrum analyser to
achieve these levels. Use the analyser’s smallest possible resolution
bandwidth, typically 1kHz, to improve the dynamic range of the
measurement.
If the input impedance of the analyser is the same as that of the radio
receiver, and the antenna, you can measure the noise to which the
receiver will be subjected. The gain on the LNA will make low-level
noise more visible. Ensure that the spectrum analyser’s input is not
over driven by other RF signals, such as FM radio stations. Any spikes
that appear might cause desense problems.
Copyright Wavenet Technology © November 2003
134
BM210012WT37
Spectrum
Analyser
Boomer II User Manual & Integrator’s Guide ______________________________ APPENDIX F – Guide to Desense
The indirect method cannot account for characteristics of the data
protocol and is less effective. Also, the bandwidth of the noise source is
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.
This method is useful when connection of the wireless card is not yet
facilitated by the platform. This measurement could be performed
without the wireless card present. This method determines the
magnitude of the emissions, without extensive test facility
requirements.
Methods of Controlling Emissions
Preferred methods of controlling emissions observe that the emissions
must be contained to a level 40dB less than the FCC Part 15
requirements. For WAN (Wide Area Network) products, the accepted
method of achieving this is to shield.
Through past experience, it has become evident that standard
techniques used to achieve FCC certification are not enough to satisfy
wireless communications. Engineering teams logically attempt an array
of decoupling, partial shielding, and PCB layout methods, which
produce incremental improvements, but do not achieve the emission
control requirements. Hybrid methods of shielding and source
reduction are often a good approach.
Important: Unless the host/terminal is already close to the goals set
out in this document, source reduction efforts may only drive up the
direct materials cost of the product and not increase return on that
investment.
If a compromise is chosen where the target levels are not the goal,
standard EMI techniques can be of value. For narrowband emissions,
some form of clock frequency “pulling” or control can be
implemented.
Shielding Approach
The mechanical design of the host/terminal must allow the EMC
engineers to create a Faraday Box shield design. This is an electrically
continuous shielded enclosure. If designed properly, such an enclosure
easily attenuates radiated signals from the host/terminal.
The shield approach appears to be a big step at first. The advantage is
that the shield will minimise the possible redesign required of the
host/terminal PCB platform and circuitry.
For a thorough discussion of shielded enclosure design, an excellent
reference is Electromagnetic Compatibility: Principles and
Applications by David A Weston. The publisher is Marcel Dekker, Inc.
BM210012WT37
135
Copyright Wavenet Technology © November 2003
APPENDIX F – Guide to Desense ______________________________ Boomer II User Manual & Integrator’s Guide
270 Madison Avenue, New York, NY 10016. Any well written text on
EMI control should cover the design of shielded enclosures.
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. This would apply to keyboard and display
apertures in the enclosure. Testing of aperture radiation at the
frequencies of interest may prove larger apertures are
acceptable to the particular scenario.
Benefits of the Shielding Approach
Emissions reduction can be achieved using shielding source reduction
techniques, such as decoupling, or PCB layout and grounding, or a
combination of the two. Once a shield is in place, any revisions to
product circuitry have no effect on emissions levels. If a circuit level
approach is used to control the emissions, a change in circuitry can
bring a new unknown to the emissions performance.
Alternate EMI Reduction Methods
Although shielding is the brute-force method of reducing emission
levels, other methods are available, such as:
PCB layout modification using ground layers adjacent to high
speed layers
Capacitive or filter decoupling
Redistribution of module interconnects
Clock Pulling
Clock Pulling
Clock pulling is effective when the emission sources are narrowband.
To implement clock pulling, a method must be devised for the modem
to tell the host/terminal it is having difficulty receiving. Devising such
a method is admittedly very difficult. The host/terminal provides
“pulling” of its internal emission source, which is identified as a
potential problem.
If this source is the cause of the interference, the pulling or slight shift
of the source frequency moves the harmonic energy out of the receive
channel. This is an inexpensive way of solving the problem, as no
special shielding or decoupling is required.
The limitations of the clock pulling method are:
Computing devices have many more than one source
Copyright Wavenet Technology © November 2003
136
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________________ APPENDIX F – Guide to Desense
Each source must be identified and controlled. This
identification is at times difficult.
The host/terminal and modem must communicate the problem
at hand to attempt to correct it. This capability is not supported
by the Boomer II OEM modem.
Fs
Fss
Fh
Fhs
Fc
Interference source fundamental frequency
Shifted source fundamental frequency
Interference source harmonic
Interference source harmonic shifted
Channel frequency
Amplitude
Fs
Fss
Fh
Fc
Fhs
Pulling the Harmonic away from the Channel Frequency
RF Network Issues
Each RF network has its own requirements for the subscriber device.
Most networks implement a coverage equalization scheme. This
consists of configuring the infrastructure sites such that their RF power
output is equal to that of the subscriber device.
Since most portable devices are battery operated, the transmitter power
of the portable units is relatively low. To compensate for this, the base
site transmitter power is decreased to a level equal to that of the
portable. The base site has a much larger and reliable power source,
and is capable of putting out more power. This would help overcome
desense problems that the portable unit incurs. Most network managers
prefer not to increase their site power because of ERP licence
limitations and cell overlap issues.
Network operators must consider ambient noise levels when designing
their coverage plans. Once the wireless modem and host/terminal are
engineered not to “self-desense”, other machines in the user’s
environment can still impact radio performance. These machines are
not usually within close proximity of the wireless modem antenna, and
have less effect. An FCC Class B radiator can impact the wireless
BM210012WT37
137
Copyright Wavenet Technology © November 2003
Freq.
APPENDIX F – Guide to Desense ______________________________ Boomer II User Manual & Integrator’s Guide
device if it is within 30 meters of the device, assuming that an emission
exists at the channel frequency of the radio.
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. These protocols can correct
problems from intermittent noise sources by retrying during a time slot
that does not coincide with noise source interference.
At a certain point, desensitising a wireless modem receiver creates
unacceptable coverage in the network. This usually is in the 10dB
range, though it can vary with networks.
The integrator should consult the technical staff at their target network
for any minimum RF desense performance levels and related
measurement methods that may be required for the device to be
accepted for customer use on that network.
Antenna
The Boomer II OEM modem is not equipped with an on-board antenna
and one must be provided externally in the host/terminal.
Field Strengths from the Antenna
Field strengths from the wireless modem transmitter can reach as high
as 100 V/M for WAN products. Harden the host/terminal to withstand
these levels. LCD displays and switching power supplies are
particularly susceptible to RF. Capacitive decoupling of sensitive areas
is required. Decouple the reference voltage points on power supplies,
reset lines on processors, and keyboard scanning circuitry.
Antenna Interactions
There are two interactions that can impact the performance of the
antenna. The user, by placing a hand near the antenna can detune the
antenna and absorb energy. Accordingly, the antenna must be
positioned such that interaction between the user and the card is
minimized.
The host/terminal might also interact with the antenna. This is
particularly true for WAN modems, which have higher output power.
An imaginary sphere of real estate should be provided for the antenna
to function. Cabling for other peripherals must not interfere with this
region.
Desense Summary
Desense considerations fall into two categories when using a wireless
device and computer as a system:
The impact of the host/terminal EMI on system performance
Copyright Wavenet Technology © November 2003
138
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________________ APPENDIX F – Guide to Desense
The impact of the RF fields from the wireless device transmitter
on host/terminal operation
The latter consideration is not a significant problem. If RFI is assessed
properly, it is usually corrected with little effort and cost.
Because of the need for system coverage, the host/terminal EMI
interaction with the radio receiver can be a significant and often elusive
problem to characterize and correct. Most host/terminal devices 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. These goals are not set arbitrarily to improve product
performance, but to maintain the RF performance the networks demand
and the radios are designed to deliver.
Since each product is unique. The level of noise is very difficult to
predict, as is the amount of effort needed to control it. Measuring the
product in an early engineering phase is key to managing the situation.
BM210012WT37
139
Copyright Wavenet Technology © November 2003
APPENDIX G - Numeric Conversion Chart _______________________ Boomer II User Manual & Integrator’s Guide
Appendix G - 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
00100010
00100011
00100100
00100101
00100110
00100111
00101000
00101001
00101010
00101011
00101100
00101101
00101110
00101111
00110000
00110001
00110010
00110011
00110100
00110101
00110110
00110111
00111000
00111001
00111010
00111011
00111100
00111101
00111110
00111111
Oct
000
001
002
003
004
005
006
007
010
011
012
013
014
015
016
017
020
021
022
023
024
025
026
027
030
031
032
033
034
035
036
037
040
041
042
043
044
045
046
047
050
051
052
053
054
055
056
057
060
061
062
063
064
065
066
067
070
071
072
073
074
075
076
077
Dec
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Hex
00
01
02
03
04
05
06
07
08
09
0A
0B
0C
0D
0E
0F
10
11
12
13
14
15
16
17
18
19
1A
1B
1C
1D
1E
1F
20
21
22
23
24
25
26
27
28
29
2A
2B
2C
2D
2E
2F
30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
3F
CS
CS
CS
CS
CS
NX
NX
NX
NX
NX
NX
NX
NX
NX
NX
ASCII
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
SP
Definition
Null, or all zeros
Start of Heading
Start of Text
End of Text
End of Transmission
Enquiry
Acknowledge
Bell
Backspace
Horizontal Tab
Line Feed
Vertical Tab
Form Feed
Carriage Return
Shift Out
Shift In
Data Link Escape
Device Control 1 (XON)
Device Control 2
Device Control 3 (XOFF)
Device Control 4
Negative Acknowledge
Synchronous Idle
End Transmission Block
Cancel
End of Medium
Substitute
Escape
File Separator
Group Separator
Record Separator
Unit Separator
Space
Copyright Wavenet Technology © November 2003
140
Binary
01000000
01000001
01000010
01000011
01000100
01000101
01000110
01000111
01001000
01001001
01001010
01001011
01001100
01001101
01001110
01001111
01010000
01010001
01010010
01010011
01010100
01010101
01010110
01010111
01011000
01011001
01011010
01011011
01011100
01011101
01011110
01011111
01100000
01100001
01100010
01100011
01100100
01100101
01100110
01100111
01101000
01101001
01101010
01101011
01101100
01101101
01101110
01101111
01110000
01110001
01110010
01110011
01110100
01110101
01110110
01110111
01111000
01111001
01111010
01111011
01111100
01111101
01111110
01111111
Oct
100
101
102
103
104
105
106
107
110
111
112
113
114
115
116
117
120
121
122
123
124
125
126
127
130
131
132
133
134
135
136
137
140
141
142
143
144
145
146
147
150
151
152
153
154
155
156
157
160
161
162
163
164
165
166
167
170
171
172
173
174
175
176
177
Dec
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
Hex
40
41
42
43
44
45
46
47
48
49
4A
4B
4C
4D
4E
4F
50
51
52
53
54
55
56
57
58
59
5A
5B
5C
5D
5E
5F
60
61
62
63
64
65
66
67
68
69
6A
6B
6C
6D
6E
6F
70
71
72
73
74
75
76
77
78
79
7A
7B
7C
7D
7E
7F
UX
UX
UX
UX
UX
UX
LX
LX
LX
LX
LX
LX
ASCII
DEL
BM210012WT37
Boomer II User Manual & Integrator’s Guide _______________________ APPENDIX G - Numeric Conversion Chart
BM210012WT37
141
Copyright Wavenet Technology © November 2003
APPENDIX H - Specifications__________________________________ Boomer II User Manual & Integrator’s Guide
Appendix H - 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.2
Environmental Conditions
Operating temperature
-30°C to +60°C
Storage temperature
-40°C to 70°C
Relative Humidity
0 to 95%
Ports
Data Interface Port
TTL compatible serial port,
9600 baud
RF Connector
MMCX female, 50Ω.
Straight connection or right angle
LED Indicators
Power
Green
flashes when scanning
On, when locked
Off, when the Boomer II is off
Transmit
Red
flashes when transmitting
Receive
Green
flashes when receiving
Power
Voltage
3.8V nominal
(3.4 to 4.2V range)
Transmit
< 1.6 A (2.2 A if mismatched antenna)
Receive
< 85 mA
Standby
< 4.4 mA
(Add 1.2 mA if LED’s enabled)
Off current consumption
100 µA (nominal)
Transmit Duration
32 ms (minimum)
7 seconds RD-LAP (maximum)
30% (maximum) Duty Cycle
Power Supply Ripple
< 15 mV peak to peak
Copyright Wavenet Technology © November 2003
142
BM210012WT37
Boomer II User Manual & Integrator’s Guide __________________________________APPENDIX H - Specifications
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.5kHz deviation (A)
4-Level FSK RDLAP 9.6 3.9kHz deviation (A)
4-Level FSK RDLAP 19.2 5.6kHz deviation (A)
4-Level FSK RDLAP 9.6 2.5kHz deviation (B)
RF output power (at 50Ω antenna port)
1.8W nominal (2W maximum)
Transmit Duty Cycle (over 5 min)
10% default
30% (maximum)
Turn on time
< 5ms
Spurious emission
< - 30dBm
Adjacent channel power
< - 55dBc at 25kHz channels (A)
< - 45dBc at 12.5kHz channels (B)
Receiver
Frequency range
851 – 870MHz (A)
935 – 941MHz (B)
Channel spacing
25kHz (A)
12.5kHz (B)
Sensitivity
< -111dBm at 5% PER RD-LAP 19.2
< -114dBm at 5% PER MDC
Spurious emission (receive mode)
< -57dBm
Channel selectivity
> 50dB (5kHz dev 1kHz tone) (A)
> 50dB (2.5kHz dev 1kHz tone) (B)
Spurious rejection
> 70dB
Image rejection
> 60dB
RSSI Reading
-120dBm ~ -45dBm
BM210012WT37
143
Copyright Wavenet Technology © November 2003
APPENDIX I - Glossary ______________________________________ Boomer II User Manual & Integrator’s Guide
Appendix I - 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
Acknowledgment
Analog-to-digital converter
Automatic level control
American National Standards Institute
Automatic output control
Application-specific integrated circuit
Automatic test equipment
Ball grid array
Bit error rate
A type of connector used with coaxial cable
Bits per second
Base station controller (for a network)
Type of miniature RF connector
Enhanced pendulum IC
Clock
Complementary metal oxide silicon
Control
Communications (port)
Central processing unit
Customer quality assurance
Control (key)
California Safety Authority
Digital-to-analog converter
Decibel
Decibels relative to carrier
Decibels mean; levels relative to 1 mW
Detailed circuit description
Protection against feedback voltage
Loss of sensitivity from high ambient noise
Discriminator
Disc operating system
Data terminal equipment, the user device
Data terminal ready
Device under test
Digital volt meter
Electrically erasable, programmable read-only memory
Electronic Industries Association (U.S.)
Embedded memory access (mode)
Electromagnetic interference
File name suffix for modem configuration files
Erasable, programmable, read-only memory
Effective radiated power
Electrostatic discharge
Electronic serial number
Federal Communications Commission (U.S.)
Field effect transistor
First in, first out
Fixed network equipment
Flexible printed circuit
Copyright Wavenet Technology © November 2003
144
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________________________ APPENDIX I - Glossary
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
BM210012WT37
Fractional division synthesizer IC
Field-replaceable unit
Frequency shift keying
Gallium arsenide, a semi-conducting material
Ground
A type of ATE interface
Gigahertz transverse electromagnetic
High-speed CMOS technology
The computer platform, or DTE directly connected to the modem
Hewlett Packard
Input/Output
Inbound
Integrated circuit or Industry Canada
Direction of wireless data originating from the host and/or modem
to the fixed network equipment
Internet protocol
Infrared
Inductor-capacitor
Light-emitting diode
Lithium ion (battery technology)
Logical link identifier; unit ID
Low noise amplifier
Mobile data communications protocol (Motorola)
Multiple-frequency reuse
Maintenance Programming Software
Negative acknowledgment
Native Mode Simulation (software utility)
Native Control Language (Motorola)
Nickel-cadmium (battery technology)
Nickel-Metal-Hydride (battery technology)
Type of bipolar transistor
Network systems integration
Outbound
Original Equipment Manufacturer
Operational amplifier
Type of miniature RF connector
Direction of wireless data originating from the fixed network
destined for either the host application(s) or the modem itself
Printed circuit assembly (populated board)
Printed circuit board (bare board)
A PCMCIA product
Personal Computer Memory Card International Association
Personal data assistant
Packet data unit
Personal information communicator
Phase-locked loop
Part number
Packet modem integration test
Power-on self test
Parts per million
Quad flat pack
145
Copyright Wavenet Technology © November 2003
APPENDIX I - Glossary ______________________________________ Boomer II User Manual & Integrator’s Guide
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
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-frequency interference
Cabling designation number
Return material authorization
Radio network controller
Radio packet modem
The EIA standard for a serial data interface
Received signal strength indicator
Radio Training Utility
Receive or reception
A specific service access point
Specific Absorption Rate
A diode with low forward voltage drop and fast switching
Standard context routing
Software developer’s kit
Service data unit
Single-frequency reuse
Ratio (measured in dB) of signal to noise-plus-distortion
Sub-miniature connector
Sub-miniature connector
Signal-to-noise ratio
Single pole, double throw (switch)
Serial peripheral interface
Static random-access memory (static RAM)
To be determined
Industry standard connector type
Transient absorber
Transmitter turn-on time
Transmit or transmission
Universal asynchronous receiver / transmitter
Underwriters Laboratories
Voltage common collector
Voltage controlled oscillator
Voltage direct drain
Voltage peak to peak
Voltage standing-wave ratio
Wireless Data Group (Motorola)
Communications over a direct, physical link
Execute in place
Zero insertion force
Copyright Wavenet Technology © November 2003
146
BM210012WT37
Boomer II User Manual & Integrator’s Guide ______________________________________ APPENDIX I - Glossary
BM210012WT37
147
Copyright Wavenet Technology © November 2003

---

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.3
Linearized                      : No
Page Count                      : 147
Page Mode                       : UseNone
XMP Toolkit                     : XMP toolkit 2.9.1-13, framework 1.6
About                           : uuid:68b6c782-0776-4c90-af41-f245237a25d9
Producer                        : Acrobat Distiller 4.05 for Windows
Modify Date                     : 2003:11:14 10:18:02-08:00
Create Date                     : 2003:11:14 16:42:14Z
Creator Tool                    : Microsoft Word 9.0
Metadata Date                   : 2003:11:14 10:18:02-08:00
Document ID                     : uuid:7fa95ae5-9f8e-42b2-985f-38920049d80a
Format                          : application/pdf
Title                           : Boomer II User Manual & Integrators Guide
Creator                         : Wavenet Technology Pty Ltd Wa
Author                          : Wavenet Technology Pty Ltd Wa

EXIF Metadata provided by EXIF.tools