From 3f51f6a3dbfacb830ac30d05cf67f5fae1be3e40 Mon Sep 17 00:00:00 2001 From: Andrew Fiddian-Green Date: Fri, 7 Jun 2024 08:30:10 +0100 Subject: [PATCH] Provide more explanation of match preoprty value names for SDDP discovery (#2306) Signed-off-by: Andrew Fiddian-Green --- developers/addons/addon.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/developers/addons/addon.md b/developers/addons/addon.md index 495a2ce0a..8cd749bc2 100644 --- a/developers/addons/addon.md +++ b/developers/addons/addon.md @@ -112,6 +112,22 @@ Notes: | `upnp` | "deviceType", "manufacturer", "manufacturerURI", "modelName", "modelNumber", "modelDescription", "modelURI", "serialNumber", "friendlyName". | | `usb` | "product", "manufacturer", "chipId", "remote". | +For the `sddp` service type, the meaning of the `match-property` `name` values is explained further as follows: + +| Name Value | Description | +|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| `from` | The network address of the device. For example: 192.168.4.237:1902 | +| `host` | The host address of the device. For example: JVC_PROJECTOR-E0DADC152802 Note: the last 12 characters represent the MAC address of the device. | +| `type` | The type of the device. Usually a colon delimited combination of a manufacturer id and a device type id. For example: JVCKENWOOD:Projector | +| `primaryProxy` | The id of the primary proxy that provides device services. For example: projector | +| `proxies` | A comma delimited list of proxies. For example: projector,thingy,etc Normally the first entry is the primary proxy. | +| `manufacturer` | The device manufacturer. For example: JVCKENWOOD | +| `model` | The model number of the device. For example: DLA-RS3100_NZ8 | +| `driver` | The driver id. For example: projector_JVCKENWOOD_DLA-RS3100_NZ8.c4i | +| `ipAddress` | The dotted IP address part of the 'from' field. For example: 192.168.4.237 | +| `port` | The port part of the 'from' field. For example: 1902 (a String value) | +| `macAddress` | The MAC address of the device as derived from the last 12 characters of the host field. It is presented in lower-case, dash delimited, format. For example: e0-da-dc-15-28-02 Therefore it may be used as a (unique) sub- part of a Thing UID. | + ## Example The following code gives an example for an add-on definition used in bindings.