User's Manual
Table Of Contents
- Introduction
- The Integrator’s Task
- Installing the Modem
- Mounting the Boomer II OEM Modem to Your Device
- Connecting the Data Interface Port
- Selecting & Positioning the Antenna
- Supplying Power
- Using the Modem Test Jig
- Software Development Tools
- Integration Testing
- Appendix A - NCL Interface
- Appendix B – SDK NCL-API and Port Server
- Multisession API
- Application Interface
- _
- Opening a Session
- Close Session
- Send Data to a Radio Host
- Receive Data From RPM
- Get RPM Status Information
- Set Configuration ITEMS Within the RPM
- Reset RPM
- Register Event Callback Function
- Enable / Disable Events
- Get Error Description
- Register Wakeup Application
- Deregister Wakeup Application
- Switch RPM On/Off
- Send Generic NCL Command To RPM
- Get Software Version
- _
- A
- Appendix C – SDK Sample programs
- Appendix D - Application Development
- Appendix E - Message Routing and Migration
- Appendix F – Guide to Desense
- Appendix G - Numeric Conversion Chart
- Appendix H - Specifications
- Appendix I - Glossary
Boomer II User Manual & Integrator’s Guide ______________________Appendix B – SDK NCL-API and Port Server
BM210012WT37 95 Copyright Wavenet Technology © November 2003
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.