Skip to content
A MagicMirror² Module to show the Interface throughput of an Ubiquity EdgeRouter
JavaScript TypeScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Added installation documentation Jul 30, 2019
src Reduced fetch interval Jul 30, 2019
.gitignore
MMM-edgerouter-throughput.js
README.md
node_helper.js
package-lock.json Released 1.0.0 Jul 30, 2019
package.json Released 1.0.0 Jul 30, 2019
rollup.config.js Created the node helper and throughput output Jul 28, 2019
tsconfig.json

README.md

EdgeRouter Throughput

A MagicMirror² Module to show the interface throughput of an Ubiquity EdgeRouter.

The Module uses SSH to connect to the router and reads the network throughput from /sbin/ifstat.

Example of the Module

Installation

  1. Clone the Repo into your MagicMirror modules folder git clone git@github.com:mscharl/MMM-edgerouter-throughput.git
  2. Install some node dependencies cd MMM-edgerouter-throughput && npm install --production
  3. Configure and enjoy

Configuration

Property Type Required Default Description
gateway string ✔︎ The IP Address of your EdgeRouter
username string ✔︎ The username of your EdgeRouter with SSH access.
password string ✔︎ The password of your EdgeRouter with SSH access.
interface string ✔︎ The interface to display on the mirror.
title string undefined An optional title to display on the mirror.
showInterfaceName boolean false Whether to show the name of the interface or not.

Compatibility

I developed this module based on my EdgeRouter X with nothing additionally installed.

I can't guarantee that it will work on other devices. But I guess it should work, as long as it's possible to connect via SSH and the ifstat command is available under /sbin.

You can’t perform that action at this time.