Proposal to improve instructions for submitting new issues

[Borekss]

Hi
I suggest improving the instructions for creating new bug reports. There is this text:

"Write issue ONLY in English

• Search if similar issue already exist, also check closed issues, DO NOT CREATE DUPLICATES
• Check Integration errors in Hass logs (Configuration > Logs), maybe answer there
• Check Integration debug (readme) for something useful
• Read the readme carefully, maybe the answer is there"

In my opinion, it would be better to include those detailed instructions that are otherwise pretty hidden:

You can't be surprised that people don't send you more accurate information when they don't know how to do it.

Regarding step 3.
"Enable debug page in integration options. Reload integrations page."

For a long time, I couldn't figure out where to turn on this option. I was looking at HACS menu item. I finally managed to find it. It would be good to describe in as much detail as possible where to find these options. I'm probably not the only one who couldn't find them.

"Open: Integraion > Menu > Known issues."
Where could I find this?

I have turned on Debug page and restarted HA.

But it does not work for me (using my IP http://192.168.0.123:8123/api/sonoff/c8503fee-88fb-4a18-84d9-abb782bf0aa7?q=1000xxxxxx&r=2)

[AlexxIT]

The issues section in the documentation is located immediately after installation and configuration.
If someone didn't find it, it means they didn't even try to read the documentation.

I'll say more, many people don't even read the message you quoted above.
They write in issues in their own languages. Do not attempt to find existing issues. They don't open the documentation at all.
They did not make even the minimal effort to solve their own problem.
And they have absolutely no respect for other people's work and time, thinking that their own time is much more valuable.

It's been five years since integration. During this time, the HA design has probably changed a dozen times. Options are constantly moving to new places.

[Borekss]

You are absolutelly right. I see this in our Facebook group about some of our hobbies. People keep asking the same questions over and over. Still it might be usefull to eliminate at least a few dumb questions by linking readme instructions in New issue form.

I saw those instructions is past but I was never able to make debug mode work. What is that GUID c8503fee-88fb-4a18-84d9-abb782bf0aa7 anyway?
Here is #1217 another user complaining that he only got 404. Probabaly we need another debug mode to make the main debug mode to work ☺️ There is no coresponding issue in HA log.

Is this text under Known issues really "Known issues"? It looks like more like a log file for me. I'm a little confused 🤔

2026-03-12 15:53:53 [D] 10026ebe7b => Cloud4 | {'uiActive': 60} | 1773327233741
2026-03-12 15:53:53 [D] 10026ec9ce => Local4 | 192.168.0.72:8081 | {'getHoursKwh': {'start': 0, 'end': 719}} <= {'sequence': '1773327233749', 'seq': 866826, 'error': 0, 'encrypt': True, 'iv': 'ODU1NjA3MDM4MDM5MTg5NA==', 'data': 'EquKfZgSbZgozdhGPzXQrYtrOzW9f1sGQj+Tqz9P8G7ZdNbaJ27+siqPOqBTMiB5qoyjZO1H9ckioFf2KoM7OWgNDXlH2NwTLw/th0aU4TKuT9E4SrIvR2KLAlhZvpHSGxRSya9sGEPgLxSQlO6iVTlnpmFvHIDoMdwkGkHAEMFRg4HCh8fHkIC42DNFD52Wn9mI1MS5Lofl0W+5EJfchThDizGNLLJ7kWEgN7AvL90NG+BjSXl2iOugFbtr5QIzeb9zZOclP5uuZUCKxkxf3EqOEBBJLe1TXWCGUIY8DFkUhAv0u0ibdayr/iG7MFE6lxPYyi6iMdOy9aBnNOupiFm6P6u/wR+RBy6hitXSkiq4/zsDfwrxJ1VQWk598OexWVLIu9bbOaHV/2NasZpBKnKt1sIkUvHJdbX4nusIsri2rt8VVVtF9OAVNDWWYOYoMDs+vRXQepH7LKkcE4bLkIzwUNtRbTMYT8rqES1JEdmrs+VrWiwEVzCNtngKCrdCYEIX4kIHQfrcfcXBfFGQyOS+iPeKGODOufk7XYMLzB6sGW1p83QwymeSZVSZg46y1YohvbpwYQsdG73YnGp6YLurR+2XtC5xfcczeGAJSg+IhgVrzW4='}
2026-03-12 15:53:53 [D] 10026ec9ce <= Local0 | | {'hoursKwhData': '0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'} | 866826
2026-03-12 15:53:53 [D] 10026ec9ce <= Local3 | 192.168.0.72:8081 | {'switches': [{'switch': 'on', 'outlet': 0}], 'configure': [{'startup': 'on', 'outlet': 0}], 'pulses': [{'pulse': 'off', 'switch': 'off', 'outlet': 0, 'width': 500}], 'sledOnline': 'on', 'fwVersion': '1.2.0', 'rssi': -41, 'current': 0, 'voltage': 23958, 'power': 0, 'dayKwh': 0, 'monthKwh': 3} | 866826
2026-03-12 15:53:54 [D] 10024c6058 => Local4 | 192.168.0.86:8081 | {'getHoursKwh': {'start': 0, 'end': 719}} <= {'sequence': '1773327233751', 'seq': 288462, 'error': 0, 'encrypt': True, 'iv': 'MzM2NzYzNDQzMzU4NjgxOQ==', 'data': 'b7FCLv5aIAl/qH92Te23J/RTd26iLJ/A/Mw7PFbXgrf5CUjIXBByxxiRxKo0rx/YOwiLWB8xAePy1P5vK94F9E4xfHO69NXGiIyiZXJz9Djt0/2UdxUozFevkm/IIgIckXKu4wTo0jc16xIhuLH9r+titC9mqrvwJCdd9kd2uQn/WroJWRcyzQc4rQ90Zq8fDTdqlEiDmKdHSNMf+DZ3o30sNJHQTx1ZvLJ0YyJDdf48afyTfLFq48zpfHUbLiywSUesvvbWtO1nwlxlkZZbQZQSlFEIfv6kugb5voToREdAF76K54xAsgTBS+T5az7JjEBPlEJLgZlPV0E93wfUvimcOpwvrWXmS6SMtmqU0qhk6TurkVtgjNi2CzKDFrYTGsI0pOYcxKRblJk8x/IuaUJlOZ+Y+Slzeo/su7U/+i6IEbkz5VcWoiTrH4xo79y8A7j5FrEa+Bb0D14sF6E3j5+6VaRCP5+p8+YzCDza9kiTd8GWc4R0W6DWLzjQ71+7hQ9TG3ZgQaCsSvanP2yWCqeU9yswRn8xHV21WoVadOjcScRMQx3NkdiOkoKlI5KKHiQ4s3Dj1hNo29xrTlNcgyOmhyv6MV1LosYBq25IrsVjGOUXWqDuAq1G6/MgVU2vES7IXmq8LRyS4fL5CEcH/Jhg2SvItln4NSZmfzyMs/BwjnLPmWdP2zq6d77jWGzv7nB9B3s6Suj3r7CyPz/NS2S2XyrTChSmCsiW9hk415mtBCQTooVhelzyDsMaL1XfO6oOGXCVkrq9uQx0/ysAt6Sd4upGc3e8SxFWBSD7GJqztS5OZRnJcClRrg='}
2026-03-12 15:53:54 [D] 10024c6058 <= Local0 | | {'hoursKwhData': '00901000901000901001000500000000000000000000000000000000900901001001001001001001001001001000900500000000000000000000000000000000801001001001001001001001001001001001000500000000000000000000000000000000800901000901001001001001001001001001000500000000000000000000000000000000000000301001001001001001001001000901000500000000010005000000000000000000000000000000008010009009010010010010009010010010009004000000000000000000000000000000008010010010010010009009010009009009010005000000000000000000000000000000008010010010010010010009009009010010009005000000000000000000000000000000008010010010009009010010010010010010010004000000000000000000000000000000008009010009010010'} | 288462
2026-03-12 15:53:54 [D] 100255c5c3 => Local4 | 192.168.0.12:8081 | None <= {'sequence': '1773327233743', 'seq': 566292, 'error': 400, 'encrypt': True}
2026-03-12 15:53:54 [D] 10023289fd <= Local3 | 192.168.0.19:8081 | {'switches': [{'switch': 'off', 'outlet': 0}], 'configure': [{'startup': 'off', 'outlet': 0}], 'pulses': [{'pulse': 'off', 'switch': 'off', 'outlet': 0, 'width': 500}], 'sledOnline': 'on', 'fwVersion': '1.3.1', 'rssi': -54, 'current': 236, 'voltage': 24346, 'power': 37007, 'dayKwh': 460, 'yesterdayKwh': 716, 'monthKwh': 8418, 'detectionMode': 0, 'exceptionReport': [], 'hasException': False} | 865598
2026-03-12 15:53:54 [D] 10024c6058 <= Local3 | 192.168.0.86:8081 | {'switches': [{'switch': 'on', 'outlet': 0}], 'triggerType': 11, 'configure': [{'startup': 'off', 'outlet': 0}], 'pulses': [{'pulse': 'off', 'switch': 'off', 'outlet': 0, 'width': 500}], 'sledOnline': 'on', 'fwVersion': '1.2.0', 'rssi': -35, 'current': 56, 'voltage': 24072, 'power': 9769, 'dayKwh': 72, 'monthKwh': 1465} | 288462
2026-03-12 15:53:54 [D] 100255c5c3 <= Local3 | 192.168.0.12:8081 | {'switches': [{'switch': 'on', 'outlet': 0}], 'triggerType': 11, 'configure': [{'startup': 'off', 'outlet': 0}], 'pulses': [{'pulse': 'off', 'switch': 'off', 'outlet': 0, 'width': 500}], 'sledOnline': 'on', 'fwVersion': '1.2.0', 'rssi': -55, 'current': 117, 'voltage': 24151, 'power': 17092, 'dayKwh': 125, 'monthKwh': 2548} | 566292
2026-03-12 15:53:54 [D] a4800edd33 => Cloud4 | {'uiActive': 60} | 1773327234741
2026-03-12 15:53:55 [D] 10026ec0cc => Cloud4 | {'uiActive': 60} | 1773327235743
2026-03-12 15:53:56 [D] 10023289fd <= Local3 | 192.168.0.19:8081 | {'switches': [{'switch': 'off', 'outlet': 0}], 'configure': [{'startup': 'off', 'outlet': 0}], 'pulses': [{'pulse': 'off', 'switch': 'off', 'outlet': 0, 'width': 500}], 'sledOnline': 'on', 'fwVersion': '1.3.1', 'rssi': -54, 'current': 237, 'voltage': 24321, 'power': 37051, 'dayKwh': 460, 'yesterdayKwh': 716, 'monthKwh': 8418, 'detectionMode': 0, 'exceptionReport': [], 'hasException': False} | 865599
2026-03-12 15:53:56 [D] 10023289fd => Cloud4 | {'uiActive': 60} | 1773327236744

[AlexxIT]

Here is #1217 another user complaining that he only got 404.

The link is updated every time HA starts up. This ensures it remains secure and prevents malicious users from exploiting it.
If the page with the integration was open during the page reload, you need to refresh the page for the link to update.

[AlexxIT]

Is this text under Known issues really "Known issues"? It looks like more like a log file for me. I'm a little confused

Unfortunately, the HA architecture doesn't allow integrations to add their own links. It's not the best solution and it's a bit of a workaround, but I haven't come up with anything better.

[Borekss]

#1771