User's Manual

Boomer II User Manual & Integrator’s Guide ______________________________________________ SDK SCRAPI
BM210012WT27 141 Wavenet Technology
typedef struct NCLMsg
{
BYTE is_message; /* If FALSE, only len and buf components are valid. */
BYTE sessionID[NCL_MAX_UH_LEN + 1]; /* NULL terminated */
BYTE msg_type; /* Used by NCL_DATATAC_5000 networks */
WORD len;
BYTE buf[NCL_MAX_DATA_SIZE];
} NCLMsg;
/* End of 1 byte alignment */
#pragma pack()

Get RPM Status Information
The application can call this function to obtain status information about
the RPM. The following types of status information can be obtained:
Status Request (non vendor
specific)
Response Structure Description
NCL_R_CONFIG_BLOCK NCLConfigBlock Get RPM configuration block
NCL_R_STATUS_BLOCK NCLStatusBlock Get RPM status block
NCL_R_PROD_ID NCLProdId Get RPM product ID
NCL_R_SW_VERSION NCLVersion Get software version number
NCL_R_RPM_ID NCLRpmId Get RPM address
NCL_R_RPM_VID NCLStatus.rpm_vid[2] Get RPM VID address (MDC)
NCL_R_MAX_DATA_SIZE NCLStatus.max_data_size Get SDU data limit
NCL_R_RCV_MODE NCLStatus.rcv_mode Get mode of notification to
DTE for received SDUs.
NCL_R_RX_STATUS NCLStatus.rx_status Get receiver enable status
NCL_R_TX_STATUS NCLStatus.tx_status Get transmitter enable status
NCL_R_ANTENNA NCLStatus.antenna Get antenna selection status
NCL_R_RADIO_IN_RANGE NCLStatus.radio_in_range Get radio in range status
NCL_R_OB_MSG_COUNT NCLStatus.ob_msg_count Get count of outbound
messages queued
NCL_R_IB_MSG_COUNT NCLStatus.ib_msg_count Get count of inbound
NCL_R_FLOW_CONTROL NCLStatus.flow_control Get flow control status
NCL_R_EVENT_STATES NCLStatus.event_states Get current event reporting
(enable/disable) state
NCL_R_RADIO_CHANNEL NCLStatus.radio_channel Get current radio channel
NCL_R_CHAN_TABLE NCLChannelTable Read radio channel table
NCL_R_CHAN_BLOCK NCLChanBlock Read the channel block
NCL_R_BAT_LEVEL NCLStatus.bat_level Read the battery level
NCL_R_RPM_GID NCLGroupLlis Get RPM group IDs
NCL_R_VENDOR_ID NCLStatus.vendor_id Get vendor identification
NCL_R_DCHAN_TABLE NCLChannelTable Read the D-channel table
NCL_R_RF_STATISTICS Specific to RF protocol used:
RD-LAP [F] or MDC [G]
Read the RF statistics