jnchman / homebridge-xiaomi-roborock-vacuum

A Xiaomi Roborock vaccum plugin (1st, 2nd generation) for homebridge.

Home Page:https://www.loggn.de

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PayPal Donate npm version dependencies Status

homebridge-xiaomi-roborock-vacuum

Homebridge Plugin für Xiaomi Roborock's

Mit diesem Homebridge Plugin kann man die Xiaomi Saugroboter (Roborock) in Apple HomeKit, als Ventilator/Lüfter einbinden.

Dieses Plugin nutzt, glücklicherweise, die miio Version 0.15.6 oder neuer, nicht wie viele andere Plugins Version 0.14.1. Damit gehören Timeouts, API-Fehler vorerst der Vergangenheit an!

Xiaomi Mi Robot 1st Generation (Roborock Vacuum V1)   Xiaomi Roborock S50 2nd Generation (Roborock Vacuum S5)

Features

  • Ventilator/Lüfter als Ein-/Aus-Schalter. Beim Ausschalten, direkt zurück zur Ladestation.
  • Geschwindigkeitsstufen per 3D-Touch / Force-Touch einstellbar.
    • Off (0%)
    • Quiet (1-38%)
    • Balanced (39-60%)
    • Turbo (61-77%)
    • Max Speed (78-100%)
  • Batteriestatus und Zustand in den Gerätedetails. Warnung bei niedrigem Batteriestand.
  • Schalter für Pause (Optional).
  • Belegesensor (ähnlich Bewegungssensor) für Dockstatus (Optional).

Screenshot Apple HomeKit with homebridge-xiaomi-roborock-vacuum

Anleitung

  1. Plugin installieren mit npm install -g homebridge-xiaomi-roborock-vacuum --unsafe-perm.
  2. Homebridge Konfiguration config.json anpassen.
  3. Homebridge neustarten, ggf. service homebridge restart.
  • Beispiel config.json mit einem Saugroboter:
"accessories": [
 {
  "accessory": "XiaomiRoborockVacuum",
  "name": "Xiaomi Mi Robot Vaccum 1st Generation",
  "ip": "192.168.1.150",
  "token": "abcdef1234567890abcdef1234567890",
  "pause": false,
  "dock": true
 }
],
  • Beispiel config.json mit zwei Saugrobotern:
"accessories": [
 {
  "accessory": "XiaomiRoborockVacuum",
  "name": "Xiaomi Mi Robot Vaccum 1st Generation",
  "ip": "192.168.1.150",
  "token": "abcdef1234567890abcdef1234567890",
  "pause": false,
  "dock": true
 },
 {
  "accessory": "XiaomiRoborockVacuum",
  "name": "Xiaomi Roborock S50 Vaccum 2nd Generation",
  "ip": "192.168.1.151",
  "token": "1234567890abcdef1234567890abcdef",
  "pause": false,
  "dock": true
 }
],

Optionale Parameter

Parameter Standard Erklärung
pause false Zeigt einen zusätzlichen Schalter für "Pause" an
dock false Zeigt einen Belegesensor für den Dockstatus an

Xiaomi Token

Um dieses Plugin nutzen zu können, muss man den sogenannten "Token" des Xiaomi Saugrobters auslesen. Hier ein paar ausführliche Anleitungen:

Versionsverlauf

0.2.0

  • Plugin komplett überarbeitet, Logik verändert.
  • Verbindungsaufbau über miio-API sauberer abgebildet.
  • Fix für UnhandledPromiseRejectionWarning.

0.1.5

  • ERROR-Meldungen der miio-API hinzugefügt.

0.1.4

  • Fix wenn pause / dock in config.json aktiviert .
  • Fix für "cannot read property getCharacteristic of undefined".

0.1.3

  • Statusausgaben hinzugefügt (Homebridge-Log).
  • zweiter Fix für UnhandledPromiseRejectionWarning.
  • README ergänzt.

0.1.2

  • Fix für UnhandledPromiseRejectionWarning.
  • Geräteinformationen (Model, Seriennummer und Firmwareversion) werden beim Start angezeigt.
  • README angepasst.

0.1.1

  • README korrigiert.

0.1.0

  • Plugin veröffentlicht.

Lizenz

The MIT License (MIT)

Copyright (c) 2018 Nico Hartung

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A Xiaomi Roborock vaccum plugin (1st, 2nd generation) for homebridge.

https://www.loggn.de


Languages

Language:JavaScript 100.0%