Manufacturing and Functional Test Library

EmberZNet Stack API Reference

Deactivates use of Manufacturing and Functional Test 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.

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:

• EMBER_SUCCESS if the mfg test mode has been exited.
• EMBER_ERR_FATAL if the mfg test mode cannot be exited.

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

Use this function to get current channel.

Returns

Current channel.

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

Use this function to get library options.

Returns

Current options based on the current test mode.

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

Use this function to get current power setting.

Returns

The current power setting.

Get the current synth offset in steps.

Steps are 11.7 kHz on em3xx and 9.375 kHz on EFR32. See mfglibSetSynOffset() for details.

Returns

The synth offset.

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

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

Parameters

packet

A packet to be sent. First byte of the packet is always the length byte, the value of which does not include itself but does include the 16-bit CRC in the length calculation. The CRC gets appended automatically by the radio as it transmits the packet, so the host does not need to provide this as part of packetContents. The total length of packet contents (Length Byte+1) going out the radio should not be >128 or <6 bytes. Note that the packet array should not include the CRC, as this is appended by the radio automatically.

repeat

The number of times to repeat sending the packet after having been sent once. A value of 0 means send once and don't repeat.

Returns

One of the following:

• 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.

Selects 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.

Use this function to change channels.

Parameters

chan	Valid values depend upon the radio used.

Returns

One of the following:

• EMBER_SUCCESS if the channel has been set.
• EMBER_PHY_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.

Sets manufacturing library options.

Use this function to set manufacturing library options.

Parameters

options

bitmask. 0 == non-CSMA transmits, 1 == CSMA transmits

Returns

One of the following:

• 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.

First select the transmit power mode, and 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().

Use this function to adjust the transmit power.

Parameters

txPowerMode	Boost mode or external PA.
power	Power in units of dBm, which can be negative.

Returns

One of the following:

• EMBER_SUCCESS if the power has been set.
• EMBER_PHY_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.

Set the synth offset in steps.

Set the synth offset in 11.7 kHz steps on em3xx or 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 em3xx_load –patch or Simplicity COmmander.

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.

Parameters

synOffset

The number of steps to offset the carrier frequency (may be negative).

Activates use of mfglib test routines and enables 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.

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.

Parameters

mfglibRxCallback

A function pointer to callback routine that is invoked whenever a valid packet is received. emberTick() must be called routinely for this callback to function correctly.

Returns

One of the following:

• EMBER_SUCCESS if the mfg test mode has been enabled.
• EMBER_ERR_FATAL if the mfg test mode is not available.

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

Use this function to enable the measurement of radio modulation.

Returns

One of the following:

• EMBER_SUCCESS if the transmit stream has started.
• EMBER_ERR_FATAL if the stream cannot be started.

Starts 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.

Use this function to transmit a tone.

Returns

One of the following:

• EMBER_SUCCESS if the transmit tone has started.
• EMBER_ERR_FATAL if the tone cannot be started.

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

Use this function to end the measurement of radio modulation.

Returns

One of the following:

• EMBER_SUCCESS if the transmit stream has stopped.
• EMBER_ERR_FATAL if the stream cannot be stopped.

Stops transmitting a tone started by mfglibStartTone().

Use this function to stop transmitting a tone.

Returns

One of the following:

• EMBER_SUCCESS if the transmit tone has stopped.
• EMBER_ERR_FATAL if the tone cannot be stopped.

Run mod DAC calibration on the given channel for the given amount of time.

If the duration argument == 0, this test will run forever (until the chip is reset).

Use this function to run the active transmit part of mod DAC calibration.

Parameters

channel	Selects the channel to transmit on.
duration	Duration in ms, 0 == infinite.

Returns

None.