https://github.com/relm923/MMM-Roomba

Roomba980 module for the Magic Mirror.
https://github.com/relm923/MMM-Roomba

magic-mirror magic-mirror-modules roomba roomba980

Last synced: 3 months ago
JSON representation

Roomba980 module for the Magic Mirror.

• Host: GitHub
• URL: https://github.com/relm923/MMM-Roomba
• Owner: relm923
• License: mit
• Created: 2018-02-10T20:35:32.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T02:33:52.000Z (over 1 year ago)
• Last Synced: 2024-06-29T09:33:11.932Z (5 months ago)
• Topics: magic-mirror, magic-mirror-modules, roomba, roomba980
• Language: JavaScript
• Size: 644 KB
• Stars: 10
• Watchers: 4
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-mmm - **MMM-Roomba**

README

        
# MMM-Roomba

This is a module for the [MagicMirror²](https://github.com/MichMich/MagicMirror/). It pulls data (name + job, bin and battery status) from a Roomba running on the local network using [Dorita980](https://github.com/koalazak/dorita980) and displays them on the mirror.

![Alt text](/screenshots/charging_full.png?raw=true "Screenshot")

## Installation

1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/relm923/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:

```js

var config = {

    modules: [

        {

            module: 'MMM-Roomba',

            position: 'top_right',

            header: 'Roomba', // Optional

            config: {

                // See below for configurable options

                robots: [

                    {

                        username: 'xxxxxxxxxxxxx',

                        password: ':1:1486937829:gktkDoYpWaDxCfGh',

                        ipAddress: '192.168.1.44'

                    }

                ]

            }

        }

    ]

}

```

## Configuration options

| Option               | Description

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

| `robots`             | *Required* Array of robot objects. See below

| `robots[].username`  | *Required* Username of Roomba. See [Dorita980](https://github.com/koalazak/dorita980) for more information.

| `robots[].password`  | *Required* Password of Roomba. See [Dorita980](https://github.com/koalazak/dorita980) for more information.

| `robots[].ipAddress` | *Required* Local IP address of Roomba. See [Dorita980](https://github.com/koalazak/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)

## Known Issues

- Error: `SSL routines:OPENSSL_internal:NO_CIPHER_MATCH` - Node v12

  Solution: `ROBOT_CIPHERS=AES128-SHA` before staring MagicMirror

## Dependencies

- [Dorita980](https://github.com/koalazak/dorita980) (installed via `npm install`)