https://github.com/mrVragec/MMM-uptimerobot

MagicMirror² Module to see uptime data from https://uptimerobot.com/
https://github.com/mrVragec/MMM-uptimerobot

Last synced: 3 months ago
JSON representation

MagicMirror² Module to see uptime data from https://uptimerobot.com/

• Host: GitHub
• URL: https://github.com/mrVragec/MMM-uptimerobot
• Owner: mrVragec
• License: mit
• Created: 2017-04-20T21:58:15.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-10-14T19:02:03.000Z (about 6 years ago)
• Last Synced: 2024-06-29T10:33:05.454Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 549 KB
• Stars: 16
• Watchers: 4
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-uptimerobot**

README

        
# MMM-uptimerobot [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mrVragec/MMM-uptimerobot/raw/master/LICENSE) [![Build Status](https://api.travis-ci.org/mrVragec/MMM-uptimerobot.svg?branch=master)](https://travis-ci.org/mrVragec/MMM-uptimerobot) [![Known Vulnerabiliries](https://snyk.io/test/github/mrvragec/mmm-uptimerobot/badge.svg)](https://snyk.io/test/github/mrvragec/mmm-uptimerobot) [![Code Climate](https://codeclimate.com/github/mrVragec/MMM-uptimerobot/badges/gpa.svg)](https://codeclimate.com/github/mrVragec/MMM-uptimerobot)

MagicMirror² to get uptime data from http://uptimerobot.com API. 

## Examples

![](.github/text.png) ![](.github/text_color.png) ![](.github/icons.png) ![](.github/icons_color.png)

## Instalation

1. Clone this repository in your MagicMirror installation under modules.

2. Rename plugin foler from 'MMM-uptimerobot' to 'uptimerobot'

3. Add configuration to config.js

## Using the module

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

```js

var config = {

    modules: [

        {

            module: 'uptimerobot',

            config: {

                // See below for configurable options

            }

        }

    ]

}

```

## Requirements

No special requirements or dependencies. 

## Configuration options

| Option           | Description

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

| `api_key`        | *Required* API Key from https://uptimerobot.com. API Key is available under 'My Settings' in 'API Setting' section (click on Show/hide it and if not available generate new one).

| `useIcons`       | *Optional* Flag to use icons (true) or text (false) values for status of monitor. 

**Type:** `boolean` 
Default: false - text values.

| `useColors`      | *Optional* Flag to use colors (true) for status of monitor

**Type:** `boolean` 
Default: false - without colors.

| `maximumEntries` | *Optional* Number of items (monitors) to shown. 

**Type:** `int` 
Default: 10 items.

| `statuses`       | *Optional* Filter out monitor by status (0 - paused; 1 - not checked yet; 2 - up; 8 - seems down; 9 - down

**Type:** `String` 
Default: 0-1-2-8-9 (show monitors with all statuses).