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
Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI
BM210012WT27 147 Wavenet Technology
Input:
usAppName Pointer to a buffer specifying the full path name (Null terminated)
of the application to execute on a wakeup.
usWakeupReason 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);
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.