Skip to content
Roomba980 module for the Magic Mirror.
JavaScript CSS
Branch: master
Clone or download
Latest commit 642acd1 Apr 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
screenshots Initial Commit Feb 10, 2018
translations Add Stuck Status Oct 12, 2018
.eslintrc.json Initial Commit Feb 10, 2018
.gitignore Initial Commit Feb 10, 2018
.stylelintrc Initial Commit Feb 10, 2018
CHANGELOG.md Update dependencies Apr 12, 2019
Gruntfile.js Initial Commit Feb 10, 2018
LICENSE.txt Initial Commit Feb 10, 2018
MMM-Roomba.css Rename to MMM-Roomba Feb 24, 2018
MMM-Roomba.js Update icons to Font-awesome 5 Jan 5, 2019
README.md Rename to MMM-Roomba Feb 24, 2018
node_helper.js Rename to MMM-Roomba Feb 24, 2018
package-lock.json Update dependencies Apr 12, 2019
package.json Update dependencies Apr 12, 2019

README.md

MMM-Roomba

This is a module for the MagicMirror². It pulls data (name + job, bin and battery status) from a Roomba running on the local network using Dorita980 and displays them on the mirror.

Alt text

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/relm/MMM-Roomba.git. A new folder will appear navigate into it.
  2. Execute npm install to install the node dependencies.

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-Roomba',
            position: 'top_right',
            header: 'Roomba', // Optional
            config: {
                // See below for configurable options
                username: 'xxxxxxxxxxxxx',
                password: ':1:1486937829:gktkDoYpWaDxCfGh',
                ipAddress: '192.168.1.44'
            }
        }
    ]
}

Configuration options

Option Description
username Required Username of Roomba. See Dorita980 for more information.
password Required Password of Roomba. See Dorita980 for more information.
ipAddress Required Local IP address of Roomba. See Dorita980 for more information.
updateInterval Optional How often the content will be fetched.

Type: int(milliseconds)
Default 60000 (1 minute)
animationSpeed Optional Speed of the update animation.

Type: int(milliseconds)
Default 2000 milliseconds (2 seconds)

Dependencies

You can’t perform that action at this time.