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-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated add new platform page with discovery instructions

Browse Source
This commit is contained in:
Paulus Schoutsen 2015-01-10 08:55:37 -08:00
parent d746316067
commit 88de11b0ff
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/developers/add_new_platform.markdown
View File

@ -24,3 +24,39 @@ If you are planning to add support for a new type of device to an existing compo
<p class='note'>
Platform logic should not interface directly with the devices but use a third-party Python 3 library that speaks the actual API.
</p>
## Allowing your platform to be discovered
Home Assistant has a discovery service running in the background to discover new devices. Whenever a new device is discovered, an `SERVICE_DISCOVERED` event will be fired with the found service and the information. The `discovery` component has some knowledge about which components handle which type of services and will ensure those are loaded and listening before firing the `SERVICE_DISCOVERED` event.
### Add discovery instructions
Device discovery for Home Assistant has been extracted into an external library called [NetDisco](https://github.com/balloob/netdisco). This library is integrated using [the `discovery` component](https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/discovery.py) and scans the network in intervals for uPnP and zeroconf/mDNS services.
To have your device be discovered, you will have to extend the NetDisco library to be able to find your device. This is done by adding a new discoverable. [See the repository for examples of existing discoverables.](https://github.com/balloob/netdisco/tree/master/netdisco/discoverables)
### Listening to `SERVICE_DISCOVERED` events
From your component, you will have to set up the listening for specific services. Below an example how one would listen for discovered Chromecasts:
```python
from homeassistant.loader import get_component
def setup(hass, config):
discovery = get_component('discovery')
def chromecast_discovered(service, info):
""" Called when a Chromecast has been discovered. """
print("Discovered a new Chromecast: {}".format(info))
discovery.listen(
hass, discovery.services.GOOGLE_CAST, chromecast_discovered)
```
### Auto-loading your component upon discovery
The Discovery component is capable of setting up your components before firing the `SERVICE_DISCOVERD` event. To do this you will have to update the [`SERVICE_HANDLERS`](https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/discovery.py#L29) constant in [the `discovery` component](https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/discovery.py).
<p class='note warning'>
This option is currently limited to built-in components.
</p>