Skip to content

Commit f801fdc

Browse files
committed
Add Support Docs
1 parent a6662e2 commit f801fdc

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

docs/.vitepress/config.mts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,14 @@ export default defineConfig({
100100
items: [
101101
{ text: '3D printing', link: '/enclosure/3d-printing' }
102102
]
103+
},
104+
{
105+
text: 'Support',
106+
link: '/support/support',
107+
collapsed: true,
108+
items: [
109+
{ text: 'Troubleshooting', link: '/support/troubleshooting' }
110+
]
103111
}
104112
],
105113

docs/support/support.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Support
2+
3+
If you are having issues with your Doorman, help is available in several places:
4+
5+
- The below troubleshooting guide covers many common issues
6+
- The [Discord server](https://discord.gg/t2d34dvmBf) is a great place to get help from me and the rest of the community
7+
- The [GitHub issues](https://github.com/AzonInc/Doorman/issues) might have the solution to a problem you're having
8+
9+
Please do note that support is provided on a best-effort basis. I will of course assist in any way I can, but since this is not my full-time job I cannot guarantee that I will be able to help immediately or with every situation. Thank you for understanding.
10+
11+
## Common Issues
12+
13+
::: details Home Assistant can't connect / BAD_INDICATOR errno=11
14+
If Home Assistant can't connect to your Doorman, or you are receiving the error Reading failed: BAD_INDICATOR errno=11 in the logs, this indicates Home Assistant may be trying to connect with an incorrect encryption key.
15+
16+
First, try restarting Home Assistant entirely to see if the issue persists. If it does, here are some things to try based on how you manage your Doorman's firmware updates.
17+
18+
19+
#### OTA Updates / Firmware Binary
20+
21+
The pre-compiled firmware binaries that are used for OTA updates do not have an API encryption key built-in, therefore Home Assistant must be attempting to connect with an encryption key or deprecated API password. To remedy this, please try removing the integration entry for your Doorman by going to Settings > Devices & Services, then remove the ESPHome integration for your Doorman there. Then re-add your Doorman to Home Assistant by creating a new ESPHome integration using the device's IP or hostname. Do not specify an encryption key or password if prompted.
22+
23+
#### ESPHome Dashboard
24+
25+
If you manage updates with an ESPHome YAML, you must make sure that the encryption key you specify in the api: section of your configuration matches the encryption key that Home Assistant uses. Try re-adding the integration to Home Assistant, and make sure to specify the encryption key when prompted. You may also try removing the encryption key from your configuration to see if this remedies the issue. If it does, this may indicate an issue with Home Assistant or ESPHome itself.
26+
:::
27+
28+
::: details Receiving commands does not work
29+
If your Doorman is unable to receive commands there could be several reasons.
30+
31+
#### Check the wiring
32+
Please make sure you wired everything correctly.\
33+
You can find the guide [here](../guide/getting-started#wiring).
34+
35+
#### Check the Bus voltage
36+
There are cases where the bus voltage is inusfficient and causing the reading to fail.\
37+
This can happen when other devices are drawing too much current.
38+
39+
You can check the a+b Bus voltage when receiving commands using an oscillosope.
40+
If the bus voltage constantly goes up and down there's an issue with the power draw of other bus participants.
41+
:::
42+
43+
## Other Issues
44+
45+
If you are experiencing other issues, here are some things to try:
46+
47+
- Reflash the firmware [here](../firmware/stock-firmware).
48+
49+
If everything else fails, please join the [Discord server](https://discord.gg/t2d34dvmBf) for support. If necessary, we will work to triage an issue on the GitHub repository.

docs/support/troubleshooting.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Troubleshooting
2+
3+
TODO

0 commit comments

Comments
 (0)