WM_MeasureChannel


C Specification

#include <nitro/wm.h>

WMErrCode WM_MeasureChannel(
        WMCallbackFunc  callback , 
        u16             ccaMode , 
        u16             edThreshold , 
        u16             channel , 
        u16             measureTime );

Description

Measures the electrical usage rate of the specified channel

This function is only executable when the WM is in the IDLE state. If the API return value is WM_ERRCODE_OPERATING, a callback occurs after the measurement of the electrical usage rate is complete.

Arguments

callback The callback function to call when the asynchronous process finishes.
ccaMode CCA operation mode:
0: carrier sense only
1: ED threshold only
2: carrier sense and ED threshold AND
3: carrier sense and ED threshold OR
edThreshold The ED threshold as a value in the range of 0 to 61 (-60dBm to -80dBm).
channel The channel to be measured.
measureTime The measurement period in in 1 ms resolution.

Return Values

Returns the process result as a WMErrCode enumerated type.

Revision History

10/22/2004 Changed return value types
08/11/2004 Initial version