Matrox ConvertIP 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

A ConvertIP unit connects to hi as one Parameter Control Node through the ConvertIP REST API over HTTPS. The account role determines the permitted reads and writes. Always Close Existing Sessions decides whether hi may close another session when it signs in.

Configuration	What hi Sees	Use When
Read-Only Monitoring	The parameter tree, with the values of pinned parameters. Some parameters are unavailable, and hi does not write to the device.	hi must only monitor status, using an `operator` account.
Exclusive Control	The parameter tree, with the values of pinned parameters, the writable parameters, Reboot, and the SKU direction.	hi must change parameters, reboot the unit, or change the unit direction.

Caution

The device allows one session at a time. With Always Close Existing Sessions set to Yes, hi closes any other session when it signs in, and only hi can stay connected to the device.

Before You Begin

Use Node admin and open Inventory > Nodes. See Manage Nodes.
Confirm the license and minimum hi version in Required Configuration.
Use a ConvertIP account with the role that the configuration needs. The ConvertIP REST API provides the admin and operator roles.
Confirm the network access in Network Requirements.

Configure Read-Only Monitoring

Use an operator account when hi must only monitor status. Keep Always Close Existing Sessions at No when hi must not replace another device session.

Device Configuration

Confirm that the hi server can reach the unit over HTTPS on Port 443. On a new unit, create the Administrator account first, as described in Configure Exclusive Control.
Create or select the ConvertIP account that hi uses with the operator role. An operator account can read the Status folder. It cannot read the SKU folder, so do not pin SKU Parameters with an operator account.
Record the HTTPS address of the unit.

hi Configuration

Add the Matrox Video integration for ConvertIP in Inventory.
Enter the HTTPS URL of the unit as the host of the Parameter Control capability. The field starts with https://.
Enter User name and Password in the User Credentials group.
Keep Always Close Existing Sessions in the Settings group at No.
Create the Node, browse the parameter tree, and pin the status values that your workflow needs. See Parameter Control Nodes.

Configure Exclusive Control

Use this configuration when hi must write to the unit.

Device Configuration

Confirm that the hi server can reach the unit over HTTPS on Port 443.
On a new unit, sign in to the ConvertIP Command Center over HTTPS and create the Administrator account, or create it with Matrox ConvertIP Manager. Until an administrator account exists, the unit has only a factory default user, which can update firmware and create the administrator credentials but cannot change the configuration.
Create or select the ConvertIP account that hi uses, with the admin role. Matrox limits configuration writes to accounts with an administrator role.
Record the HTTPS address of the unit.

hi Configuration

Caution

A change of the SKU direction makes hi reboot the device. Change it only in a maintenance window.

Add the Matrox Video integration for ConvertIP in Inventory.
Enter the HTTPS URL of the unit as the host of the Parameter Control capability. The field starts with https://.
Enter User name and Password in the User Credentials group.
Set Always Close Existing Sessions in the Settings group to Yes only when hi may replace another device session. Otherwise, keep it at No and ensure that another session does not block login.
Create the Node, browse the parameter tree, and pin the parameters that your workflow needs. See Parameter Control Nodes.

Settings Summary

Setting	Device Side	hi Side
Account role	`admin` for writes `operator` for status monitoring	User name and Password
Existing sessions	One session at a time the login request can close existing sessions	Always Close Existing Sessions
Address	HTTPS address of the unit	Host of the Parameter Control capability starting with `https://`

Common Checks

Symptom	Check
Writable parameters are missing or writes fail.	Confirm that the account has the `admin` role and that hi can sign in. If another session blocks login, log out that session or enable Always Close Existing Sessions only when replacing it is permitted.
A value in hi lags behind the device.	hi polls pinned parameters every 5 seconds. Confirm that the parameter is pinned.
The Node reports a disconnected state.	Confirm that the unit answers on its HTTPS address and that the account can sign in.
hi cannot sign in although no other client seems to use the unit.	A ConvertIP Command Center session stays active when the browser closes without logging out. Log out of the Command Center, or enable Always Close Existing Sessions only when replacing it is permitted.
Another client loses its session to the unit.	Always Close Existing Sessions is `Yes`, so hi closes existing sessions when it signs in.

Verify the Configuration

Confirm that hi signs in and that the expected parameter tree appears. Compare representative status values in hi with the Matrox web interface. With Exclusive Control, write a noncritical parameter from hi and confirm the result on the unit. Reconnect after a session timeout and confirm that hi restores the authenticated session.