Matrox ConvertIP

Driver Maturity

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.8.0

Overview

The Matrox^® ConvertIP^™ integration uses the device REST API to read and write supported parameters. Availability depends on the model, firmware, license, and configuration.

Network Requirements

Connection Model: Outbound from hi
Multicast / Unicast: Unicast only
Firewall: Allow outbound HTTPS from hi to the configured ConvertIP API URL. HTTPS uses Port 443 when the URL does not specify another Port.
Callback: No inbound callback to hi is used.
Credentials: Provide a ConvertIP account that can perform the required reads and writes.

Standards Conformance

Standard	Conformance	Notes
Matrox REST API	Implemented	Vendor API no public-standards conformance claimed

Operator Workflow

UI Surface in hi: Inventory, Parameter Control, and Control Panels
Parameters Controlled: Values exposed by the ConvertIP REST API and permitted by the commissioned account
Control Semantics: hi reads and writes supported parameters; it does not replace the device's engineering interface.
Tally / UMD Relationship: This parameter-control integration does not provide Tally or UMD control.
Notes for Operators Familiar with the Vendor's Own Tooling: Operators used to the vendor's web interface should expect hi to surface the controls exposed by the integration. The available operations depend on the installed firmware, licensed model, and device configuration.

Connection Details

Property	Value
Protocol	Matrox REST API
Transport	HTTPS
Default Port	443
Authentication	User name and password login hi uses the returned bearer session for API requests
Encryption in Transit	TLS (HTTPS) - encrypted in transit
Connection Model	HTTPS request/response with authenticated session renewal
Required License	hiBase
Traffic Flow	Outbound from hi

Required Configuration

Parameter	Description	Default
API URL	HTTPS URL of the ConvertIP device entered as the host of the Parameter Control capability	`https://`
User name	ConvertIP account used by hi in the User Credentials group	-
Password	Password for the configured account in the User Credentials group	-
Always Close Existing Sessions	Close existing device sessions before hi signs in, in the Settings group. `No` leaves existing sessions open; it does not restrict write access. Write access depends on the account role and whether hi can establish an authenticated session.	No

Device-Side Setup

Follow Matrox ConvertIP Integration Configuration for the device-side and hi-side configuration steps.

Supported Features

Feature	Access	Exposed Operation and Scope
Parameter Discovery	Read-only	Load the parameter structure exposed by the device API.
Parameter Readback	Read-only	Poll supported device, network, stream, and status values.
Parameter Control	Per-parameter access	Write only parameters marked writable by the discovered device schema; device/API authorization may further restrict writes.
Session Handling	Write-only session actions	Log in, renew authentication after an unauthorized response, and log out.
Device Reboot	Write-only action	Reboot the device from the Reboot folder.
SKU Direction	Read/write	Change the unit direction, transmit or receive, from the SKU folder. hi reboots the device to apply the change. The SKU value and the codec are read-only.

Device Coverage

Tested With identifies devices that have been tested with hi. Device-specific configuration, firmware, and feature support can affect results.

This integration supports the Matrox ConvertIP range.

Tested With

Matrox ConvertIP DSS
Matrox ConvertIP DSH

Supported Product Range

Matrox documents one REST API for the transmit and receive roles of the ConvertIP range, with some parameters available only on transmit or receive units. The models must expose the supported REST API login, discovery, read, and write operations.

Matrox ConvertIP DSH
Matrox ConvertIP DSS
Matrox ConvertIP DRS
Matrox ConvertIP SDM

Known Limitations

Validate the exposed parameter set against the installed ConvertIP firmware and licensed SKU.
hi accepts the certificate that the ConvertIP presents without validating it. Use the API only on a trusted management network.
The parameters present depend on whether the unit runs as a transmit or receive device and on its reported capabilities, so the same parameter tree is not available on every unit.
Device session limits can affect write access. Confirm whether replacing an existing session is acceptable before enabling that option.
hi polls only the parameters that are pinned on the Node, every 5 seconds. A value that changes on the device appears in hi with up to this delay.
Each polling cycle first checks that the device answers. When the check or a read fails, hi reports the Node as disconnected.

What's Not Supported

Changing the codec. hi reads the codec from the SKU, and it cannot set it.
Codec profile design and bitrate ladder authoring - use the vendor's native configuration tool.
Availability of firmware and SKU-related operations depends on the installed device firmware, licensed model, and controls exposed by the integration. Use the vendor's native tool for operations not presented in hi.
Stream forensics and packet-level diagnostics - outside the scope of this integration.
The ConvertIP stream, network, NMOS, audio, EDID, HDCP, privacy-encryption, certificate, user-account, log, and settings save and restore endpoints. hi loads only a fixed set of folders, including Status, Information, Caps, SKU, and Reboot.
Firmware updates. The ConvertIP REST API provides a device update operation, and hi does not expose it.

Trademarks

Note

Matrox and ConvertIP are trademarks or registered trademarks of Matrox Graphics Inc.

RIEDEL Communications is not affiliated with, endorsed by, or officially partnered with Matrox Video unless explicitly stated.