Manufacturing Library#

MfglibRxCallback#

typedef void(* MfglibRxCallback) (uint8_t *packet, uint8_t linkQuality, int8_t rssi) )(uint8_t *packet, uint8_t linkQuality, int8_t rssi)

callback function pointer type for mfglibStart

mfglibStart#

sl_status_t mfglibStart (MfglibRxCallback mfglibRxCallback)

Activate use of mfglib test routines and enable the radio receiver to report packets it receives to the caller-specified ::mfglibRxCallback() routine.

It is legal to pass in a NULL. These packets will not be passed up with a CRC failure. The first byte of the packet in the callback is the length. All other functions will return an error until mfglibStart() has been called.

@appusage Use this function to enter test mode.

Note: This function should only be called shortly after initialization and prior to forming or joining a network.

Returns

• One of the following:

  • SL_STATUS_OK if the mfg test mode has been enabled.

  • SL_STATUS_FAIL if the mfg test mode is not available.
    

mfglibEnd#

sl_status_t mfglibEnd (void )

Deactivate use of Manufacturing Library test routines.

This restores the hardware to the state it was in prior to mfglibStart() and stops receiving packets started by mfglibStart() at the same time.

@appusage Use this function to exit the mfg test mode.

Note: It may be desirable to also reboot after use of manufacturing mode to ensure all application state is properly re-initialized.

Returns

• One of the following:

  • SL_STATUS_OK if the mfg test mode has been exited.

  • SL_STATUS_FAIL if the mfg test mode cannot be exited.
    

mfglibStartTone#

sl_status_t mfglibStartTone (void )

Start transmitting the tone feature of the radio.

In this mode, the radio will transmit an unmodulated tone on the currently set channel and power level. Upon successful return, the tone will be transmitting. To stop transmitting a tone, the application must call mfglibStopTone(), allowing it the flexibility to determine its own criteria for tone duration, such as time, event, and so on.

@appusage Use this function to transmit a tone.

Returns

• One of the following:

  • SL_STATUS_OK if the transmit tone has started.

  • SL_STATUS_FAIL if the tone cannot be started.
    

mfglibStopTone#

sl_status_t mfglibStopTone (void )

Stop transmitting a tone started by mfglibStartTone().

@appusage Use this function to stop transmitting a tone.

Returns

• One of the following:

  • SL_STATUS_OK if the transmit tone has stopped.

  • SL_STATUS_FAIL if the tone cannot be stopped.
    

mfglibStartStream#

sl_status_t mfglibStartStream (void )

Start transmitting a random stream of characters to enable the measurement of radio modulation.

@appusage Enable the measurement of radio modulation.

Returns

• One of the following:

  • SL_STATUS_OK if the transmit stream has started.

  • SL_STATUS_FAIL if the stream cannot be started.
    

mfglibStopStream#

sl_status_t mfglibStopStream (void )

Stop transmitting a random stream of characters started by mfglibStartStream().

@appusage Use this function to end the measurement of radio modulation.

Returns

• One of the following:

  • SL_STATUS_OK if the transmit stream has stopped.

  • SL_STATUS_FAIL if the stream cannot be stopped.
    

mfglibSendPacket#

sl_status_t mfglibSendPacket (uint8_t * packet, uint16_t repeat)

Send a single packet, (repeat + 1) times.

@appusage Use this function to send raw data. Historically, the packet array needed to be 16-bit aligned, but recent platforms now require 32-bit alignment (address a multiple of 4), such that ((((uint16_t)packet) & 3) == 0) holds true. (This is generally done by either declaring packet as a local variable or putting it in a global declaration immediately following the declaration of an uint32_t.)

Returns

• One of the following:

  • SL_STATUS_OK if the packet was sent.

  • SL_STATUS_FAIL if the mfg test mode is not available or TONE or STREAM test is running.

mfglibSetChannel#

sl_status_t mfglibSetChannel (uint8_t chan)

Select the radio channel. The channel range is from 11 to 26.

Customers can set any valid channel they want. Calibration occurs if this is the first time after power up.

@appusage Use this function to change channels.

Returns

• One of the following:

  • SL_STATUS_OK if the channel has been set.

  • SL_STATUS_TRANSMIT_INVALID_CHANNEL if the channel requested is invalid.

  • SL_STATUS_FAIL if the mfg test mode is not available or TONE or STREAM test is running.

mfglibGetChannel#

uint8_t mfglibGetChannel (void )

Return the current radio channel, as previously set via mfglibSetChannel().

@appusage Use this function to get current channel.

Returns

• Current channel.

mfglibSetPower#

sl_status_t mfglibSetPower (uint16_t txPowerMode, int8_t power)

First select the transmit power mode, then include a method for selecting the radio transmit power.

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 mfglibGetPower().

@appusage Use this function to adjust the transmit power.

Returns

• One of the following:

  • SL_STATUS_OK if the power has been set.

  • SL_STATUS_TRANSMIT_INVALID_POWER if the power requested is invalid.

  • SL_STATUS_FAIL if the mfg test mode is not available or TONE or STREAM test is running.

mfglibGetPower#

int8_t mfglibGetPower (void )

Return the current radio power setting as previously set via mfglibSetPower().

@appusage Use this function to get current power setting.

Returns

• The current power setting.

mfglibSetOptions#

sl_status_t mfglibSetOptions (uint8_t options)

Set manufacturing library options.

@appusage Use this function to set manufacturing library options.

Returns

• One of the following:

  • SL_STATUS_OK if the options have been set.

  • SL_STATUS_INVALID_PARAMETER if any options are unavailable.

  • SL_STATUS_FAIL if the mfg test mode is not available or TONE or STREAM test is running.

mfglibGetOptions#

uint8_t mfglibGetOptions (void )

Return the current manufacturing library options, as previously set via mfglibSetOptions().

@appusage Use this function to get library options.

Returns

• Current options based on the current test mode.

mfglibSetSynOffset#

void mfglibSetSynOffset (int8_t synOffset)

Set the synth offset in steps.

Set the synth offset in 9.375 kHz steps on EFR32. This function does NOT write the new synth offset to the token, it only changes it in memory. It can be changed as many times as preferred, and the setting will be lost when a reset occurs. The value will survive deep sleep, but will not survive a reset, thus it will not take effect in the bootloader. To make the value permanent (and accessible to the bootloader), the TOKEN_MFG_SYNTH_FREQ_OFFSET token must be written using the token API or Simplicity Commander.

@appusage Use this function to compensate for tolerances in the crystal oscillator or capacitors. This function does not effect a permanent change; once a preferred offset is found, it must be written to a token using the token API for it to be permanent.

mfglibGetSynOffset#

int8_t mfglibGetSynOffset (void )

Get the current synth offset in steps.

Steps are 9.375 kHz on EFR32. See mfglibSetSynOffset() for details. Returns

• The synth offset.

mfglibSetCtune#

sl_status_t mfglibSetCtune (uint16_t ctune)

Change the CTUNE value.

This function will idle the radio if mfglib has been started, then set the CTUNE value as desired. mfglib is then restarted to take effect of this new change.

@appusage Use this function to change CTUNE value.

Returns

• One of the following:

  • SL_STATUS_OK if CTUNE value has been set.

  • SL_STATUS_INVALID_PARAMETER if CTUNE value is invalid.

  • SL_STATUS_NOT_READY if the radio could not be idled.

  • SL_STATUS_FAIL if mfglib could not be re-started.

mfglibGetCtune#

uint16_t mfglibGetCtune (void )

Return the current CTUNE value, as previously set via mfglibSetCtune().

@appusage Use this function to get current CTUNE value.

Returns

• Current CTUNE value. If value is 0xFFFF, CTUNE is not available due to missing mfglib support.

mfglibApiStart#

#define mfglibApiStart

(packet, linkQuality, rssi)

callback function pointer type for mfglibStart