Skip to content

Commit

Permalink
Update SSDP integration manifest (#341)
Browse files Browse the repository at this point in the history
* Update SSDP integration manifest

* Update/fix example
  • Loading branch information
scop authored and balloob committed Nov 22, 2019
1 parent 2f5529f commit aa04eaa
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions docs/creating_integration_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
}
```

Expand Down

0 comments on commit aa04eaa

Please sign in to comment.