Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-roborock-vacuum

tasict287MIT1.2.3

Roborock Vacuum Cleaner - plugin for Homebridge.

homebridge-plugin, vacuum cleaner, roborock app, roborock vacuum

readme

homebridge-roborock-vacuum

Roborock Vacuum in Home App

A Homebridge plugin to integrate your Roborock vacuum cleaner with Apple HomeKit, allowing you to control it via the Home app and Siri.

Introduction

homebridge-roborock-vacuum brings your Roborock vacuum cleaner into Apple HomeKit. Using your Roborock app account credentials, this plugin automatically detects your vacuum, enabling you to control it directly from the Home app on your iPhone, iPad, or Mac, or with Siri voice commands.

This plugin is inspired by and adapted from the ioBroker.roborock project by copystring.

Features

  • Automatic Device Detection: No need to manually find or enter your vacuum's device ID.
  • Start/Stop Cleaning: Begin or end cleaning sessions.

The supported robots are:

Roborock S4 Roborock S4 Max Roborock S5 Max Roborock S6 Roborock S6 Pure Roborock S6 MaxV Roborock S7 Roborock S7 MaxV (Ultra) Roborock Q7 Roborock Q7 Max Roborock S7 Pro Ultra Roborock S7 Max Ultra Roborock S8 Roborock S8 Pro Ultra Roborock Q Revo Roborock Q8 Max Roborock Q5 Pro Roborock Q Revo Pro Roborock Qrevo S Roborock Qrevo Curve

Requirements

Before installing, ensure you have:

  • A Roborock vacuum cleaner compatible with the Roborock app.
  • A Roborock app account (email and password).
  • Homebridge installed on a server (e.g., Raspberry Pi).
  • Node.js and npm installed on your Homebridge server.

Installation

Follow these steps to install the plugin:

  1. Install Homebridge (if not already installed):

  2. Install the Plugin:

    • Open a terminal and run: `bash npm install -g homebridge-roborock-vacuum

changelog

Changelog

1.2.2

  • New Feature: Dynamic Scene Switch Management
    • Automatically create HomeKit switch buttons for each device's available scenes
    • Scene switches named after scene names with momentary switch behavior
    • Automatically add/remove corresponding switch buttons when scenes change
    • Execute corresponding scenes when switches are pressed, with error handling and status feedback
    • Synchronize scene switches when HomeData is updated
  • Improvement: Refactored scene API methods, separated scene fetching and device filtering functionality
  • Fix: Resolved recursive call issue in scene methods

1.0.15

  • Fix Roborock Saros 10R Status issue

1.0.6

  • Support new model

1.0.0

  • First version.