@homebridge-plugins/homebridge-ecovacs/README.md

Homebridge plugin to integrate Ecovacs Deebot devices into HomeKit.

<p align="center">
   <a href="https://github.com/homebridge-plugins/homebridge-ecovacs"><img alt="homebridge-ecovacs" src="https://user-images.githubusercontent.com/43026681/101321841-f0eb5280-385d-11eb-8dd4-f57113f6e078.png" width="600px"></a>
</p>
<span align="center">

# homebridge-ecovacs

Homebridge plugin to integrate Ecovacs Deebot or Yeedi devices into HomeKit

[![npm](https://img.shields.io/npm/v/@homebridge-plugins/homebridge-ecovacs/latest?label=latest)](https://www.npmjs.com/package/@homebridge-plugins/homebridge-ecovacs)
[![npm](https://img.shields.io/npm/v/@homebridge-plugins/homebridge-ecovacs/beta?label=beta)](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Beta-Version)

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[![hoobs-certified](https://badgen.net/badge/HOOBS/certified/yellow?label=hoobs)](https://plugins.hoobs.org/plugin/homebridge-ecovacs)

[![npm](https://img.shields.io/npm/dt/@homebridge-plugins/homebridge-ecovacs)](https://www.npmjs.com/package/@homebridge-plugins/homebridge-ecovacs)
[![Discord](https://img.shields.io/discord/432663330281226270?color=728ED5&logo=discord&label=hb-discord)](https://discord.com/channels/432663330281226270/742733745743855627)

</span>

### Plugin Information

- This plugin allows you to view and control your Ecovacs or Yeedi devices within HomeKit. The plugin:
  - requires your Ecovacs or Yeedi credentials to function
  - uses a cloud-based connection (i.e. requires the internet)

> I'm looking for some lovely people to help maintain this plugin, please get in touch on GitHub or Discord if you'd like to help out 😄

### Prerequisites

- To use this plugin, you will need to already have:
  - [Node](https://nodejs.org): latest version of `v20`, `v22` or `v24` - any other major version is not supported.
  - [Homebridge](https://homebridge.io): `v1.6` - refer to link for more information and installation instructions.

### Setup

- [Installation](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Installation)
- [Configuration](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Configuration)
- [Beta Version](https://github.com/homebridge/homebridge/wiki/How-to-Install-Alternate-Plugin-Versions)
- [Node Version](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Node-Version)

### Features

- [Supported Devices](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Supported-Devices)
- [Speed Control](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Speed-Control)
- [Predefined Areas](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Predefined-Areas)

### Help/About

- [Common Errors](https://github.com/homebridge-plugins/homebridge-ecovacs/wiki/Common-Errors)
- [Support Request](https://github.com/homebridge-plugins/homebridge-ecovacs/issues/new/choose)
- [Changelog](https://github.com/homebridge-plugins/homebridge-ecovacs/blob/latest/CHANGELOG.md)
- [About Me](https://github.com/sponsors/bwp91)

### Credits

- To the owner of [ecovacs-deebot.js](https://github.com/mrbungle64/ecovacs-deebot.js) client: [@mrbungle64](https://github.com/mrbungle64).
- To the owner of [homebridge-deebotEcovacs](https://github.com/nicoduj/homebridge-deebotEcovacs): [@nicoduj](https://github.com/nicoduj).
- To the creator of the awesome plugin header logo: [Keryan Belahcene](https://www.instagram.com/keryan.me).
- To the creators/contributors of [Homebridge](https://homebridge.io) who make this plugin possible.

### Disclaimer

- I am in no way affiliated with Ecovacs/Deebot/Yeedi and this plugin is a personal project that I maintain in my free time.
- Use this plugin entirely at your own risk - please see licence for more information.