Official eufy-security-ws Home Assistant add-on repository

Caution

🚨🚨🚨 LIBRARY DEPRECATION NOTICE 🚨🚨🚨

⚠️ Eufy is shutting down the legacy APIs this library is built on. ⚠️

Eufy is in the middle of a large migration of their ecosystem. The newer Eufy Mega platform (the "5-in-1" app, covering Security / Clean / Lights / Care) is gradually becoming the only supported backend, and Eufy has already started removing access to the legacy APIs this library was originally built on. Until recently both worked in parallel — that is no longer guaranteed.

🔔 What this means for you:

• 🟢 A recent PR restores push notifications against the new v6 ("eufy_mega") backend, so push works again for now. This is a short-term stopgap.
• 🟡 Other functionality that still depends on legacy endpoints may stop working without warning as Eufy continues the rollout. The current Eufy app no longer uses the legacy API at all.
• 🔴 Once the legacy API is fully shut down, this library will stop functioning — no amount of patching here will change that.

🚧 What's next:

A new integration built around Eufy Mega is in active development (auto-discovery, less battery drain for P2P), designed from the ground up rather than bolted onto the Security-only structure, and coordinated across the Home Assistant, Homebridge and Homey communities so the new library works for everyone.

👉 Treat this release as a temporary stopgap. 👈

This notice will be updated as the migration progresses.

Join us on Discord:

Add-ons

This repository contains the following add-ons

eufy-security-ws add-on

Installation

1. To add this repository to Home Assistant you have 2 options:

   1. Go to Settings → Add-ons → Add-on store and click ⋮ → Repositories, fill in https://github.com/bropat/hassio-eufy-security-ws and click Add → Close

   2. click the Add repository button below, click Add → Close (You might need to enter the internal IP address of your Home Assistant instance first).

      

2. To install the addon, press Add-On store and select eufy-security-ws and ensure the configuration is filled up before starting it.

Installation Dev version

1. To add this repository to Home Assistant you have 2 options:

   1. Go to Settings → Add-ons → Add-on store and click ⋮ → Repositories, fill in https://github.com/bropat/hassio-eufy-security-ws#debug and click Add → Close

   2. click the Add repository button below, click Add → Close (You might need to enter the internal IP address of your Home Assistant instance first).

      

2. To install the addon, press Add-On store and select eufy-security-ws-dev.

3. If requested, setup the bespoke github url and github branch to run a develop version of the eufy client.

Note: This is only used if a developer is asking you to run it, please always use official one for stable version

Changelog

The format is based on Keep a Changelog.

All notable changes to this project will be documented in the CHANGELOG.md file.

Version for releases is based on eufy-security-ws format: X.Y.Z.

Any changes on the addon that do not require a new version of eufy-security-ws will use the format: X.Y.Z-A where X.Y.Z is fixed on the eufy-security-ws release version and A is related to the addon.

Issues

If you find any issues with the add-on, please check the issue tracker for similar issues before creating one. If your issue is regarding specific devices or, more generally, an issue that arises after eufy-security-ws has successfully started, it should likely be reported in the eufy-security-ws issue tracker or eufy-security-client issue tracker.

Feel free to create a PR for fixes and enhancements.

Deployment

Instructions aimed at maintainers for deploying a new version: Deployment