Plugin Commands: Throughput#

The throughput commands allow you to test your application's network throughput

Macros#

#define

plugin throughput set-all [nodeId:2] [count:2] [interval:2] [packet:1] [inflight_count:1] [apsOptions:2] [timeout:4]

#define
#define

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_CLEAR_COUNTERS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_CLEAR_COUNTERS

plugin throughput clear-counters

  • Clear all the stack counters


Definition at line 6864 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_COUNTERS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_COUNTERS

plugin throughput print-counters

  • Print the stack counters


Definition at line 6869 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_PARAMETERS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_PARAMETERS

plugin throughput print-parameters

  • Print all the test parameters


Definition at line 6874 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_RESULT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_PRINT_RESULT

plugin throughput print-result

  • Show the results of the last test.


Definition at line 6879 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_ALL#

#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


Definition at line 6891 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_APS_ACK_OFF#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_APS_ACK_OFF

plugin throughput set-aps-ack-off

  • Turn off APS acks


Definition at line 6896 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_APS_ACK_ON#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_APS_ACK_ON

plugin throughput set-aps-ack-on

  • Turn on APS acks


Definition at line 6901 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_COUNT#

#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


Definition at line 6907 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_DESTINATION#

#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


Definition at line 6913 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_INFLIGHT#

#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


Definition at line 6919 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_INTERVAL#

#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


Definition at line 6925 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_PACKET_SIZE#

#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


Definition at line 6931 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_SET_TIMEOUT#

#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


Definition at line 6937 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_START#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_START

plugin throughput start

  • Start the throughput test.


Definition at line 6942 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_STOP#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_THROUGHPUT_PLUGIN_THROUGHPUT_STOP

plugin throughput stop

  • Abort the test while running.


Definition at line 6947 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc