User's Manual
Table Of Contents
- Introduction
- The Integrator’s Task
- Installing the Modem
- Using the Modem Test Jig
- Testing
- Desense
- Application Development
- Message Routing and Migration
- Appendix A - NCL Interface
- Appendix B - Software Development Kit
- SDK Contents
- System Requirements
- SDK Software Architecture
- NCL Application Programmer’s Interface
- Implementation
- Logical Architecture
- 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
- SCR Application Programmer’s Interface
- A
- Appendix C – Sample programs
- Appendix D - Wavenet Application Loader
- Appendix E - Numeric Conversion Chart
- Appendix F - Specifications
- Appendix H - Glossary
SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide
Wavenet Technology 146 BM210012WT27
Error Code Value Description
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
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.