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
Appendix B – SDK NCL-API and Port Server______________________ Boomer II User Manual & Integrator’s Guide
Copyright Wavenet Technology © November 2003 102 BM210012WT37
/*** Define types for retrieving data from the RPM ***/
typedef unsigned char BYTE;
typedef unsigned short 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
{