https://github.com/slametps/MMM-NetworkConnection

Network Connection Status (ping, download, upload) Module for MagicMirror2
https://github.com/slametps/MMM-NetworkConnection

Last synced: 22 days ago
JSON representation

Network Connection Status (ping, download, upload) Module for MagicMirror2

• Host: GitHub
• URL: https://github.com/slametps/MMM-NetworkConnection
• Owner: slametps
• Created: 2018-05-12T09:48:29.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T19:40:18.000Z (over 1 year ago)
• Last Synced: 2024-08-04T10:03:21.325Z (4 months ago)
• Language: JavaScript
• Size: 33.2 KB
• Stars: 33
• Watchers: 3
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-mmm - **MMM-NetworkConnection**

README

        
# MMM-NetworkConnection [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)]

Network Connection Status (ping, download, upload) Module for MagicMirror2.

This module combines [internet-monitor](https://github.com/ronny3050/internet-monitor) and [MMM-connection-status](https://github.com/sheyabernstein/MMM-connection-status).

## Example

![](others/MMM-NetworkConnection-screenshot-01.png)	![](others/MMM-NetworkConnection-screenshot-02.png)

## Dependencies

* An installation of [MagicMirror2](https://github.com/MichMich/MagicMirror)

* [speedtest-net](https://www.npmjs.com/package/speedtest-net) module of nodejs

## Installation

1. Clone this repo into `~/MagicMirror/modules` directory.

2. Go to `~/MagicMirror/modules/MMM-NetworkConnection` directory and do `npm install`

3. Configure your `~/MagicMirror/config/config.js`:

    ```

    {

        module: 'MMM-NetworkConnection',

        position: 'top_right',

        config: {

        }

    }

    ```

## Config Options

| **Option** | **Default** | **Description** |

| --- | --- | --- |

| `updateInterval` | `600000 ms` (10 minutes) | how often should the devices states refreshed |

| `maxTime` | `5000` milliseconds | how long to do speedtest |

| `initialLoadDelay` | `2500` milliseconds | how long to delay to load the module |

| `decimal` | `1` | how many decimals for the round |

| `displayTextStatus` | `true` | display connection text status or not |

| `animationSpeed` | `2500` milliseconds | speed of the update animation |