Ross Video openGear Parameter Controllable Device 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

An openGear frame or card connects to hi as one Parameter Control Node. hi first reads the connection properties of the device over HTTP, then opens a JSON OGP control connection and loads the parameters that the device publishes.

Configuration	What hi Sees	Use When
JSON OGP Control	The parameter tree that the device publishes, with per-parameter read and write access.	The device offers the JSON variant of OGP.

Caution

Force Connection asks the device to accept hi even when it has reached its client limit. The device can then disconnect another client, such as a DashBoard session. Leave it at No unless the commissioning plan requires it.

Before You Begin

Use Node admin and open Inventory > Nodes. See Manage Nodes.
Confirm the license and minimum hi version in Required Configuration.
Use DashBoard to confirm that the device is reachable and to check its client limit.
Confirm the network access in Network Requirements. hi needs Port 8080 and the control Port.

Configure JSON OGP Control

Device Configuration

Install the card in a compatible openGear frame and enable network control. Confirm that the device offers the JSON variant of OGP. openGear uses TCP Port 5254 for JSON OGP and Port 5253 for binary OGP.
Confirm that the device serves its connection-properties file at http://<device>:8080/connect/connection-props.xml. hi reads only this URL, and does not read the file on Port 80.
Confirm that the device accepts one more control client. A device can refuse a client when it cannot accept more connections.

hi Configuration

Add the openGear Parameter Controllable Device integration (manufacturer Ross Video) in Inventory.
Enter the device address and the Port. hi defaults to 5254.
In the Settings group, keep Version at its default or enter the DashBoard build that the commissioning plan names.
Leave Force Connection at No unless the device must accept hi at its client limit.
Create the Node and wait for hi to load the parameters.
Open the Parameters tab, select the parameters that hi must monitor, and select Pin Selected. hi polls pinned parameters every 5 seconds.

Settings Summary

Setting	Device Side	hi Side
Control Port	JSON OGP Port `5254` by default	Port default `5254`
Connection properties	File served on HTTP Port `8080`	Read by hi on Port `8080` not configurable
Client limit	Number of control clients the device accepts	Force Connection default `No`

Common Checks

Symptom	Check
The Node does not connect.	Confirm that hi reaches the device on Port `8080` and on the control Port, and that the device reports the JSON OGP equipment type.
The Node connects, then another client disconnects.	Force Connection is `Yes`. Set it to `No`, or confirm the client limit of the device.
A parameter cannot be changed.	The device marks the parameter as read-only. hi shows it as read-only.

Verify the Configuration

Confirm that the Node reports a connected state and that hi lists the expected cards. Compare several parameter values in hi with DashBoard. Change a safe parameter from hi and confirm the new value in DashBoard. Then change the same parameter in DashBoard and confirm that hi follows.