Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Integration Driver mDNS advertisement

The Remote Two uses mDNS discovery to look for local integration drivers on the same network.

If an integration driver shall be discoverable, it needs to advertise the driver service using multicast DNS:

  • Service type: _uc-integration._tcp
  • Instance name: unique identifier of the integration driver (driver_id in the API model).

TXT Record

Additional information is published in the TXT record.

KeyRequiredFormatDescription
namextextIntegration name
developerxtextDeveloper or company of the integration
verxtextIntegration version number
ver_apitextImplemented integration API version
ws_urltextOverride the WebSocket url. ws_path, wss, wss_port will be ignored
ws_pathtextWebSocket endpoint path. Default: /
wssboolUse secure WebSocket connection
wss_portnumberWebSocket SSL port if different from published port, or driver supports ws & wss connections
pwdboolAccess token required

Examples

Node.js

Using bonjour-service:

const { Bonjour } = require('bonjour-service');
const bonjour = new Bonjour();

bonjour.publish({
    name: 'my-driver',
    type: 'uc-integration',
    port: 1234,
    txt: {
        name: 'My Driver',
        ver: '1.0.0',
        developer: 'Foobar Inc',
        ws_path: '/ws',
        pwd: 'true'
    }
});