Skip to content

Monitors internet statistics such as strength and speed information on a smart mirror.

License

Notifications You must be signed in to change notification settings

BrianHepler/internet-monitor

 
 

Repository files navigation

internet-monitor

A MagicMirror² module to monitor internet statistics such as strength and speed information.

This is a fork of ronny3050's module with some modifications to get it working again.

Monitor Visualization Minimal Visualization StrengthFullscreen Visualization

Installation

To install the module, just clone this repository to your modules folder:

git clone https://github.com/BrianHepler/internet-monitor.

Then run cd internet-monitor and npm install which will install the dependencies.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
 {
     module: 'internet-monitor',
            position: 'top_center',
            header: 'Internet Monitor',
            config:{
                type: '',
                maxTime: 20000,
                updateInterval: 0,
                verbose: false,
                serverId: 54504,
                displayStrength: true,
                displaySpeed: true,
                strengthIconSize: 80,
                maxGaugeScale: 100,
            },
 }
]

You can also customize the wifi symbol.

modules: [
 {
     module: 'internet-monitor',
            position: 'top_center',
            header: 'Internet Monitor',
            config:{
                type: '',
                maxTime: 20000,
                updateInterval: 0,
                verbose: false,
                displayStrength: true,
                displaySpeed: true,
                strengthIconSize: 80,
                maxGaugeScale: 100,
                wifiSymbol:{
                    size: 50,
                    fullColor: '#3afc25',
                    almostColor: '#ffff0c',
                    halfColor: '#ff8c00',
                    noneColor: '#ff1111'
                    },
            },
    }
]

Configuration options

The following properties can be configured:

Option Description
type Style of the speed gauges
Possible values: 'minimal' Minimalistic Style as shown in the second image above.
Default value: ''
updateInterval Time to rerun/update tests (Milliseconds)
Default value: 0
Please note that updateInterval has to be greater than maxTime
displayStrength Display Internet Strength
Possible values: true or false
Default value: true
displaySpeed Display download and upload speed gauges
Possible values: true or false
Default value: true
strengthIconSize Size of the strength icon
Default value: 80
maxGuageScale Maximum gauge value (Mbps)
Default value: 100
serverId Test against specific SpeedTest server (optional)
Default value: ''
List of servers can be found at SpeedTest.
wifiSymbol Customize WiFi Symbol (Optional)

  • size Size of the WiFi Symbol
  • fullColorHex color code for full strength               
  • almostColorHex color code for almost strength        
  • halfColorHex color code for half strength              
  • noneColorHex color code for 0 strength                 

About

Monitors internet statistics such as strength and speed information on a smart mirror.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 64.7%
  • CSS 35.3%