{"analyzedAt":"2022-07-01T23:29:06.848Z","collected":{"metadata":{"name":"homebridge-xiaomi-robot-vacuum","scope":"unscoped","version":"1.4.4","description":"Xiaomi Mi robot vacuum plugin for Homebridge. Fork from https://github.com/seikan/homebridge-xiaomi-mi-robot-vacuum","keywords":["homebridge-plugin","xiaomi","mi robot","roborock","vacuum"],"date":"2019-05-23T01:11:51.392Z","publisher":{"username":"clauzewitz","email":"clauzewitz@msn.com"},"maintainers":[{"username":"clauzewitz","email":"clauzewitz@msn.com"}],"repository":{"type":"git","url":"git+https://github.com/clauzewitz/homebridge-xiaomi-robot-vacuum.git"},"links":{"npm":"https://www.npmjs.com/package/homebridge-xiaomi-robot-vacuum","homepage":"https://github.com/clauzewitz/homebridge-xiaomi-robot-vacuum#readme","repository":"https://github.com/clauzewitz/homebridge-xiaomi-robot-vacuum","bugs":"https://github.com/clauzewitz/homebridge-xiaomi-robot-vacuum/issues"},"license":"MIT","releases":[{"from":"2022-06-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0},{"from":"2022-04-02T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":1},{"from":"2022-01-02T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":1},{"from":"2021-07-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":1},{"from":"2020-07-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":1}],"readme":"[![npm version](https://badge.fury.io/js/homebridge-xiaomi-robot-vacuum.svg)](https://badge.fury.io/js/homebridge-xiaomi-robot-vacuum)\n\n# homebridge-xiaomi-robot-vacuum\n\nThis project is forked from [homebridge-xiaomi-mi-robot-vacuum](https://github.com/seikan/homebridge-xiaomi-mi-robot-vacuum).\n\nThis is Xiaomi Mi Robot Vacuum plugin for [Homebridge](https://github.com/nfarina/homebridge). Since Apple Homekit is not supporting vacuum cleaner device yet, this plugin will add the robot as **Fan** to your Home app.\n\n![roborock-vacuum-v1](https://user-images.githubusercontent.com/12408302/54580338-02b61200-4a4b-11e9-9f02-f03827dd5918.jpg)\n![roborock-vacuum-s5](https://user-images.githubusercontent.com/12408302/54580352-106b9780-4a4b-11e9-98a4-92026f8712c4.jpg)\n\n\n\n### Features\n\n* Switch on / off. When off, it will returning to charging dock automatically.\n\n* Control suction power by adjust the fan speed.\n\t+ Xiaomi Mi Robot 1st Generation (Roborock Vacuum V1)\n\t\t- Quiet (1 -38%)\n\t\t- Balance (39 - 60%)\n\t\t- Turbo (61 - 77%)\n\t\t- Max Speed (> 77%)\n\n\t+ Xiaomi Roborock S50 2nd Generation (Roborock Vacuum S5)\n\t\t- Mopping (1 -15%)\n\t\t- Quiet (16 -38%)\n\t\t- Balance (39 - 60%)\n\t\t- Turbo (61 - 75%)\n\t\t- Max Speed (> 76%)\n\n* Display battery level, and notify on low battery.\n\n* Display battery charging state.\n\n* Display filter state.\n\n\n\n### Installation\n\n1. Install required packages.\n\n\t```\n\tnpm install -g homebridge-xiaomi-robot-vacuum miio\n\t```\n\n2. Remove Mi Robot Vaccum from your Mi Home app.\n\n3. Press \"Power\" and \"Home\" button simultaneously and hold for 3 seconds on your Mi Robot Vacuum to reset the Wi-Fi.\n\n\t![mi-robot-reset-wifi](https://cloud.githubusercontent.com/assets/73107/26273343/278c36a2-3d61-11e7-8e08-b5bc25cc407f.png)\n\n4. It will advertised a new Wi-Fi spot similar to`rockrobo-vacuum-v1_xxxx` or `roborock-vacuum-s5_xxxx`.\n\n5. Connect your PC to that Wi-Fi network.\n\n6. Open command prompt or terminal. Run following command to discover the device:\n\n\t```\n\tmiio discover --sync\n\t```\n\n\t**Notes:** This will take about a minute or two.\n\n7. Wait until you get output similar to this:\n\n\t```\n\tDevice ID: 49466045\n\tModel info: Unknown\n\tAddress: 192.168.8.1\n\tToken: 6f7a65786550386b755a6b526666744d via auto-token\n\tSupport: Unknown\n\t```\n\n8. Record down the value value for `Token` as we need it later.\n\n9. Disconnect from robot Wi-Fi network.\n\n10. Open Mi Home app and add the device as usual.\n\n11. In Mi Home app, get the Robot Vacuum IP address from General Settings > Network Info.\n\n12. Check the model name of the vacuum cleaner.\\\n\tIf it is a 1st Generation, write `rockrobo.vacuum.v1`.\\\n\tIf it's a 2nd Generation product, write `roborock.vacuum.s5`.\n\n12. Add these values to `config.json`.\n\n\t```\n\t\t\"accessories\": [\n\t\t\t{\n\t\t\t\t\"accessory\": \"MiRobotVacuum\",\n\t\t\t\t\"name\": \"Vacuum Cleaner\",\n\t\t\t\t\"model\": \"MODEL_DISCOVERED_FROM_STEP_12\",\n\t\t\t\t\"ip\": \"IP_ADDRESS_OF_THE_ROBOT\",\n\t\t\t\t\"token\": \"TOKEN_DISCOVERED_FROM_STEP_7\",\n\t\t\t\t\"showDock\": false,\n\t\t\t\t\"enablePause\": false\n\t\t\t}\n\t\t]\n\t```\n\n\t​Set \"showDock\" to `true` or `false`  to display or hide docked state for the vacuum.\\\n\t​Set \"enablePause\" to `true` or `false`  to display or hide pause button for the vacuum.\n\n13. Restart Homebridge, and your Mi Robot Vacuum will be added to Home app.\n\n\n\n### License\n\nSee the [LICENSE](https://github.com/seikan/homebridge-xiaomi-mi-robot-vacuum/blob/master/LICENSE.md) file for license rights and limitations (MIT)."},"npm":{"downloads":[{"from":"2022-06-30T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0},{"from":"2022-06-24T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":12},{"from":"2022-06-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":102},{"from":"2022-04-02T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":183},{"from":"2022-01-02T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":323},{"from":"2021-07-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":568}],"starsCount":0},"github":{"forkOf":"seikan/homebridge-xiaomi-mi-robot-vacuum","starsCount":3,"forksCount":0,"subscribersCount":2,"issues":{"count":2,"openCount":1,"distribution":{"3600":0,"10800":0,"32400":1,"97200":0,"291600":0,"874800":0,"2624400":0,"7873200":0,"23619600":0,"70858800":1,"212576400":0},"isDisabled":false},"contributors":[{"username":"seikan","commitsCount":12},{"username":"olehs","commitsCount":1},{"username":"clauzewitz","commitsCount":54}],"commits":[{"from":"2022-06-24T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0},{"from":"2022-06-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0},{"from":"2022-04-02T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0},{"from":"2022-01-02T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0},{"from":"2021-07-01T00:00:00.000Z","to":"2022-07-01T00:00:00.000Z","count":0}]},"source":{"files":{"readmeSize":3417,"testsSize":0,"hasNpmIgnore":true}}},"evaluation":{"quality":{"carefulness":0.7899999999999999,"tests":0,"health":1,"branding":0},"popularity":{"communityInterest":8,"downloadsCount":61,"downloadsAcceleration":0.5205289193302891,"dependentsCount":0},"maintenance":{"releasesFrequency":0.28664383561643836,"commitsFrequency":0,"openIssues":0.5,"issuesDistribution":0}},"score":{"final":0.34272707922410084,"detail":{"quality":0.5232869564529817,"popularity":0.039187020808916485,"maintenance":0.49150152858595864}}}