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 110 BM210012WT37
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