https://github.com/legion2/mmm-online-state

Displays the network connection availability of the browser.
https://github.com/legion2/mmm-online-state

magic-mirror-modules

Last synced: 3 months ago
JSON representation

Displays the network connection availability of the browser.

• Host: GitHub
• URL: https://github.com/legion2/mmm-online-state
• Owner: Legion2
• License: apache-2.0
• Created: 2020-03-02T18:47:15.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-04T10:41:17.000Z (about 5 years ago)
• Last Synced: 2024-12-28T05:42:03.656Z (5 months ago)
• Topics: magic-mirror-modules
• Language: JavaScript
• Size: 20.5 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MMM-Online-State

Displays the network connection availability of the browser.

This MagicMirror Module uses the `Navigator.onLine` [Browser API](https://whatwebcando.today/online-state.html) to check if there is a network connection.

![Screenshot of online state](online_state_screenshot.png)

## Installation

Run these commands at the root of your magic mirror install.

```sh

cd modules

git clone https://github.com/Legion2/MMM-Online-State.git

```

## Configuration Options

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

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

| `displaySymbol` | `true`      | Display the state as symbol                                                                |

| `displayText`   | `false`     | Display the state as text                                                                  |

| `symbolOnline`  | `wifi`      | The symbol for the online state. See [Font Awsome](http://fontawesome.io/icons/) website.  |

| `symbolOffline` | `wifi`      | The symbol for the offline state. See [Font Awsome](http://fontawesome.io/icons/) website. |

| `colored`       | `true`      | Should the symbols be colored.                                                             |

| `colorOnline`   | `#fff`      | The color for the online state.                                                            |

| `colorOffline`  | `red`       | The color for the offline state.                                                           |