Additional attributes - rosteleset/SmartYard-Server GitHub Wiki

Both intercoms and cameras have an Extended tab, where all additional device attributes are placed inside the JSON object.

Intercom

forceFlatExtension

One apartment with the specified SIP number will be assigned to the intercom. This option is used when a single-subscriber intercom must be associated with several apartments, allowing you to specify which apartment should receive the call when the button is pressed.

[!WARNING] Use only with single-subscriber devices!

Call to the concierge:

{
    "forceFlatExtension": "9999"
}

Call to the flat with ID 1234:

{
    "forceFlatExtension": "1000001234"
}

doorOpeningUrls

Allows specifying custom URLs used to trigger door opening. This can be useful when working with a dummy device. For devices that already support a built-in door-opening mechanism, this attribute overrides the default behavior according to the provided configuration.

[!NOTE] This attribute is used only when the door is opened via the mobile API (i.e., from the mobile app).

A list of URLs can be provided as an array, where each entry corresponds to the index of the door being opened (0, 1, 2...):

{
    "doorOpeningUrls": [
        "http://admin:[email protected]/cgi-bin/intercom_cgi?action=maindoor",
        "https://webhook.site/c0424ce5-041a-484e-9a3e-f0477c630b1e"
    ]
}

It may also be an object, for example when you need to override the behavior of only the second door (with index 1):

{
    "doorOpeningUrls": {
        "1": "http://admin:[email protected]/cgi-bin/intercom_cgi?action=maindoor"
    }
}

Camera

snapshotUrl

Use the specified URL to fetch a snapshot. This can be useful for cameras that are not supported by SmartYard, dummy devices, or other non-standard devices.

Example:

{
    "snapshotUrl": "https://cdn0.tnwcdn.com/wp-content/blogs.dir/1/files/2021/11/Memesyndi.jpg"
}

FALPRS (FRS) parameters

Camera attributes also contain parameters used by FALPRS (FRS). For detailed information about these parameters, see the documentation under Schema → config.

Parameters are placed in the JSON as-is, for example:

{
    "nonFalprsAttribute": "foo",
    "blur": 100,
    "capture-timeout": "5s",
    "otherNonFalprsAttribute": "bar"
}