hi human interface®
hi human interface®
English
Breadcrumbs

AMWA NMOS Registry Integration Configuration

AMWA NMOS Registry Integration Configuration

Caution

Compatibility Note: This information is a general guide and may be incomplete, may not match a specific project implementation, and is subject to change as supported products and versions evolve. Confirm the exact implementation and requirements for each project with Riedel and the relevant equipment vendor, then validate the required functions end to end in the target environment before deployment.

Configuration Overview

The hi NMOS Registry serves IS-04 Registration, Query, and Node APIs and the IS-09 System API from one exposed hi endpoint. Configure each NMOS Node or client to use that endpoint, and select the control-network interface in hi.

Caution

The registry endpoint does not provide TLS or authentication. Use it only on a controlled NMOS control network.

Before You Begin

Configure hi NMOS Registry

Use this configuration to register NMOS Nodes with hi and let clients query hi.

Device Configuration

  1. In the NMOS Node or client, open its registry or system settings. See the vendor documentation for the location.

  2. Where the device discovers registries through DNS-SD, make sure it browses for the IS-04 registration service type (_nmos-register._tcp; IS-04 v1.2 and earlier Nodes use _nmos-registration._tcp) and that the hi registry is the one it selects. hi advertises its Registration, Query, Node, and System API services on the network with these standard service types. hi advertises its registry services with the instance names hi-nmos-registration and hi-nmos-register and the priority value pri=99. AMWA defines 0 to 99 as production priority values. Where a Node sees several registries, confirm which priority it selects.

  3. Where the device does not discover registries, enter the address of the hi server and the registry port from Required Configuration.

  4. Where the device exposes a heartbeat setting, keep it consistent with the Heartbeat interval in hi.

  5. Permit Registration, Query, Node, System API, and WebSocket traffic from the NMOS Nodes and clients to the registry port on the hi server.

hi Configuration

  1. Add the NMOS Registry in Inventory, or enable Create NMOS Registry in the NMOS Core Integration, and create the Node. Only one NMOS Registry Node can exist in a system. See NMOS Core Integration.

  2. Open the Node. The settings below are available after the Node is created.

  3. Select the Interface that is connected to the NMOS control network.

  4. Set the Heartbeat interval in seconds if the default of 5 does not suit the Nodes.

  5. Save the Node and wait for it to initialize.

Settings Summary

Setting

Device Side

hi Side

Registry address

Address of the hi server and the registry port

Interface on the NMOS control network

Heartbeat

Node heartbeat interval

Heartbeat interval (default 5 seconds)

Common Checks

Symptom

Check

A Node does not register.

Confirm that the Node uses the hi server address and registry port, and that the network permits it.

A Node registers with another registry instead of hi.

A Node orders the advertised registries by pri, with 0 as the highest priority, and selects at random among registries with the same priority. hi advertises pri=99, so another production registry with a lower value takes precedence. A Node also filters out registries that do not match its required protocol and authorization mode. hi advertises api_proto=http and api_auth=false, so a Node that requires HTTPS or authorization does not select hi.

A Node drops out of the registry.

Confirm that the Node sends heartbeats at the interval the registry expects.

No resources appear.

Confirm that the selected Interface is the one connected to the NMOS control network.

Verify the Configuration

Confirm that each Node appears in the registry, maintains its registration health, and that its resources are returned by a Query client. Create a test Query subscription and change a resource to confirm that the update arrives through the WebSocket connection of the subscription.