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 A - NCL INTERFACE ________________________________ Boomer II User Manual & Integrator’s Guide
Copyright Wavenet Technology © November 2003 82 BM210012WT37
channel.
RX_REG_DENIED ASCII 7 Flash LED for
registration denial.
HW_EVENT ASCII E HW_EVENT_BIT $01 Hardware event.
HW_SELF_TEST ASCII 1 Self-test failed.
HW_LOW_BATT ASCII 2 Low battery.
HW_MEM_FULL ASCII 3 Memory full.
HW_BATT_OK ASCII 4 Battery level OK.
HW_MEM_OK ASCII 5 Memory OK.
HW_OFF ASCII 6 Device shutdown
imminent.
HW_BATT_WARN ASCII 7 Battery at warning
level.
RCV_ERR ASCII F Unreceivable message
event.
RCV_TX_DISABLED ASCII 1 ACK required, PDU
received. Cannot
ACK, transmitter
disabled. PDU
discarded.
CONTROL ASCII G CONTROL_BIT $20 Control event.
CONNECT ASCII 1 NCL connect between
RPM and DTE .
ASCII
H..Y, 1..9
Reserved.
VENDOR ASCII Z Vendor-specific event.
Response Status SDUs (RESP, ASCII C)
Responses Value Parameters Value Description/Error Code
SUCCESS ASCII 1 Successful.
IBQ_FLUSHED ASCII a Error code. Pending SDUs in inbound queue flushed;
transmitter disabled. Used only if the RPM cannot support
message buffering while transmitter disabled.
XFAIL ASCII 2 Command execution error. Note the following error codes:
NO_RESPONSE ASCII A No response from network.
NO_ACK ASCII B Negative ACK received.
HOST_DOWN ASCII C Host access is down.
NOT_REGISTERED ASCII D RPM not registered.
LOW_BATTERY ASCII E Low battery—cannot transmit.
IBQ_FULL ASCII F RPM inbound queue is full.
TX_DISABLED ASCII G Radio transmitter is disabled.
BUSY ASCII H Resource is unavailable.
NOT_AVAILABLE ASCII I Unimplemented services.
HW_ERROR ASCII J Generic error.
INVALID_MODE ASCII K Invalid mode of operation.
NO_MESSAGES ASCII L No outbound messages available.
MSGS_PENDING ASCII M Cannot execute command due to pending inbound messages.
SW_ERROR ASCII N Software error.
OUT_OF_RANGE ASCII O RF not in range.
PACKET_ERROR ASCII Z SDU data corruption. True only if confirmed delivery mode
enabled.