Mfglib Frames#
Name: mfglibInternalStart | ID: 0x0083 |
|---|---|
Description: Activate use of mfglib test routines and enables the radio receiver to report packets it receives to the mfgLibRxHandler() callback. These packets will not be passed up with a CRC failure. All other mfglib functions will return an error until the mfglibInternalStart() has been called. | |
Command Parameters: | |
bool rxCallback | true to generate a mfglibRxHandler callback when a packet is received. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalEnd | ID: 0x0084 |
|---|---|
Description: Deactivate use of mfglib test routines; restores the hardware to the state it was in prior to mfglibInternalStart() and stops receiving packets started by mfglibInternalStart() at the same time. | |
Command Parameters: None | |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalStartTone | ID: 0x0085 |
|---|---|
Description: Starts transmitting an unmodulated tone on the currently set channel and power level. Upon successful return, the tone will be transmitting. To stop transmitting tone, application must call mfglibInternalStopTone(), allowing it the flexibility to determine its own criteria for tone duration (time, event, etc.) | |
Command Parameters: None | |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalStopTone | ID: 0x0086 |
|---|---|
Description: Stops transmitting tone started by mfglibInternalStartTone (). | |
Command Parameters: None | |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalStartStream | ID: 0x0087 |
|---|---|
Description: Starts transmitting a random stream of characters. This is so that the radio modulation can be measured. | |
Command Parameters: None | |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalStopStream | ID: 0x0088 |
|---|---|
Description: Stops transmitting a random stream of characters started by mfglibInternalStartStream (). | |
Command Parameters: None | |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalSendPacket | ID: 0x0089 |
|---|---|
Description: Sends a single packet consisting of the following bytes: packetLength, packetContents[0], ... , packetContents[packetLength - 3], CRC[0], CRC[1]. The total number of bytes sent is packetLength + 1. The radio replaces the last two bytes of packetContents[] with the 16-bit CRC for the packet. | |
Command Parameters: | |
uint8_t packetLength | The length of the packetContents parameter in bytes. Must be greater than 3 and less than 123. |
uint8_t[] packetContents | The packet to send. The last two bytes will be replaced with the 16-bit CRC. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalSetChannel | ID: 0x008A |
|---|---|
Description: Sets the radio channel. Calibration occurs if this is the first time the channel has been used. | |
Command Parameters: | |
uint8_t channel | The channel to switch to. Valid values are 11 to 26. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalGetChannel | ID: 0x008B |
|---|---|
Description: Returns the current radio channel, as previously set via mfglibInternalSetChannel (). | |
Command Parameters: None | |
Response Parameters: | |
uint8_t channel | The current channel. |
Name: mfglibInternalSetPower | ID: 0x008C |
|---|---|
Description: First select the transmit power mode, and then include a method for selecting the radio transmit power. The valid power settings depend upon the specific radio in use. Ember radios have discrete power settings, and then requested power is rounded to a valid power setting; the actual power output is available to the caller via mfglibInternalGetPower(). | |
Command Parameters: | |
uint16_t txPowerMode | Power mode. Refer to txPowerModes in stack/include/sl_zigbee_types.h for possible values |
int8_t power | Power in units of dBm. Refer to radio data sheet for valid range. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: mfglibInternalGetPower | ID: 0x008D |
|---|---|
Description: Returns the current radio power setting, as previously set via mfglibInternalSetPower(). | |
Command Parameters: None | |
Response Parameters: | |
int8_t power | Power in units of dBm. Refer to radio data sheet for valid range. |
Name: mfglibRxHandler | ID: 0x008E |
|---|---|
Description: A callback indicating a packet with a valid CRC has been received. | |
This frame is a response to the callback command. | |
Response Parameters: | |
uint8_t linkQuality | The link quality observed during the reception |
int8_t rssi | The energy level (in units of dBm) observed during the reception. |
uint8_t packetLength | The length of the packetContents parameter in bytes. Will be greater than 3 and less than 123. |
uint8_t[] packetContents | The received packet (last 2 bytes are not FCS / CRC and may be discarded). |