Discovery
Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP devices on your network. Currently the discovery
component can detect:
- Apple TV
- Axis Communications security devices
- Belkin WeMo switches
- Bluesound speakers
- Bose Soundtouch speakers
- Denon network receivers
- DirecTV receivers
- Frontier Silicon internet radios
- Google Cast
- IKEA Trådfri (Tradfri)
- Linn / Openhome
- Logitech Harmony Hub
- Logitech media server (Squeezebox)
- Netgear routers
- Panasonic Viera
- Philips Hue
- Plex media server
- Roku media player
- SABnzbd downloader
- Samsung TVs
- Sonos speakers
- Telldus Live
- Wink
- Yamaha media player
- Yeelight Sunflower bulb
It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user.
To load this component, add the following lines to your configuration.yaml
:
# Example configuration.yaml entry
discovery:
ignore:
- sonos
- samsung_tv
Configuration variables:
- ignore (Optional): A list of platforms that never will be automatically configured by
discovery
.
Valid values for ignore are:
apple_tv
: Apple TVaxis
: Axis Communications security devicesbelkin_wemo
: Belkin WeMo switchesbluesound
: Bluesound speakersbose_soundtouch
: Bose Soundtouch speakersdenonavr
: Denon network receiversdirectv
: DirecTV receiversfrontier_silicon
: Frontier Silicon internet radiosgoogle_cast
: Google Castharmony
: Logitech Harmony Hubikea_tradfri
: IKEA Trådfri (Tradfri)logitech_mediaserver
: Logitech media server (Squeezebox)netgear_router
: Netgear routersopenhome
: Linn / Openhomepanasonic_viera
: Panasonic Vieraphilips_hue
: Philips Hueplex_mediaserver
: Plex media serverroku
: Roku media playersabnzbd
: SABnzbd downloadersamsung_tv
: Samsung TVssonos
: Sonos speakerstellduslive
: Telldus Livewink
: Wink Hubyamaha
: Yamaha media playeryeelight
: Yeelight Sunflower bulb
Home Assistant must be on the same network as the devices for uPnP discovery to work.
If running Home Assistant in a Docker container use switch --net=host
to put it on the host’s network.
There is currently a known issue with running this component on a 64-bit version of Python and Windows.
If you are on Windows and you’re using Python 3.5, download the Netifaces dependency.
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.
For DSM/Synology, install via debian-chroot see this forum post.
If you are developing a new platform, please read how to make your platform discoverable for further details.