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
emberAfMfglibStart(bool wantCallback)

Start the manufacturing test mode.

void

Stop the manufacturing test mode.

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

Return the saved RX test statistics.

API Documentation#

emberAfMfglibRunning#

bool emberAfMfglibRunning (void )

Return true if the manufacturing library is currently running.

Parameters
N/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.


Definition at line 48 of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h

emberAfMfglibEnabled#

bool emberAfMfglibEnabled (void )

Return true if the manufacturing library token has been set.

Parameters
N/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.


Definition at line 68 of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h

emberAfMfglibStart#

void emberAfMfglibStart (bool wantCallback)

Start the manufacturing test mode.

Parameters
N/AwantCallback

Indicates whether to enable the receive callback and tabulate statistics.


Definition at line 76 of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h

emberAfMfglibStop#

void emberAfMfglibStop (void )

Stop the manufacturing test mode.

Parameters
N/A

Definition at line 81 of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h

emberAfMfglibRxStatistics#

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

Return the saved RX test statistics.

Parameters
N/ApacketsReceived

Total number of packets received during the test.

N/AsavedRssiReturn

RSSI from the first received packet.

N/AsavedLqiReturn

LQI from the first received packet.


Definition at line 92 of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h