Eufy Security WS

Eufy Security WS is a small server wrapper around the eufy-security-client library that exposes Eufy device functions over WebSocket, giving homelab users a…

  • Home Automation
  • Other
  • Tools & Utilities
Eufy Security WS is a small server wrapper around the eufy-security-client library that exposes Eufy device functions over WebSocket, giving homelab users a local API for custom integrations, including live streaming.

Platform availability

Available on 2 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

15/100 Low

Maintained
0GitHub repository no longer exists
Popular
No data
Easy to install
452 install platforms, install notes, Docker image
Light to run
No data

Based on 2 of 4 factors.

Availability: platform listings confirmed today, links checked 15 days ago

No GitHub repository data collected yet.

Checked 17 days ago - source: GitHub (BigBearTechWorld/eufy-security-ws)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 17 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Add Eufy login details and 2FA Fill in your country, Eufy email, and password, and be ready to enter the two-factor code (a one-time code from Eufy) if asked. Without those, the app can't sign in or see your cameras. source
  • Install the client package Run npm install eufy-security-client, where npm is the package installer. Without this package installed, the app can't connect to Eufy devices. source
  • Use device serial numbers When pointing the app at a camera, lock, or tracker, use the device's serial number, often shown as sn. If the serial number is missing or wrong, events, livestreams, or actions will not work. source

Fetched 17 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What Eufy account details must I provide for eufy-security-ws to sign in?

Provide your country, Eufy email, and password, and be ready to enter a one-time two-factor code from Eufy if asked. Without these details, the app cannot sign in or see your cameras.

What package does eufy-security-ws depend on to connect to Eufy devices?

The client package is installed with npm install eufy-security-client. Without this package installed, the app cannot connect to Eufy devices.

Which device identifier should I use when configuring cameras, locks, or trackers?

Use the device's serial number, often shown as sn, when pointing the app at a camera, lock, or tracker. If the serial number is missing or wrong, events, livestreams, or actions will not work.

How do I install the official Home Assistant add-on for eufy-security-ws?

Open the Add-On store, select eufy-security-ws, and fill in the configuration before starting it. For a develop version, select eufy-security-ws-dev and set the GitHub URL and branch if requested.

Why might eufy-security-ws create only a persistent.json file and no video recordings?

A Docker user reports that eufy-security-ws can connect to Eufy cameras but does not create video recordings, producing only a persistent.json file.

Answers sourced from github.com, github.com, github.com, github.com, www.reddit.com

Community

Collected 16 days ago - public community threads