User's Manual

SDK SCR-API ______________________________________________ Boomer II User Manual & Integrator’s Guide
Wavenet Technology 142 BM210012WT27
Status Request (Wavenet
Technology specific)
Response Structure Description
WN_GET_STATUS_RADIO NCLWaveRadio Get RPM Radio Status
WN_GET_STATUS_BATTERY NCLWaveGen Get RPM Battery Status
WN_GET_STATUS_ONTIME NCLWaveGen Get RPM on-time status
WN_GET_STATUS_CONFIG NCLWaveGen Get RPM configuration status
Prototype:
int nclGetStatus (word *usSduTag, byte ucVendor, byte ucType, byte
ucRequest);
Description:
Command the RPM to send the requested status information.
Input:
 usSduTag Pointer to a word where the SDU tag can be stored
 ucVendor Vendor identifier. Use:
NCL_NO_VEND = 0 if not vendor specific or
NCL_VEND_WAVENET = ’F’ for Wavenet Technology specific
requests
 ucType The type of status information to retrieve from the RPM (Used by
Vendor specific requests). Set to zero for non-vendor requests or
WN_GET_STATUS = ‘?’ for Wavenet Technology specific
requests
 ucRequest The requested status information, as listed in one of the
appropriate tables above, to retrieve from the RPM.
Output:
 Return value = 0 Operation was successful
 Return value ≠ 0 Operation failed. Value specifies the error type
 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.
The response is posted to the corresponding RX queue associated with
the VDD session ID. If the session ID is not recognized all active RX
queues will be posted the response.