Basic Troubleshooting
There does not yet exist a way to do systematic troubleshooting. However, we encourage you to isolate your issues into the smallest parts possible and come up with a way to test each issue.
For example, if you have permissions trouble or errors installing npm, solve that problem first by using any error messages to search for solutions. Once that problem is solved, move onto the next problem.
The first thing to do if you have trouble with the plugin, is to enable debug messages. This will tell the plugin to write a lot more data about the underlying processes into the homebridge log. You'll find the setting in 'Plugin Settings':
Also this will save all log messages to the plugin storage path. The storage path is one of the first messages printed out by the plugin if you restart homebridge. There you will find:
| log file | Description |
|---|---|
| log-lib.log | All messages relating to the plugin. |
| config-ui.log | This file contains information about the login process and the behaviuor of the config ui screen. |
| eufy-log.log | This file contains information about the eufy-security-client library. |
All log files be rotated daily. So if you see a ****.log.0 file that is the file from yesterday.
Caution: The eufy-security-client library tends to write a LOT of data into the logs. If you stream regularly this can cummulate up to several hundred mb in minutes.
Caution again: Log files may contain sensitive data, like cloud snapshot urls, login tokens, and so on. After finishing debuging and the team was able to resolve your issue (or not 👎 ), we recommend to modify your password. We also encourage to enable 2FA.
After you have enabled the debug mode, restarted the plugin and reproduced your issue, you can download the logs via the configuration screen again. You'll find the 'Download' button under 'Plugin Settings'.
Notice: There is another debug mode for the individual ffmpeg processes. See Streaming for mor detail.
Apart from log files the plugin stores some additional information like login tokens in its storage path. If you need to remove everything in this directory, you can use the button in the 'Plugin Settings'.
Becareful to whom you provide shared access to your camera. We know it's can be really sensitive matter for you and us (we do have cameras aswell). Sometimes, even with all the effort we're doing, we'll ask you if you would like to share access with us. In addition to that request we'll ask you to chat with us on discord so before doing any test, we'll make you aware.
We'll provide you the email address that we're using for test by chat or within the issue. Shared access should be provided only for time being of troubleshooting and should last no longer than 2-3 hours.
You can withdraw our access at any time. Please find the related documentation to provide and withdraw access :
- Doc: Share Your eufySecurity Devices With Your Family
- Video: Share Your eufySecurity Devices With Your Family
Lastly, here is the Homebridge Basic Troubleshooting which could help you aswell.