Skip to content

Latest commit

 

History

History
executable file
·
133 lines (104 loc) · 5.96 KB

README.md

File metadata and controls

executable file
·
133 lines (104 loc) · 5.96 KB
Raw

Graphical User Interface for iperf3

screenshot

This is a python 2.7 program to give a graphical front end to iperf3

NOTE: This is a python 2.7 program

If you want to use it with python 3.xx some work will need to be done.

Tested on Ubuntu 14.04, and Windows 10, no guarantees on anything else!

The meter.py code was found on the net somewhere and modified by me, so if you recognize it - credit to whoever you are

See https://iperf.fr/iperf-servers.php for details of the servers included as defaults.

Revision History

V1.2 - Added Yandex maps service due to impending google requirement for API key (both services now supported) V1.1 - Big re-write with new features, including google maps V1.0 : First release

NOTE: You are responsible for complying with all google/Yandex Terms of Service

Introduction

This program has the following features:

  • enter your own server ip/fqdn
  • pre-sets for public iperf3 servers
  • ports configurable (and presets)
  • several (not all) options graphically configurable
  • large gauge display
  • auto ranging
  • works on windows or linux
  • shows ping values
  • gives download and upload speeds
  • shows Distance/City/Country of server
  • shows map of geography
  • saves data in config.ini file

screenshot

Pre-Requisites

You need iperf3 installed. It can be downloaded from here: https://iperf.fr/iperf-download.php

Dependencies

The program will optionally use pyping if you have it installed, otherwise it uses plain old ping.

See:https://pypi.org/project/pyping/ install with pip install pyping

if you don't have a google API key, and you want to use maps, the program will attempt to use the free Yandex service (because OpenStreetMaps is hard to use), which requires the use of PIL/pillow to convert the map image format. if you don't have a google API key, or PIL/pillow, maps will be disabled.

<sudo> pip install pillow

NOTE: This may not work on some platforms

Install

First you need python 2.7 installed. This program will not work with Python 3.x without some work

now clone the repository from GitHub (obviously you need git installed)

git clone https://github.com/NickWaterton/iperf3-GUI.git
cd iperf3-GUI

You should now have the program iperf.py - make sure the file is executable

No need to install anything, you can just run the program as is.

run ./iperf.py -h (or python ./iperf.py -h if you are on windows)

usage: iperf.py [-h] [-I IPERF_EXEC] [-ip [IP_ADDRESS [IP_ADDRESS ...]]]
                [-l LOCAL_IP] [-p PORT] [-r RANGE] [-R] [-m {OFF,Track,Peak}]
                [-G] [-g GOOGLE_API_KEY] [-D] [-V] [-v]

Iperf3 GUI Network Speed Tester

optional arguments:
  -h, --help            show this help message and exit
  -I IPERF_EXEC, --iperf_exec IPERF_EXEC
                        location and name of iperf3 executable
                        (default=D://utils//iperf3.exe)
  -ip [IP_ADDRESS [IP_ADDRESS ...]], --ip_address [IP_ADDRESS [IP_ADDRESS ...]]
                        default server address('s) can be a list
                        (default=[u'192.168.100.119'])
  -l LOCAL_IP, --local_ip LOCAL_IP
                        local public ip address, if not given, will be fetched
                        automatically (default=None)
  -p PORT, --port PORT  server port (default=5201)
  -r RANGE, --range RANGE
                        range to start with in Mbps (default=10)
  -R, --reset_range     Reset range to Default for Upload test (default =
                        True)
  -m {OFF,Track,Peak}, --max_mode {OFF,Track,Peak}
                        Show Peak Mode (default = Peak)
  -G, --geography       Show map data (default = True)
  -g GOOGLE_API_KEY, --google_api_key GOOGLE_API_KEY
                        your google API key (to enable google maps)
                        (default=None)
  -D, --debug           debug mode
  -V, --verbose         print everything
  -v, --version         show program's version number and exit

Quick Start

You need to know the pathname of your iperf3 executable, the default is iperf3, but you can use the -I option to specify the pathname for example on my Windows system I use

python .\iperf.py -I D:\utils\iperf3.exe

Because my iperf3.exe is in my D:/utils directory. Using Linux, the default usually works just fine (if iperf3 was installed using apt-get or is otherwise in your PATH, so you would use:

.\iperf.py

You may need to be Administrator to use ping - it works fine for me as none-Administrator, but read the pyping page (if you are using it).

To test on your local network, you will need another computer running another copy of iperf3 as as server:

.\iperf3 -s

You can then test your local network/wifi speeds against the new server you just started using it's ip address.

If you select a remote server, you can test your actual internet speeds.

You can enter a new server in the 'server' combobox, if it validates as an iperf3 server, the new server (plus maps etc) will be saved in the config.ini file, and automatically loaded the next time the program is started.

You can add your own servers/ip addresses as a command line option -ip as a list of servers - these will not be saved in the config.ini file. Only remote servers are saved in the config.ini file, all local/private ip addresses are stored under your external ip address. If your external ip address cannot be determined, then maps are disabled. Also, if your external ip address changes, then new maps/distances will be stored in the config.ini file - in addition to the existing ones. So if you use a laptop, and move around, various maps/distances will be stored and reused depending on where you are. This is all automatic. If it goes wrong somehow, just delete config.ini and start again.

That's it!