Manufacturing Library CLI#
API and Callbacks for the Manufacturing Library CLI Component.
API#
Return true if the manufacturing library is currently running.
Return true if the manufacturing library token has been set.
Start the manufacturing test mode.
Stop the manufacturing test mode.
Return the saved RX test statistics.
API Documentation#
emberAfMfglibRunning#
bool emberAfMfglibRunning (void )
Return true if the manufacturing library is currently running.
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.
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.
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.
68
of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h
emberAfMfglibStart#
void emberAfMfglibStart (bool wantCallback)
Start the manufacturing test mode.
N/A | wantCallback | Indicates whether to enable the receive callback and tabulate statistics. |
76
of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h
emberAfMfglibStop#
void emberAfMfglibStop (void )
Stop the manufacturing test mode.
N/A |
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.
N/A | packetsReceived | Total number of packets received during the test. |
N/A | savedRssiReturn | RSSI from the first received packet. |
N/A | savedLqiReturn | LQI from the first received packet. |
92
of file app/framework/plugin/manufacturing-library-cli/manufacturing-library-cli-plugin.h