Ross Video openGear Parameter Controllable Device
Production
Recommended for normal production use.
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.
Minimum hi Version: v2.7.8
Overview
hi connects to Ross Video® openGear® frames over TCP. The integration reads and controls card parameters and receives parameter-value updates. Pinned parameters are also polled every 5 seconds.
Network Requirements
-
Connection Model: hi initiates a persistent TCP connection to the openGear frame.
-
Multicast / Unicast: Unicast only.
-
VLAN / IGMP: No multicast configuration is required.
-
Bandwidth: Control traffic only.
-
IP Version: IPv4.
-
Firewall: Allow outbound TCP from hi to the openGear frame on Port 5254, and outbound HTTP on Port 8080. hi reads the connection properties of the device on Port 8080 before it opens the control connection.
Standards Conformance
|
Standard |
Conformance |
Notes |
|---|---|---|
|
Ross Video openGear control |
Implemented |
Card parameters and parameter-value updates |
Operator Workflow
-
UI Surface in hi: Inventory, Topology, and Parameter Control
-
Resources Controlled: Cards and parameters exposed by the frame
-
Device Administration: Use DashBoard for frame and card provisioning and firmware. Only controls documented on this page are supported through hi.
Connection Details
|
Property |
Value |
|---|---|
|
Protocol |
Ross Video openGear control |
|
Transport |
TCP |
|
Default Port |
5254 |
|
Authentication |
None (network-level access control) |
|
Encryption in Transit |
None - plaintext TCP
|
|
Connection Model |
Persistent TCP with parameter and status updates |
|
Required License |
hiBase |
|
Traffic Flow |
Outbound connection with inbound responses and status updates |
Required Configuration
Caution
Force Connection can cause the frame to disconnect another client when its connection limit has been reached.
|
Parameter |
Description |
Default |
|---|---|---|
|
Host / IP Address |
IP address of the openGear frame |
- |
|
Port |
openGear control Port |
5254 |
|
Version |
DashBoard build that hi presents to the frame when it connects |
|
|
Force Connection |
Request a connection even when the frame reports that its client limit is reached |
|
Device-Side Setup
Follow Ross Video openGear Parameter Controllable Device Integration Configuration for the device-side and hi-side configuration steps.
Supported Features
|
Feature |
Access |
Exposed Operation and Scope |
|---|---|---|
|
Card Parameters |
Per-parameter access |
Read parameter values and write parameters that the openGear parameter schema marks writable; read-only parameters are presented as read-only in hi. |
|
Parameter-change Notifications |
Read-only subscription updates |
Subscribe to supported parameter updates and receive change notifications. |
Device Coverage
This integration supports the Ross Video openGear range.
Supported Product Range
-
openGear OG3-FR Series frames
-
openGear OGX-FR Series frames
Cards in these frames are in range when they offer the JSON variant of OGP.
Known Limitations
-
Connection capacity depends on the frame. Confirm that an additional control client is permitted before commissioning hi.
-
This integration uses the JSON variant of OGP on port
5254. A device that offers only the binary variant on port5253is outside the scope of this page. -
The set of parameters, their value ranges, and any commands come from each card at runtime. The parameters that hi shows therefore differ between card models and software versions.
-
If a card is absent, confirm that the frame publishes it through the commissioned DashBoard protocol version.
-
hi reads the connection-properties file of the device over HTTP on Port
8080only. A device can serve this file on Port80or8080. hi connects only when the file reports the JSON OGP equipment type. -
hi presents the Version value as the DashBoard build in the connection handshake, and it requests full detail and parameter subscriptions.
-
When the connection drops without a user request, hi reconnects automatically.
What's Not Supported
-
Firmware updates, card provisioning, and frame network configuration.
-
Alarm, status, and frame-GPI messages. The openGear protocol can carry them, and hi handles parameter values only.
-
SLP discovery. hi connects only to the address entered on the Node.
-
Password-protected connections. hi does not send a password in the connection handshake.
Trademarks
Note
Ross Video and openGear are trademarks of Ross Video Ltd.
All product names, logos, and brands are property of their respective owners. Copyright in third-party software and materials remains with the respective owners. Use of these names does not imply endorsement.
RIEDEL Communications is not affiliated with, endorsed by, or officially partnered with Ross Video unless explicitly stated.