Git Product home page Git Product logo

record-wifi-speed's Introduction

Record the speed of your Wi-Fi connection

Think your Wi-Fi connection is slow and want a record to show your internet provider? Look no further ๐Ÿ˜ƒ.

Each time you record the WiFi's speed the results are appended to a records.txt file in JSON format. A set of charts can then be generated from this data.

[
  {"ping":38,"download":21.2,"upload":18,"day":"24/06/2019","time":"16:50"},
  {"ping":39,"download":22,"upload":17.6,"day":"24/06/2019","time":"17:50"},
  {"ping":54,"download":22.8,"upload":18,"day":"24/06/2019","time":"18:50"},
  ...
]

Download chart

Install

npm install --global record-wifi-speed

Usage

Arguments

  • wifiName: The name of the Wi-Fi network you wish to record the speed of. For example PLUSNET-1234.
  • resultsDirectory: The directory which will contain the results of the speed tests and the generated charts. For example C:\Users\Bob\results. The directory will be generated with the following content:
results/
โ”œโ”€โ”€ records.txt
โ””โ”€โ”€ charts/
    โ”œโ”€โ”€ download.html
    โ”œโ”€โ”€ download.png
    โ”œโ”€โ”€ download.svg
    โ”œโ”€โ”€ ping.html
    โ”œโ”€โ”€ ping.png
    โ”œโ”€โ”€ ping.svg
    โ”œโ”€โ”€ upload.html
    โ”œโ”€โ”€ upload.png
    โ””โ”€โ”€ upload.svg
  • numberOfGroups (optional): The number of bars (groups) there will be on the generated charts. If this argument isn't provided then the default is 5.

Node

const { speedTest, generateCharts } = require('record-wifi-speed')

const wifiName = '...'
const resultsDirectory = '...'
const numberOfGroups = 10 // Optional argument, defaults to 5

speedTest({ wifiName, resultsDirectory })
generateCharts({ resultsDirectory, numberOfGroups })

CLI

You must have installed record-wifi-speed globally to run it on the CLI.

rws-run <wifiName> <resultsDirectory>
rws-charts <resultsDirectory> --number-of-groups <numberOfGroups>

Executable

You must have installed record-wifi-speed globally to run the executable.

The command rws-package creates an executable called record-wifi-speed.exe in your current directory.

rws-package
./record-wifi-speed.exe <wifiName> <resultsDirectory>

You might want to create a scheduled task which runs this executable periodically (for example with Windows Task Scheduler). It would then record your Wi-Fi speed in the background every period.

Updating from v1 to v2

See release notes

record-wifi-speed's People

Contributors

dependabot[bot] avatar sievins avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Forkers

classicvalues

record-wifi-speed's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.