Skip to content

Doggi/MMM-SpeedtestTracker

Repository files navigation

MMM-SpeedtestTracker

This is a module for the MagicMirror².

This module displays the last measured values from the speed test tracker. The module uses the REST interface of the application and does not take any measurements itself.

Required: https://github.com/alexjustesen/speedtest-tracker

Using the module

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

var config = {
  modules: [
    {
      module: "MMM-SpeedtestTracker",
      config: {
        url: "http://192.168.0.1",
        // See below for configurable options
      },
    },
  ],
};

Configuration options

Option Description
url Required Url to the speed test tracker

Type: string
Example: http://192.168.0.1
showDownload Optional Display the latest Download Speed

Type: boolean
Default: true
showUpload Optional Display the latest Upload Speed

Type: boolean
Default: true
showPing Optional Display the latest Ping in milliseconds

Type: boolean
Default: true
showServerName Optional Display the latest used server name

Type: boolean
Default: false
showDate Optional Display the date time from the latest result

Type: boolean
Default: false
updateInterval Optional The interval in milliseconds at which new data should be retrieved by the application

Default: 60000 milliseconds (1 minute)
retryDelay Optional The time to wait if a request for data has failed in milliseconds

Default: 5000 milliseconds (5 seconds)
dateFromatOptions Optional Here you can define the formatting of the datetime of the last result, using the function Date.toLocaleString for more details please read here: (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString)

Default:
speedFormatOptions Optional Here you can define the formatting of the download and upload, the function Intl.NumberFormat is used for more details please read here: (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)

Default:
pingFormatOptions Optional Here you can define the formatting of the ping, the function Intl.NumberFormat is used for more details please read on here: (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)

Default:

dateFromatOptions:

{
  "localeMatcher": "best fit",
  "timeZone": "Europe/Berlin",
  "hour12": false,
  "formatMatcher": "best fit",
  "weekday": undefined,
  "era": undefined,
  "year": "numeric",
  "month": "long",
  "day": "numeric",
  "hour": "2-digit",
  "minute": "2-digit",
  "second": "2-digit",
  "timeZoneName": "short"
}

speedFormatOptions:

{
  "style": "unit",
  "unit": "megabit-per-second",
  "unitDisplay": "short",
  "notation": "standard",
  "minimumFractionDigits": 2,
  "maximumFractionDigits": 2
}

pingFormatOptions:

{
  "style": "unit",
  "unit": "millisecond",
  "unitDisplay": "short",
  "minimumFractionDigits": 0,
  "maximumFractionDigits": 0
}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published