Manufacturing Library CLI#

API and Callbacks for the Manufacturing Library CLI Component.

API#

bool

Return true if the manufacturing library is currently running.

bool

Return true if the manufacturing library token has been set.

void
sl_zigbee_af_mfglib_start(bool wantCallback)

Start the manufacturing test mode.

void

Stop the manufacturing test mode.

void
sl_zigbee_af_mfglib_rx_statistics(uint16_t *packetsReceived, int8_t *savedRssiReturn, uint8_t *savedLqiReturn)

Return the saved RX test statistics.

API Documentation#

sl_zigbee_af_mfglib_running#

bool sl_zigbee_af_mfglib_running (void )

Return true if the manufacturing library is currently running.

Parameters
TypeDirectionArgument NameDescription
voidN/A

The function returns whether the manufacturing library is currently running. Code that initiates scan/join behavior should not do so if the manufacturing library is currently running as this will cause a conflict and may result in a fatal error.

Returns

  • A ::bool value that is true if the manufacturing library is running and false if it is not.


sl_zigbee_af_mfglib_enabled#

bool sl_zigbee_af_mfglib_enabled (void )

Return true if the manufacturing library token has been set.

Parameters
TypeDirectionArgument NameDescription
voidN/A

The function returns whether the manufacturing library token has currently been set. Reference designs are programmed to initiate scan/join behavior as soon as the device has been powered up. Certain sleepy devices, such as security sensors, may also use the UART for manufacturing, which becomes inactive during normal operation. Setting this token allows the device to stay awake or hold off on normal joining behavior for a few seconds to allow manufacturing mode to be enabled. The last step in the manufacturing process is to disable this token.

Note: This token is disabled by default. To enable it in your application, edit the file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-tokens.h.

Returns

  • A ::bool value that is true if the manufacturing library token has been set and false if it has not been set.


sl_zigbee_af_mfglib_start#

void sl_zigbee_af_mfglib_start (bool wantCallback)

Start the manufacturing test mode.

Parameters
TypeDirectionArgument NameDescription
boolN/AwantCallback

Indicates whether to enable the receive callback and tabulate statistics.


sl_zigbee_af_mfglib_stop#

void sl_zigbee_af_mfglib_stop (void )

Stop the manufacturing test mode.

Parameters
TypeDirectionArgument NameDescription
voidN/A

sl_zigbee_af_mfglib_rx_statistics#

void sl_zigbee_af_mfglib_rx_statistics (uint16_t * packetsReceived, int8_t * savedRssiReturn, uint8_t * savedLqiReturn)

Return the saved RX test statistics.

Parameters
TypeDirectionArgument NameDescription
uint16_t *N/ApacketsReceived

Total number of packets received during the test.

int8_t *N/AsavedRssiReturn

RSSI from the first received packet.

uint8_t *N/AsavedLqiReturn

LQI from the first received packet.