{"id":13830274,"url":"https://github.com/relm923/MMM-Roomba","last_synced_at":"2025-07-09T11:32:32.775Z","repository":{"id":29744397,"uuid":"121051983","full_name":"relm923/MMM-Roomba","owner":"relm923","description":"Roomba980 module for the Magic Mirror.","archived":false,"fork":false,"pushed_at":"2023-03-04T02:33:52.000Z","size":659,"stargazers_count":10,"open_issues_count":4,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-04T10:02:48.227Z","etag":null,"topics":["magic-mirror","magic-mirror-modules","roomba","roomba980"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/relm923.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-10T20:35:32.000Z","updated_at":"2024-08-04T10:02:52.543Z","dependencies_parsed_at":"2024-08-04T10:13:00.010Z","dependency_job_id":null,"html_url":"https://github.com/relm923/MMM-Roomba","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relm923%2FMMM-Roomba","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relm923%2FMMM-Roomba/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relm923%2FMMM-Roomba/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relm923%2FMMM-Roomba/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/relm923","download_url":"https://codeload.github.com/relm923/MMM-Roomba/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225539367,"owners_count":17485313,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magic-mirror","magic-mirror-modules","roomba","roomba980"],"created_at":"2024-08-04T10:00:58.102Z","updated_at":"2024-11-20T11:30:35.732Z","avatar_url":"https://github.com/relm923.png","language":"JavaScript","funding_links":[],"categories":["Home Automation \u0026 Notifications"],"sub_categories":[],"readme":"# MMM-Roomba\n\nThis 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.\n\n![Alt text](/screenshots/charging_full.png?raw=true \"Screenshot\")\n\n## Installation\n\n1. 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.\n2. Execute `npm install` to install the node dependencies.\n\n## Using the module\n\nTo use this module, add the following configuration block to the modules array in the `config/config.js` file:\n\n```js\nvar config = {\n    modules: [\n        {\n            module: 'MMM-Roomba',\n            position: 'top_right',\n            header: 'Roomba', // Optional\n            config: {\n                // See below for configurable options\n                robots: [\n                    {\n                        username: 'xxxxxxxxxxxxx',\n                        password: ':1:1486937829:gktkDoYpWaDxCfGh',\n                        ipAddress: '192.168.1.44'\n                    }\n                ]\n            }\n        }\n    ]\n}\n```\n\n## Configuration options\n\n| Option               | Description\n|--------------------- |-----------\n| `robots`             | *Required* Array of robot objects. See below\n| `robots[].username`  | *Required* Username of Roomba. See [Dorita980](https://github.com/koalazak/dorita980) for more information.\n| `robots[].password`  | *Required* Password of Roomba. See [Dorita980](https://github.com/koalazak/dorita980) for more information.\n| `robots[].ipAddress` | *Required* Local IP address of Roomba. See [Dorita980](https://github.com/koalazak/dorita980) for more information.\n| `updateInterval`     | *Optional* How often the content will be fetched. \u003cbr\u003e\u003cbr\u003e**Type:** `int`(milliseconds) \u003cbr\u003eDefault 60000 (1 minute)\n| `animationSpeed`     | *Optional* Speed of the update animation. \u003cbr\u003e\u003cbr\u003e**Type:** `int`(milliseconds) \u003cbr\u003eDefault 2000 milliseconds (2 seconds)\n\n## Known Issues\n\n- Error: `SSL routines:OPENSSL_internal:NO_CIPHER_MATCH` - Node v12\n\n  Solution: `ROBOT_CIPHERS=AES128-SHA` before staring MagicMirror\n\n## Dependencies\n\n- [Dorita980](https://github.com/koalazak/dorita980) (installed via `npm install`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelm923%2FMMM-Roomba","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelm923%2FMMM-Roomba","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelm923%2FMMM-Roomba/lists"}