espressif/iperf-cmd

0.1.3

uploaded 7 months ago
Iperf command based on esp-idf console
Readme Changelog Dependencies 2 Dependents 0 Examples 1

readme

Iperf command

This repository contains iperf command based esp-idf console.

Documentation

Supported commands:

  • Part of official iperf (2.0): https://iperf.fr/iperf-doc.php#doc

    • note: iperf3 has not been supported.

  • And iperf --abort

    Plaintext

    iperf  [-suV] [-c <host>] [-p <port>] [-l <length>] [-i <interval>] [-t <time>] [-b <bandwidth>] [-f <format>] [--abort]
  iperf command to measure network performance, through TCP or UDP connections.
  -c, --client=<host>  run in client mode, connecting to <host>
  -s, --server  run in server mode
    -u, --udp  use UDP rather than TCP
  -V, --ipv6_domain  Set the domain to IPv6 (send packets over IPv6)
  -p, --port=<port>  server port to listen on/connect to
  -l, --len=<length>  Set read/write buffer size
  -i, --interval=<interval>  seconds between periodic bandwidth reports
  -t, --time=<time>  time in seconds to transmit for (default 10 secs)
  -b, --bandwidth=<bandwidth>  bandwidth to send at in Mbits/sec
  -f, --format=<format>  'k' = Kbits/sec 'm' = Mbits/sec
      --abort  abort running iperf

Installation

  • To add a plugin command or any component from IDF component manager into your project, simply include an entry within the idf_component.yml file.

    Yaml

    dependencies:
  espressif/iperf_cmd:
    version: "^0.1.3"

  • For more details refer IDF Component Manager

api

API Reference

Header files

File iperf_cmd.h

Functions

Type Name
esp_err_t iperf_cmd_register_iperf (void)
Registers console commands: iperf.

Macros

Type Name
define app_register_iperf_commands iperf_cmd_register_iperf

Functions Documentation

function iperf_cmd_register_iperf

Registers console commands: iperf.

C

esp_err_t iperf_cmd_register_iperf (
    void
)

Returns:

ESP_OK on success

Macros Documentation

define app_register_iperf_commands

C

#define app_register_iperf_commands iperf_cmd_register_iperf

Links

Supports all targets

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "espressif/iperf-cmd^0.1.3"

or download archive

Stats

  • Archive size
    Archive size ~ 11.70 KB
  • Downloaded in total
    Downloaded in total 8.3k times
  • Downloaded this version
    This version: 4.4k times

Badge

espressif/iperf-cmd version: 0.1.3
|
report abuse