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

Update SSDP integration manifest (#341)

Browse Source 
* Update SSDP integration manifest

* Update/fix example
This commit is contained in:
Ville Skyttä 2019-11-22 10:34:27 +02:00 committed by Paulus Schoutsen
parent 2f5529fedb
commit aa04eaabe5
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/creating_integration_manifest.md
View File

@ -96,21 +96,19 @@ If your integration supports discovery via [Zeroconf](https://en.wikipedia.org/w
## SSDP
If your integration supports discovery via [SSDP](https://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), you can add the type to your manifest. If the user has the `ssdp` integration loaded, it will load the `ssdp` step of your integration's config flow when it is discovered. We support SSDP discovery by ST, manufacturer and device type. Your integration is discovered if any of the specified info is found. It's up to your config flow to filter out duplicates.
If your integration supports discovery via [SSDP](https://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), you can add the type to your manifest. If the user has the `ssdp` integration loaded, it will load the `ssdp` step of your integration's config flow when it is discovered. We support SSDP discovery by ST, and all data in UPnP device description. The manifest value is a list of matcher dictionaries, your integration is discovered if all items of any of the specified matchers are found in the SSDP/UPnP data. It's up to your config flow to filter out duplicates.
The following example has one matcher consisting of three items, all of which must match for discovery to happen by this config.
```json5
{
"ssdp": {
"st": [
"roku:ecp"
],
"manufacturer": [
"Roku"
],
"device_type": [
"urn:roku-com:device:player:1-0"
]
}
"ssdp": [
{
"st": "roku:ecp",
"manufacturer": "Roku",
"deviceType": "urn:roku-com:device:player:1-0"
}
]
}
```