hi human interface®
English

Appear X Platform Integration Configuration

Appear X Platform 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 Appear X Platform connects to hi as one Node. hi signs in to the management API with a local account, reads the IP Gateway resources of board slot 1, and polls them at the Polling Interval.

Configuration

What hi Sees

Use When

IP Gateway Routing

The IP inputs, IP outputs, and IP interfaces of the IP Gateway board in slot 1.

hi must route IP inputs of an X Platform.

Caution

A route from hi changes the settings of an IP input on the X Platform. Test routing on an input that is not on air.

Before You Begin

  • Use Node admin and open Inventory > Nodes. See Manage Nodes.

  • Confirm the license and minimum hi version in Required Configuration.

  • Use the Appear management interface to manage accounts and to check the IP Gateway configuration.

  • Confirm the network access in Network Requirements.

Configure IP Gateway Routing

Device Configuration

  1. On a new system, set a password for the factory account first. The factory account Admin has an empty password, and its first session can only set a password.

  2. Create or select a local account with access to the IP Gateway resources. Do not use an LDAP account. Sign in as a member of the Admin group, open System > Access Control > Users, and select Add User. Place the account in a group with change rights. The Operator role has view-only rights and cannot route.

  3. Confirm that the IP Gateway board that hi controls is in slot 1.

  4. Confirm that the management address is reachable over HTTPS from the hi server. The API accepts HTTPS only.

hi Configuration

  1. Add the X Platform integration (manufacturer Appear) in Inventory.

  2. Enter the full management address. The field starts with https://; keep it.

  3. In the Appear X Platform Login group, enter Username and Password of the local account.

  4. In the Settings group, keep Polling Interval at 1000 ms or enter a value from 500 to 120000 ms.

  5. Create the Node and wait for hi to read the IP Gateway resources.

Settings Summary

Setting

Device Side

hi Side

Management address

HTTPS management address of the platform

Address that starts with https://

Account

Local account with IP Gateway access

Username and Password

IP Gateway board

Board in slot 1

Read from slot 1
not configurable

Common Checks

Symptom

Check

The Node does not connect.

Confirm that the address starts with https://, that the account is local, and that the factory account password is set.

No inputs or outputs appear.

Confirm that the IP Gateway board is in slot 1.

hi shows a change late.

Lower the Polling Interval. The minimum is 500 ms.

Verify the Configuration

Compare the inputs, outputs, and interfaces in hi with the Appear management interface before production use. Inputs that belong to an ST 2110 group do not appear in hi. Route a test input from hi, and confirm the new address and port of the input in the Appear management interface. Then change a test input in the Appear management interface and confirm that hi shows the change within the Polling Interval.