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 145 Wavenet Technology
usSduTag Pointer to a word containing a reference of the corresponding
SDU tag which was generated by the NCL API for this command
to the RPM.
Get Error Description
The application can call this function to obtain a string representation
for a specified error code.
Error Code Value Description
NCL_ERR_NONE 0 No error has occurred
NCL_ERR_SESSION_IS_CLOSED -1 NCL API: Session has not been opened
NCL_ERR_SESSION_IS_OPEN -2 NCL API: Session is already open
NCL_ERR_ENCODE -3 NCL API: NCL Frame encoding error
NCL_ERR_DECODE -4 NCL API: NCL Frame decoding error
NCL_ERR_PARAM -5 NCL API: Invalid parameter passed
NCL_ERR_TIMEOUT -6 NCL API: Time-out elapsed waiting for response
NCL_ERR_MSMQ_OPEN -7 NCL API: An error occurred opening a MSMQ
NCL_ERR_MSMQ_CLOSE -8 NCL API: An error occurred closing a MSMQ
NCL_ERR_MSMQ_SEND -9 NCL API: An error occurred sending a MSMQ
NCL_ERR_MSMQ_RECEIVE -10 NCL API: An error occurred receiving a MSMQ
NCL_ERR_MSMQ_CREATE -11 NCL API: An error occurred creating a MSMQ
NCL_ERR_MSMQ_DELETE -12 NCL API: An error occurred deleting a MSMQ
NCL_ERR_MSMQ_NAME -13 NCL API: An error occurred searching for a MSMQ
NCL_ERR_MAX_CLIENTS -14 NCL API: Maximum number of supported clients
reached
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