Skip to content

Commit 586c020

Browse files
authored
Extend docs (#126)
* Add common errors and requirements to README * Update issue template
1 parent aa33499 commit 586c020

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

.github/ISSUE_TEMPLATE/issue.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@ A clear and concise description of what the bug is.
2525

2626
## Debug log
2727

28-
<!-- To enable debug logs check this https://www.home-assistant.io/components/logger/ -->
28+
<!-- To enable debug logs please add the code snipped below to your Home Assistant configuration.
29+
30+
```yaml
31+
logger:
32+
default: info
33+
logs:
34+
custom_components.ta_cmi: debug
35+
ta_cmi: debug
36+
```
37+
-->
2938

3039
```text
3140

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ venv
44
.venv
55
.coverage
66
.idea
7+
dummy_server.py

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ Currently supported devices:
2424
> The loading time of the integration is extended by one minute per configured node on the C.M.I. to avoid triggering the rate limit.
2525
> The same applies to the setup process
2626
27+
## Requirements
28+
29+
* Credentials for an expert user on the C.M.I.
30+
2731
{% if not installed %}
2832
## Installation
2933

@@ -69,6 +73,13 @@ In this step, individual channels can be customized, including the following pro
6973
To customize a channel, select the device,
7074
on which the channel is located, enter the channel number and finally select the channel type.
7175

76+
## Common errors
77+
78+
### "Unknown error occurred" on setup after ~60s
79+
80+
This error occurs if the setup is done on a Home Assistant instance that is accessed through a reverse proxy or the Home Assistant Cloud.
81+
In this case please connect **directly** to your instance and set up the integration.
82+
7283
## Supported data types
7384

7485
| Device type | Inputs | Outputs | DL-inputs | System-values: General | System-values: Date | System-values: Time | System-values: Sun | System-values: Electrical power | Analog network inputs | Digital network inputs | M-Bus | Modbus | KNX | Analog logging | Digital logging |

0 commit comments

Comments
 (0)