jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating formatting and layout (#5785)

Browse Source 
* Updating formatting and layout

The enable section blends into the ignore section, so moving to the new formatting config. Also turned the mass of notes at the end into a troubleshooting section with linkable titles.

* Canna type

Typo fix
This commit is contained in:
DubhAd 2018-07-13 22:34:50 +01:00 committed by Fabian Affolter
parent 647c913442
commit bcfbebad16
1 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_components/discovery.markdown
View File

@ -57,9 +57,18 @@ discovery:
- homekit
```
Configuration variables:
{% linkable_title Configuration variables: %}
- **ignore** (*Optional*): A list of platforms that never will be automatically configured by `discovery`.
{% configuration discovery %}
ignore:
description: A list of platforms that never will be automatically configured by `discovery`.
required: false
type: string
enable:
description: A list of platforms not enabled by default that `discovery` should discover.
required: false
type: string
{% endconfiguration %}
Valid values for ignore are:
@ -92,29 +101,34 @@ Valid values for ignore are:
* `yeelight`: Yeelight Sunflower bulb
* `xiaomi_gw`: Xiaomi Aqara gateway
- **enable** (*Optional*): A list of platforms not enabled by default that `discovery` should discover.
Valid values for enable are:
* `homekit`: HomeKit accessories
<p class='note'>
## {% linkable_title Troubleshooting %}
### {% linkable_title UPnP %}
Home Assistant must be on the same network as the devices for uPnP discovery to work.
If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network.
</p>
<p class='note warning'>
### {% linkable_title Windows %}
#### {% linkable_title 64-bit Python %}
There is currently a <a href='https://bitbucket.org/al45tair/netifaces/issues/17/dll-fails-to-load-windows-81-64bit'>known issue</a> with running this component on a 64-bit version of Python and Windows.
</p>
<p class='note'>
#### {% linkable_title Python 3.5 %}
If you are on Windows and you're using Python 3.5, download the [Netifaces](http://www.lfd.uci.edu/~gohlke/pythonlibs/#netifaces) dependency.
</p>
<p class='note'>
### {% linkable_title could not install dependency netdisco %}
If you see `Not initializing discovery because could not install dependency netdisco==0.6.1` in the logs, you will need to install the `python3-dev` or `python3-devel` package on your system manually (eg. `sudo apt-get install python3-dev` or `sudo dnf -y install python3-devel`). On the next restart of Home Assistant, the discovery should work. If you still get an error, check if you have a compiler (`gcc`) available on your system.
### {% linkable_title DSM and Synology %}
For DSM/Synology, install via debian-chroot [see this forum post](https://community.home-assistant.io/t/error-starting-home-assistant-on-synology-for-first-time/917/15).
</p>
## {% linkable_title New platforms %}
If you are developing a new platform, please read [how to make your platform discoverable](/developers/component_discovery/) for further details.