Boomer-III User Manual & Integrator’s Guide______________________Appendix B – SDK NCL-API and Port Server
BM310012WT04
105
Copyright Wavenet Technology © October 2003
/* NCL_RCV_ERR_EVENT
'F'
Unreceivable Message Event */
/* NCL_CONTROL_EVENT
'G'
Control Event */
BYTE EventCode;
/* NCL_MSG_NOTIFICATION_LEN N- Number of buffered msgs to be read */
/* NCL_TX_EVENT_KEYED
‘1’
Transmitter keyed */
/* NCL_TX_EVENT_DEKEYED ‘2’
Transmitter dekeyed */
/* NCL_RX_EVENT_INRANGE ‘1’
RF in range */
/* NCL_RX_EVENT_OUTRANGE ‘2’
RF out of range */
/* NCL_RX_EVENT_PSENAB
‘3’
Power Save enabled */
/* NCL_RX_EVENT_PSDISAB ‘4’
Power Save disabled */
/* NCL_HW_EVENT_STEST
‘1’
Self Test Failed */
/* NCL_HW_EVENT_LBATT
‘2’
Low battery */
/* NCL_HW_EVENT_MFULL
‘3’
Memory Full */
/* NCL_HW_EVENT_BATOK
‘4’
Battery Level OK
*/
/* NCL_HW_EVENT_MEMOK ‘5’
Memory Ok
*/
/* NCL_HW_EVENT_MEMOK ‘6’
Device shutdown is imminent */
/* NCL_RCV_ERR_EVENT_RTD ‘1’
ACK required PDU received but TX
disabled */
/* NCL_CONTROL_EVENT_C ‘1’
RPM / DTE connected */
}NCLEventType;
/* RCV_MSG_Data */
#define NCL_MAX_DATA_SIZE
2048
#define NCL_MAX_UH_LEN 63
/* max length of user header */
typedef struct NCLMsg
{
BYTE is_message; /* If FALSE, only len and buf components are valid. */
BYTE sessionID[NCL_MAX_ 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 f
i d SDU