Basic Troubleshooting - homebridge-plugins/homebridge-eufy-security GitHub Wiki

Troubleshooting

If you're having trouble with the plugin, follow these steps before filing an issue. This ensures maintainers have the information needed to help you.

Quick check: Is your issue already documented? See Common Issues first.


Step 1: Update to the Latest Version

Before troubleshooting, make sure you're on the latest version of the plugin. Many issues are fixed in newer releases.

  • Update via Homebridge UI: Plugins page → click update on the plugin tile
  • Or install the latest beta for cutting-edge fixes: see Beta Versions

Also verify your Node.js version is compatible. See Node.js Compatibility.

Step 2: Enable Debug Logging

Debug logging tells the plugin to write detailed information about its processes into the Homebridge log. This is essential for diagnosing any issue.

  1. Go to Plugin Settings → Having a bug?
Diagnostics Menu
  1. Read the notice carefully and click Proceed

  2. Enable DEBUG MODE

Enable Debug Mode
  1. Restart Homebridge

  2. Reproduce your issue — perform the action that triggers the problem

Caution: Debug logging generates a lot of data. If you stream regularly, logs can accumulate to several hundred MB in minutes. Disable debug mode after collecting your logs.

Privacy: Log files may contain sensitive data (cloud snapshot URLs, login tokens, etc.). After your issue is resolved, we recommend changing your password. We also encourage enabling 2FA.

For streaming issues specifically, there is a separate FFmpeg debug mode. See Streaming — Advanced Video Config for details.

Step 3: Export Diagnostics

After reproducing your issue with debug mode enabled:

  1. Go to Plugin Settings → Having a bug?

  2. Click Collect Logs to download the diagnostics archive

Collect Logs

The diagnostics archive (.tar.gz.enc) is encrypted with RSA-4096 + AES-256-GCM. Only the plugin maintainers can decrypt it. It is safe to attach publicly to GitHub issues.

What's in the Diagnostics Archive

Log File Contents
eufy-security.log All messages from the plugin
eufy-lib.log Messages from the eufy-security-client library
ffmpeg.log Global FFmpeg process output
ffmpeg-<serial>.log Per-camera FFmpeg output
configui-server.log Config UI server messages
configui-lib.log Config UI library messages
accessories.json Device tree snapshot

All log files are rotated daily. A .log.0 file is from the previous day.

Step 4: File an Issue

If your issue isn't covered in Common Issues:

  1. Go to GitHub Issues
  2. Choose the appropriate template:
    • Bug Report — for problems with existing functionality
    • Device Support — for unsupported or partially supported devices
    • Feature Request — for new functionality
  3. Attach your diagnostics archive — issues without diagnostics cannot be triaged effectively
  4. Include which area is affected (streaming, login, events, snapshots, etc.)

Clean

Delete rotated logs, cached snapshots, and diagnostic archives to free disk space. Current log files, persistent data, and accessories are preserved. Clean Storage

Reset / Clear

If you need to remove stored data (login tokens, device cache, etc.), use the reset button in Plugin Settings: Delete all persistent data, stored accessories, and logs. You will need to log in again.

Reset

This is useful when:

  • Login tokens have expired or become invalid
  • Device list doesn't update correctly after an upgrade
  • You want a fresh start without reinstalling

Sharing Your Eufy Security Devices

In some cases, maintainers may ask you to temporarily share access to your devices for debugging. This is handled with care:

  • We will provide our test email address via Discord chat or within the GitHub issue
  • We will coordinate with you before running any tests
  • Shared access should last no longer than 2-3 hours
  • You can withdraw access at any time

How to share and revoke access:

Be careful about who you share camera access with. We understand this is a sensitive matter.

⚠️ **GitHub.com Fallback** ⚠️