host-mfglib API Callbacks
Functions | |
void | mfglibEndReturn (EmberStatus status, uint32_t receiveCount) |
This function provides the result of a call to mfglibEnd(). | |
void | mfglibGetChannelReturn (uint8_t channel) |
This function provides the result of a call to mfglibGetChannel(). | |
void | mfglibGetOptionsReturn (uint8_t options) |
This function provides the result of a call to mfglibGetOptions(). | |
void | mfglibGetPowerModeReturn (uint16_t txPowerMode) |
This function provides the result of a call to mfglibGetPowerMode(). | |
void | mfglibGetPowerReturn (int8_t power) |
This function provides the result of a call to mfglibGetPower(). | |
void | mfglibGetSynOffsetReturn (int8_t synthOffset) |
This function provides the result of a call to mfglibGetSynOffset(). | |
void | mfglibRxHandler (uint8_t *packet, uint8_t linkQuality, int8_t rssi) |
RX Handler for the mfglib test library. | |
void | mfglibSendPacketReturn (EmberStatus status) |
This function provides the result of a call to mfglibSendPacket(). | |
void | mfglibSetChannelReturn (EmberStatus status) |
This function provides the result of a call to mfglibSetChannel(). | |
void | mfglibSetOptionsReturn (EmberStatus status) |
This function provides the result of a call to mfglibSetOptions(). | |
void | mfglibSetPowerReturn (EmberStatus status) |
This function provides the result of a call to mfglibSetPower(). | |
void | mfglibStartReturn (EmberStatus status) |
This function provides the result of a call to mfglibStart(). | |
void | mfglibStartStreamReturn (EmberStatus status) |
This function provides the result of a call to mfglibStartStream(). | |
void | mfglibStartToneReturn (EmberStatus status) |
This function provides the result of a call to mfglibStartTone(). | |
void | mfglibStopStreamReturn (EmberStatus status) |
This function provides the result of a call to mfglibStopStream(). | |
void | mfglibStopToneReturn (EmberStatus status) |
This function provides the result of a call to mfglibStopTone(). |
Detailed Description
These callbacks were contributed by the host-mfglib API.
Function Documentation
void mfglibEndReturn | ( | EmberStatus | status, |
uint32_t | receiveCount |
||
) |
- Parameters
-
status
- EMBER_SUCCESS if the mfg test mode has been exited.
- EMBER_ERR_FATAL if the mfg test mode cannot be exited.
receiveCount
The total number of packets received during the test.
void mfglibGetChannelReturn | ( | uint8_t | channel | ) |
- Parameters
-
channel
The current channel.
void mfglibGetOptionsReturn | ( | uint8_t | options | ) |
- Parameters
-
options
The current options based on the current test mode.
void mfglibGetPowerModeReturn | ( | uint16_t | txPowerMode | ) |
- Parameters
-
txPowerMode
The current power mode setting.
void mfglibGetPowerReturn | ( | int8_t | power | ) |
- Parameters
-
power
The current power setting.
void mfglibGetSynOffsetReturn | ( | int8_t | synthOffset | ) |
- Parameters
-
synthOffset
The synth offset in 11.7kHz steps.
void mfglibRxHandler | ( | uint8_t * | packet, |
uint8_t | linkQuality, |
||
int8_t | rssi |
||
) |
- Parameters
-
packet
incoming packet linkQuality
link quality as a numeric value rssi
RSSI in dBm
void mfglibSendPacketReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the packet was sent.
- EMBER_ERR_FATAL if the mfg test mode is not available or TONE or STREAM test is running.
void mfglibSetChannelReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the channel has been set.
- ::EMBER_ERROR_INVALID_CHANNEL if the channel requested is invalid.
- EMBER_ERR_FATAL if the mfg test mode is not available or TONE or STREAM test is running.
void mfglibSetOptionsReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the options have been set.
- EMBER_BAD_ARGUMENT if any options are unavailable.
- EMBER_ERR_FATAL if the mfg test mode is not available or TONE or STREAM test is running.
void mfglibSetPowerReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the power has been set.
- ::EMBER_ERROR_INVALID_POWER if the power requested is invalid.
- EMBER_ERR_FATAL if the mfg test mode is not available or TONE or STREAM test is running.
void mfglibStartReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the mfg test mode has been enabled.
- EMBER_ERR_FATAL if the mfg test mode is not available.
void mfglibStartStreamReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the transmit stream has started.
- EMBER_ERR_FATAL if the stream cannot be started.
void mfglibStartToneReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the transmit tone has started.
- EMBER_ERR_FATAL if the tone cannot be started.
void mfglibStopStreamReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the transmit stream has stopped.
- EMBER_ERR_FATAL if the stream cannot be stopped.
void mfglibStopToneReturn | ( | EmberStatus | status | ) |
- Parameters
-
status
- EMBER_SUCCESS if the transmit tone has stopped.
- EMBER_ERR_FATAL if the tone cannot be stopped.