Debug Logging & Log Sharing Guide - zbigniewmotyka/home-assistant-solplanet GitHub Wiki

This document explains how to enable debug logging for the Solplanet integration in Home Assistant and how to safely share log files for troubleshooting.


🐞 How to Enable Debug Logging for the Solplanet Integration in Home Assistant

To help diagnose issues with the Solplanet integration, you can enable debug logging directly from the Home Assistant user interface:

  1. Open Home Assistant and go to Settings from the left-hand sidebar.

  2. Navigate to Devices & Services.

  3. In the Integrations tab, find the Solplanet integration and click on it.

  4. On the Solplanet integration page, click the “Enable debug logging” button.
    This will immediately start detailed logging for the integration.

obraz

  1. Reproduce the issue or wait for the event you want to investigate.

  2. When you're done, click “Disable debug logging” on the same page.

    📝 When debug logging is disabled, Home Assistant will automatically generate and download a portion of the log file containing relevant entries for the Solplanet integration. This file can be used for troubleshooting or shared with support if needed.

🔄 Debug logging is temporary and will automatically turn off after some time or after restarting Home Assistant.


📤 How to Share Log Files Safely

When debug logging is enabled for the Solplanet integration, Home Assistant will generate a partial log file that may contain sensitive information.

⚠️ Important: Logs may include

  • Your device's serial number
  • A private key that could allow unauthorized access to the device via the official Solplanet app

Because of this, please do not post log files publicly (e.g., in GitHub issues, forums, or comments).

✅ Safe way to share logs

If you need help analyzing your logs, please send the file privately via email to:

📧 [email protected]

After sending the email, leave a comment in your GitHub issue stating that the log file has been sent.

🔒 Your data will only be used for debugging purposes and handled with care.


Thank you for helping improve the Solplanet integration! 💙