HiQNet

Driver provides ability to set and monitor parameters from HiQnet compatible devices. Supports up to 16 devices simultaneously, with up to 20 parameters per device.

Configuration

Global Settings

Total Device Count — Number of HiQNet devices to control (1–16).

Advanced Settings

Protocol Version — HiQNet protocol version. Use 02 for modern HiQNet-compatible devices. Use 01 only for dbx ZonePro devices.

Source Node Address — HiQNet node address assigned to this driver (default: 52). Must be unique on the network and must not conflict with Audio Architect’s HiQNet address.

Polling Interval (Seconds) — Keep-alive send interval in seconds (default: 8). Must be less than the device’s 10-second KAP timeout.

Per-Device Settings (configured for each device 1–16)

Device Name — Friendly name used in RTI variable and event labels.

IP / Hostname — IP address or hostname of the HiQNet device.

HiQNet Address — The device’s HiQNet network address, as shown in Audio Architect.

HiQNet Virtual Device — The device’s virtual device number, as shown in Audio Architect (typically 0).

Parameter Count — Number of parameters to control or monitor on this device (1–20).

Per-Parameter Settings (configured for each parameter per device)

Name — Friendly name used in RTI variable labels.

Object Address — The parameter’s object address as shown in Audio Architect, in dot-separated decimal format (e.g., 15.22.7).

Parameter ID — The parameter ID as shown in Audio Architect.

Allow Set — Enables sending values to the device for this parameter.

Set Method (when Allow Set is enabled) — Set (typed) sends a raw typed value. Set % (1.15 fixed point) encodes the value as a 1.15 fixed-point percentage.

Data Type (when Set Method is “Set typed”) — HiQNet data type of the value being sent: BYTE, UBYTE, WORD, UWORD, LONG, ULONG, FLOAT32, FLOAT64, LONG64, or ULONG64.

Enable Subscribe — Subscribes to push updates for this parameter from the device.

Variable Type (when Enable Subscribe is enabled) — RTI variable type used to represent the received value: Boolean, Integer, or String. When Data Type is FLOAT32 or FLOAT64 and Variable Type is Integer, the received float is multiplied by 100 and rounded before storage (e.g., 0.75 75).

Variables

Variables are created per device (N = device number, 1–16) and per parameter (P = parameter number, 1–20). Category and variable labels use the configured device and parameter names.

ConnectedN (Boolean) — True when device N is connected; false when disconnected.

ParameterBoolValueN_P (Boolean) — Current value of parameter P on device N, for parameters with Variable Type = Boolean.

ParameterIntValueN_P (Integer) — Current value of parameter P on device N, for parameters with Variable Type = Integer.

ParameterStringValueN_P (String) — Current value of parameter P on device N, for parameters with Variable Type = String.

Functions

Functions are created per device (N = device number, 1–16) and per parameter (P = parameter number, 1–20). Category labels use the configured device name.

Set [Parameter Name] Value — Sends the specified hex string value to parameter P on device N. Only available for parameters with Allow Set enabled. The value is sent using the configured Set Method and Data Type for that parameter.

Dump Device InfoN — Queries standard HiQnet attributes (IDs 0x0001–0x0006) on device N and logs the response to the trace log. Intended for debugging and device discovery.

Dump VD ListN — Broadcasts a GetVDList request and logs the response to the trace log. Intended for debugging.

Events

Events are fired per device (N = device number, 1–16).

ConnectedN — Fired when device N successfully connects and completes initialization.

DisconnectedN — Fired when device N loses its connection after previously being connected.

InitializedN — Fired when device N is instantiated during driver startup.

ConnectionFailedN — Fired when a TCP connection attempt to device N fails.

Revision History

1.0: Original release of the driver (partially complete)

2.0: Finish implementation of HiQNet protocol, many bug fixes

2.2: Hello session refusal; correct subscribe/unsubscribe lifecycle; percent push notification handling (ParamSetPercent, ParamSubscribePercent); fix FLOAT32/FLOAT64 value decoding; add Dump Device Info and Dump VD List debug commands