vladoatanasov / MMM-Roomba

Roomba980 module for the Magic Mirror.

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.

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

• Dorita980 (installed via npm install)