Clarify logs requirements

This commit is contained in:
Edward Firmo
2024-01-29 07:51:00 +01:00
parent 443dfa57c0
commit 505714c6f3

View File

@@ -99,17 +99,35 @@ body:
- type: textarea - type: textarea
attributes: attributes:
label: ESPHome logs label: ESPHome Logs
description: Access these logs via the **Logs** button for your device on the ESPHome Dashboard. description: >
render: logs Access these logs via the **Logs** button on the ESPHome Dashboard.
These logs are crucial for diagnosing issues with your device.
Please follow the guidelines below to ensure the logs are comprehensive:
- **Boot Issues**: If the problem occurs during boot, capture the logs from the start of your device to a minute or two after the boot completes.
Look for errors or unusual messages during this period.
- **TFT File Update Issues**: For problems related to TFT file updates,
include logs from the moment you press the **Update TFT Display** button until a few seconds after the device restarts.
Pay attention to any error messages or warnings during the update process.
- **Other Issues**: For other types of problems, include logs that encompass the issue's onset and continue for a short duration thereafter.
This will help in pinpointing the exact moment and nature of the issue.
Remember, the more detailed the logs, the easier it is to identify and resolve the problem.
validations: validations:
required: false required: false
- type: textarea - type: textarea
attributes: attributes:
label: Home Assistant logs label: Home Assistant Logs
description: Access these logs from **Settings** > **System** > [**Logs**](https://my.home-assistant.io/redirect/logs/) in Home Assistant. description: >
render: logs To access Home Assistant logs, navigate to **Settings** > **System** > [**Logs**](https://my.home-assistant.io/redirect/logs/).
When reporting an issue, please focus on providing logs specifically relevant to the problem:
- **NSPanel Blueprint Automation**: If your issue is related to automation using the NSPanel blueprint, include only those logs that directly pertain to this process.
- **Panel and ESPHome**: For issues involving your panel and ESPHome, carefully select and share logs that show interactions or errors between these components.
- **Relevancy is Key**: To expedite troubleshooting, avoid including logs that are not related to the issue at hand. This helps in focusing on the pertinent information.
Your attention to sharing targeted and relevant log data is greatly appreciated and aids in efficient problem resolution.
validations: validations:
required: false required: false
... ...