Plugin Commands: Throughput
Detailed Description
The throughput commands allow you to test your application's network throughput
Macro Definition Documentation
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_CLEAR_COUNTERS |
plugin throughput clear-counters
- Clear all the stack counters
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_COUNTERS |
plugin throughput print-counters
- Print the stack counters
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_PARAMETERS |
plugin throughput print-parameters
- Print all the test parameters
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_RESULT |
plugin throughput print-result
- Show the results of the last test.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_ALL |
plugin throughput set-all [nodeId:2] [count:2] [interval:2] [packet:1] [inflight_count:1] [apsOptions:2] [timeout:4]
- Set all parameters: Destination Count Interval packetLength maxInFlight testTimeout
- nodeId - INT16U - Destination nodeId
- count - INT16U - Packets to send
- interval - INT16U - Interval in ms
- packet - INT8U - Packet length in bytes
- inflight_count - INT8U - Packets in flight
- apsOptions - INT16U - APS Options
- timeout - INT32U - Timeout in ms
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_APS_ACK_OFF |
plugin throughput set-aps-ack-off
- Turn off APS acks
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_APS_ACK_ON |
plugin throughput set-aps-ack-on
- Turn on APS acks
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_COUNT |
plugin throughput set-count [count:2]
- Set the number of packets to send
- count - INT16U - Packets to send
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_DESTINATION |
plugin throughput set-destination [nodeId:2]
- Set the destination nodeId
- nodeId - INT16U - Destination nodeId
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_INFLIGHT |
plugin throughput set-inflight [inflight_count:1]
- Set the number of packets in flight during the test.
- inflight_count - INT8U - Packets in flight
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_INTERVAL |
plugin throughput set-interval [interval:2]
- Set the interval
- interval - INT16U - Interval in ms
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_PACKET_SIZE |
plugin throughput set-packet-size [packet:1]
- Set the packet length
- packet - INT8U - Packet length in bytes
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_TIMEOUT |
plugin throughput set-timeout [timeout:4]
- Set the test timeout
- timeout - INT32U - Timeout in ms
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_START |
plugin throughput start
- Start the throughput test.
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_STOP |
plugin throughput stop
- Abort the test while running.