498 lines
28 KiB
HTML
498 lines
28 KiB
HTML
|
|
||
|
|
<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<meta name="generator" content="Adobe RoboHelp 9">
|
||
|
|
<title>Direct Inject Tool</title>
|
||
|
|
<link rel="StyleSheet" href="HtmlHelp.css" type="text/css">
|
||
|
|
<style title="hcp" type="text/css">
|
||
|
|
<!--
|
||
|
|
img.hcp1 { border-width:2px;
|
||
|
|
border-style:solid;
|
||
|
|
margin-top:0px;
|
||
|
|
margin-bottom:0px;
|
||
|
|
margin-left:0px;
|
||
|
|
margin-right:0px; }
|
||
|
|
span.hcp2 { font-style:italic; }
|
||
|
|
span.hcp3 { font-weight:bold; }
|
||
|
|
span.hcp4 { font-family:monospace; }
|
||
|
|
-->
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="ns-0 ltr">
|
||
|
|
<div id="globalWrapper">
|
||
|
|
<div id="column-content">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<p style="margin-bottom: 0;"><!-- Served by hproukweb01.hprouk.ad.harman.com in 0.43 secs. --></p>
|
||
|
|
<div id="content" style="width: 833px; height: 12196px;">
|
||
|
|
<h1 class="firstHeading">Direct Inject Tool</h1>
|
||
|
|
<div id="bodyContent" style="height: 12129px;">
|
||
|
|
<h2>Introduction</h2>
|
||
|
|
<p>For some control situations, generating messages on the fly
|
||
|
|
as described in the <a href="Third-party Control Protocol.html">Third-party
|
||
|
|
Control Protocol</a> section of the help is too complex. There
|
||
|
|
are two methods of generating control strings for simpler controller
|
||
|
|
configurations that only need to send a small number of fixed
|
||
|
|
messages to a Soundweb London network. The first is through the
|
||
|
|
Direct Inject toolbar in HiQnet London Architect. The second is
|
||
|
|
using the Direct Inject message tool.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Direct_Inject_Toolbar_in_HiQnet_London_Architect" id="Direct_Inject_Toolbar_in_HiQnet_London_Architect"></a></p>
|
||
|
|
<h2>Direct Inject Toolbar in HiQnet London Architect</h2>
|
||
|
|
<p>The Direct Inject toolbar may be useful if a small number of
|
||
|
|
fixed messages is required for your third-party controller.</p>
|
||
|
|
<p>To generate a control string that sets a control parameter to
|
||
|
|
a specific value, simply select the control, set it to the desired
|
||
|
|
value using soft-operate mode, and copy the contents of the DI
|
||
|
|
toolbar.</p>
|
||
|
|
<p>For example, to generate a message to set a gain object to 0dB,
|
||
|
|
first select the gain control:</p>
|
||
|
|
<p><img src="Gain_default_control_panel_0db.jpg" alt="Image:gain_default_control_panel_0db.png" title="Image:gain_default_control_panel_0db.png" width="152" height="358" border="2" class="hcp1"></p>
|
||
|
|
<p> <br>
|
||
|
|
Then copy the string from the toolbar:</p>
|
||
|
|
<p><img src="Di_toolbar_decimal.jpg" alt="Image:di_toolbar_decimal.png" title="Image:di_toolbar_decimal.png" width="442" height="25" border="2" class="hcp1"></p>
|
||
|
|
<p><span class="hcp2"><span class="hcp3">Note:</span>
|
||
|
|
For messages to appear in the toolbar you will need to be in design
|
||
|
|
mode or soft-operate mode (Soft-operate mode is activated by holding
|
||
|
|
the ALT key while in design mode and adjusting the desired control).</span></p>
|
||
|
|
<p> <br>
|
||
|
|
The format of the strings generated by the toolbar can be customized
|
||
|
|
by pressing the ellipsis icon to open the Message Setup dialog:</p>
|
||
|
|
<p><img src="Di_toolbar_ellipsis.jpg" alt="Image:di_toolbar_ellipsis.png" title="Image:di_toolbar_ellipsis.png" width="442" height="25" border="2" class="hcp1"></p>
|
||
|
|
<p> <br>
|
||
|
|
The toolbar can be configured to provide many different serial
|
||
|
|
string formats and DI message types, in decimal and hexadecimal,
|
||
|
|
with surrounding keywords if required, allowing you to save the
|
||
|
|
time needed to format control messages for your controller.</p>
|
||
|
|
<p>For example, if your controller uses a function called <span class="hcp3">SEND</span>, followed by a list of
|
||
|
|
bytes in quotes, then the toolbar should be configured as follows:</p>
|
||
|
|
<p><img src="Di_message_setup.jpg" alt="Image:di_message_setup.png" title="Image:di_message_setup.png" width="480" height="346" border="2" class="hcp1"></p>
|
||
|
|
<p> <br>
|
||
|
|
The above example generates:</p>
|
||
|
|
<p><span class="hcp4">SEND "0x02, 0x88,
|
||
|
|
0x00, 0x01, 0x1B, 0x83, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||
|
|
0x00, 0x00, 0x8B, 0x03"</span></p>
|
||
|
|
<p> <br>
|
||
|
|
For a C-style format, try the following:</p>
|
||
|
|
<p><img src="Di_message_setup_c_style.jpg" alt="Image:di_message_setup_c_style.png" title="Image:di_message_setup_c_style.png" width="480" height="346" border="2" class="hcp1"></p>
|
||
|
|
<p> <br>
|
||
|
|
Which generates:</p>
|
||
|
|
<p><span class="hcp4">char message[] = {0x02,
|
||
|
|
0x88, 0x00, 0x01, 0x1B, 0x83, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
|
||
|
|
0x00, 0x00, 0x00, 0x8B, 0x03};</span></p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Direct_Inject_Tool" id="Direct_Inject_Tool"></a></p>
|
||
|
|
<h2>Direct Inject Tool</h2>
|
||
|
|
<p>The intention of this tool is for testing and debugging. It
|
||
|
|
can be used to generate strings in a similar way to London Architect,
|
||
|
|
but will allow you to send messages over a serial connection and
|
||
|
|
over Ethernet and also provides testing for subscription.</p>
|
||
|
|
<p>Launch the DI tool by clicking on the DI box icon on the message
|
||
|
|
toolbar.</p>
|
||
|
|
<p><img src="Di_toolbar_toolbox.jpg" alt="Image:di_toolbar_toolbox.png" title="Image:di_toolbar_toolbox.png" width="442" height="25" border="2" class="hcp1"></p>
|
||
|
|
<p><span class="hcp2"><span class="hcp3">Note:</span>
|
||
|
|
For the curious, the DI box icon is a picture of the BSS Audio
|
||
|
|
AR-133 direct-inject box.</span></p>
|
||
|
|
<p><img src="Di_tool_serial_mode.jpg" alt="Image:di_tool_serial_mode.png" title="Image:di_tool_serial_mode.png" width="681" height="608" border="2" class="hcp1"></p>
|
||
|
|
<p><a name="Menus" id="Menus"></a></p>
|
||
|
|
<h2>Menus</h2>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Options" id="Options"></a></p>
|
||
|
|
<h3>Options</h3>
|
||
|
|
<p><span class="hcp3">Show</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="p"><p><span class="hcp3">Incoming
|
||
|
|
bytes</span></p></li>
|
||
|
|
</ul>
|
||
|
|
<p>This option controls whether the received bytes are shown in
|
||
|
|
hex. This is useful for debugging serial trigger objects.</p>
|
||
|
|
<ul>
|
||
|
|
<li class="p"><p><span class="hcp3">Incoming
|
||
|
|
ACKs</span></p></li>
|
||
|
|
</ul>
|
||
|
|
<p>This option controls whether ACKs are shown in the received
|
||
|
|
message traffic window. The word ACK is shown in the window when
|
||
|
|
an 0x06 byte is received back from the device. If you have incoming
|
||
|
|
bytes also switched on, you will see ACK 0x06.</p>
|
||
|
|
<ul>
|
||
|
|
<li class="p"><p><span class="hcp3">Incoming
|
||
|
|
messages, Outgoing messages</span></p></li>
|
||
|
|
</ul>
|
||
|
|
<p>These two options control whether the sent and received messages
|
||
|
|
are shown in the message traffic windows. They default to on which
|
||
|
|
is the most useful. Consider switching them off if you have lots
|
||
|
|
of traffic, e.g. many subscriptions, to improve performance of
|
||
|
|
the graphical meters in the meter window (described below).</p>
|
||
|
|
<p>A double-click in either of the message traffic windows will
|
||
|
|
clear them.</p>
|
||
|
|
<p><span class="hcp3">Acknowledge message</span></p>
|
||
|
|
<p>This option controls whether the Acknowledge character is sent
|
||
|
|
in response to received messages. It defaults to ON.</p>
|
||
|
|
<p><span class="hcp3">Log</span></p>
|
||
|
|
<ul>
|
||
|
|
<li class="p"><p><span class="hcp3">Control ports</span></p></li>
|
||
|
|
</ul>
|
||
|
|
<p>This is a useful debug feature if you need to closely inspect
|
||
|
|
the control ports on a device, perhaps tracking down interference.
|
||
|
|
When used in conjunction with the control port subscriptions in
|
||
|
|
the toolbox window, it will write real-time control port values
|
||
|
|
to a file called cplog.txt in the directory that the application
|
||
|
|
was launched from (usually "C:\Program Files\Harman Pro\London
|
||
|
|
Architect\"). It is a comma separated value file, as shown:</p>
|
||
|
|
<p class="Preformatted">port: 0, 001,<br>
|
||
|
|
port: 0, 255,</p>
|
||
|
|
<p><span class="hcp3">Auto-track London Architect
|
||
|
|
object</span></p>
|
||
|
|
<p>This option connects London Architect to the DI message tool
|
||
|
|
so that the details of the currently selected State variable are
|
||
|
|
copied across to assist in simple testing. See full description
|
||
|
|
in the following pages.</p>
|
||
|
|
<p><span class="hcp3">Auto-track London Architect
|
||
|
|
message toolbar</span>Similar to tracking the selected object,
|
||
|
|
this option copies the message string from the London Architect
|
||
|
|
message toolbar in the DI message tool so that it can be sent
|
||
|
|
to a device on the selected communications port.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Settings" id="Settings"></a></p>
|
||
|
|
<h3>Settings</h3>
|
||
|
|
<p><span class="hcp3">Comms</span></p>
|
||
|
|
<p>This option launches the communications setup dialog.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Show" id="Show"></a></p>
|
||
|
|
<h3>Show</h3>
|
||
|
|
<p><span class="hcp3">Toolbox</span></p>
|
||
|
|
<p>Show the toolbox window.</p>
|
||
|
|
<p style="font-weight: bold;">GPX/GPZ
|
||
|
|
Toolbox</p>
|
||
|
|
<p>Show the toolbox window for
|
||
|
|
the BLU-GPX and BLU-GPX</p>
|
||
|
|
<p><span class="hcp3">Meters</span></p>
|
||
|
|
<p>Show the meters window.</p>
|
||
|
|
<p><span class="hcp3">Network window</span></p>
|
||
|
|
<p>Show the network window (when using Ethernet). There is also
|
||
|
|
a button to show the network window, on the left hand side of
|
||
|
|
the main window.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Help" id="Help"></a></p>
|
||
|
|
<h3>Help</h3>
|
||
|
|
<p><span class="hcp3">About</span></p>
|
||
|
|
<p>Show the about box, with version information.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Getting_started" id="Getting_started"></a></p>
|
||
|
|
<h2>Getting started</h2>
|
||
|
|
<p>You must first choose a communication method from the Settings
|
||
|
|
dialog, available by selecting Comms from the Settings menu. The
|
||
|
|
available communication methods are RS-232 (serial) and TCP/IP
|
||
|
|
(Ethernet).</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="RS-232_Connection" id="RS-232_Connection"></a></p>
|
||
|
|
<h3>RS-232 Connection</h3>
|
||
|
|
<p>A serial connection requires you to choose a valid COM port
|
||
|
|
and baud rate. The Direct Inject Message Tool provides a large
|
||
|
|
selection of ports to allow the use of serial servers such as
|
||
|
|
the Moxa multi-port server. The default rate for Soundweb London
|
||
|
|
devices is 115200, but this can be changed in the device's Properties
|
||
|
|
view in HiQnet London Architect. The rate selected in the Message
|
||
|
|
Tool must match the rate set for the device in HiQnet London Architect.
|
||
|
|
Note that HiQnet London Architect may be using one or more serial
|
||
|
|
ports open, if it is configured to use them for FDS devices in
|
||
|
|
the Serial tab of the Application Preferences dialog. These must
|
||
|
|
be unchecked and Architect restarted if you wish to use those
|
||
|
|
ports in the Message Tool. See the <a href="Third-party Control Protocol.html">Third-party
|
||
|
|
Control Protocol</a> section for information on the physical connection
|
||
|
|
required.</p>
|
||
|
|
<p><img src="Di_tool_settings_serial_mode.jpg" alt="Image:di_tool_settings_serial_mode.png" title="Image:di_tool_settings_serial_mode.png" width="403" height="532" border="2" class="hcp1"></p>
|
||
|
|
<p><span class="hcp2">Direct Inject Message Tool
|
||
|
|
- Communication Settings</span></p>
|
||
|
|
<p>After selecting the correct settings, the status bar of the
|
||
|
|
Message Tool window will indicate whether opening the port was
|
||
|
|
successful.</p>
|
||
|
|
<p><img src="Di_tool_connected_to_com1.jpg" alt="Image:di_tool_connected_to_com1.png" title="Image:di_tool_connected_to_com1.png" width="286" height="69" border="2" class="hcp1"></p>
|
||
|
|
<p><span class="hcp2">Successfully connected to
|
||
|
|
the serial port on COM1.</span></p>
|
||
|
|
<p><img src="Di_tool_port_already_open.jpg" alt="Image:di_tool_port_already_open.png" title="Image:di_tool_port_already_open.png" width="286" height="69" border="2" class="hcp1"></p>
|
||
|
|
<p><span class="hcp2">Another application is using
|
||
|
|
the serial port, choose another or close the other application.</span></p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="TCP.2FIP_Connection" id="TCP.2FIP_Connection"></a></p>
|
||
|
|
<h3>TCP/IP Connection</h3>
|
||
|
|
<p>Ethernet is a little more involved. Select the Ethernet option,
|
||
|
|
then choose a network adapter for the DI message tool to use.
|
||
|
|
To aid sending messages to units, we have provided two methods
|
||
|
|
of viewing the devices on the network and therefore retrieving
|
||
|
|
their IP addresses.</p>
|
||
|
|
<p><img src="Di_tool_settings_ethernet.jpg" alt="Image:di_tool_settings_ethernet.png" title="Image:di_tool_settings_ethernet.png" width="403" height="532" border="2" class="hcp1"></p>
|
||
|
|
<p>When you are running London Architect at the same time as the
|
||
|
|
DI message tool, the Ethernet port for device discovery (3804)
|
||
|
|
is in use by Architect, so we provide a list of devices directly
|
||
|
|
from Architect. If you are using the DI message tool on its own,
|
||
|
|
then it can discover the devices on the network on its own, via
|
||
|
|
a UDP connection.</p>
|
||
|
|
<p>The network view pops out the side of the main dialog by choosing
|
||
|
|
'Network window' on the Show menu or by pressing the thin button
|
||
|
|
on the left of the Message settings section of the main dialog.</p>
|
||
|
|
<p><img src="Di_tool_network_panel.jpg" alt="Image:di_tool_network_panel.png" title="Image:di_tool_network_panel.png" width="498" height="310" border="2" class="hcp1"></p>
|
||
|
|
<p>When this view is populated with units, you will see their name
|
||
|
|
and device type as an icon. As you click on a unit in this tree
|
||
|
|
view, the application will attempt to make a TCP connection to
|
||
|
|
the unit on port 1023 (the DI message port).</p>
|
||
|
|
<p>The status of this connection is shown in the status bar of
|
||
|
|
the main dialog.</p>
|
||
|
|
<p>If successful, you can press the locate button in this pop-out
|
||
|
|
view to verify the connection. This will flash the locate button
|
||
|
|
on front and rear of the unit.</p>
|
||
|
|
<p><img src="Di_tool_tcp_connected.jpg" alt="Image:di_tool_tcp_connected.png" title="Image:di_tool_tcp_connected.png" width="286" height="69" border="2" class="hcp1"></p>
|
||
|
|
<p><span class="hcp2">Successfully connected to
|
||
|
|
a unit on Ethernet with a remote IP address of 10.1.4.4.</span></p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Toolbox" id="Toolbox"></a></p>
|
||
|
|
<h2>Toolbox</h2>
|
||
|
|
<p>The Direct Inject message tool provides a useful toolbox for
|
||
|
|
sanity checking. Open this small dialog by clicking on the Show
|
||
|
|
menu, then Toolbox. To very simply check you are connected to
|
||
|
|
the unit correctly and at the right baud rate, press the Locate
|
||
|
|
button on this toolbox dialog. The unit will flash its locate
|
||
|
|
button on the front and rear of the unit.</p>
|
||
|
|
<p><img src="Di_tool_toolbox.jpg" alt="Image:di_tool_toolbox.png" title="Image:di_tool_toolbox.png" width="379" height="350" border="2" class="hcp1"></p>
|
||
|
|
<p>The following controls are for simple test and debugging, they
|
||
|
|
are not intended to be used for a live system.  The supported
|
||
|
|
methods of control are in London Architect where there are duplicate
|
||
|
|
controls on the device control panel. Use these at your own risk.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Contrast" id="Contrast"></a></p>
|
||
|
|
<h3>Contrast</h3>
|
||
|
|
<p>Slide this control to adjust the display contrast on the device.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Logic_outputs" id="Logic_outputs"></a></p>
|
||
|
|
<h3>Logic outputs</h3>
|
||
|
|
<p>The logic outputs on the Soundweb London Device can be directly
|
||
|
|
set from these controls.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Control_ports" id="Control_ports"></a></p>
|
||
|
|
<h3>Control ports</h3>
|
||
|
|
<p>These controls allow subscription directly to the control port
|
||
|
|
value. Click on each of the edit boxes to subscribe. When subscription
|
||
|
|
messages are sent back from the device, the value is shown in
|
||
|
|
the box for that control port. Click again to toggle the subscription
|
||
|
|
off. Use this in conjunction with the option to log control port
|
||
|
|
values if required.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="CobraNet" id="CobraNet"></a></p>
|
||
|
|
<h3>CobraNet</h3>
|
||
|
|
<p>Meters on is a control to globally switch the CobraNet bundle
|
||
|
|
meters on and off.</p>
|
||
|
|
<p>When the Free cycles option is checked, a subscription message
|
||
|
|
is sent to the Free cycle meter state variable. This will show
|
||
|
|
a percentage of free processing cycles on the CobraNet card's
|
||
|
|
processor. These two controls give a very quick method of determining
|
||
|
|
the amount of processing cycles spent on meters.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Set_time_from_PC" id="Set_time_from_PC"></a></p>
|
||
|
|
<h3>Set time from PC</h3>
|
||
|
|
<p>Press to set the time on the Soundweb London device. This is
|
||
|
|
a simple test function, and does not take account of daylight
|
||
|
|
saving adjustments on your local PC.</p>
|
||
|
|
<h2><a name="GPX_GPZ_Toolbox"></a></h2>
|
||
|
|
<h2>GPX/GPZ Toolbox</h2>
|
||
|
|
<p><img src="BLU-GPX_BLU-GPZ/GPIO Images/GPX_Toolbox.PNG" style="border: none;" alt="" border="0"></p>
|
||
|
|
<p>The Direct Inject Message GPX/GPZ
|
||
|
|
Toolbox is functionally the same as the <a href="Direct Inject Tool.html#Toolbox">Toolbox</a>
|
||
|
|
described above with the following exceptions.</p>
|
||
|
|
<h3>Logic Outputs</h3>
|
||
|
|
<p>The GPX/GPZ Toolbox offers
|
||
|
|
control over 23 Logic Output ports as oppose to the 6 ports which
|
||
|
|
are found at the rear of the other London processing devices.</p>
|
||
|
|
<h3>Relay Outputs</h3>
|
||
|
|
<p>The Relay Outputs on the BLU-GPX
|
||
|
|
and BLU-GPZ can be directly set from these controls.</p>
|
||
|
|
<h3>Control Ports</h3>
|
||
|
|
<p>These are subscribed as described
|
||
|
|
in the <a href="Direct Inject Tool.html#Toolbox">Toolbox</a> topic above.  36 Control
|
||
|
|
Ports can be subscribed as oppose to the 12 which are available
|
||
|
|
in the other London processing devices.</p>
|
||
|
|
<h3>Cobranet</h3>
|
||
|
|
<p>Cobranet is not available on
|
||
|
|
the BLU-GPX or BLU-GPZ.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Synchronizing_with_London_Architect.27s_DI_Toolbar"
|
||
|
|
id="Synchronizing_with_London_Architect.27s_DI_Toolbar"></a></p>
|
||
|
|
<h2>Synchronizing with London Architect's DI Toolbar</h2>
|
||
|
|
<p>Strings generated by the Direct Inject toolbar in HiQnet London
|
||
|
|
Architect can be sent using the Direct Inject message tool to
|
||
|
|
test your setup. They can be generated in decimal or '0x'-prefixed
|
||
|
|
hex, separated by either spaces or commas. When parsing the string
|
||
|
|
in the toolbar, the DI tool looks for an '0x' first; if present
|
||
|
|
the string is interpreted as hex, decimal otherwise. To make use
|
||
|
|
of this facility, configure the message format in HiQnet London
|
||
|
|
Architect as follows:</p>
|
||
|
|
<p><img src="Di_message_setup_highlighted_for_di_tool.jpg" alt="Image:di_message_setup_highlighted_for_di_tool.png" title="Image:di_message_setup_highlighted_for_di_tool.png" width="480" height="346" border="2" class="hcp1"></p>
|
||
|
|
<p>Example string formats compatible with the DI tool:</p>
|
||
|
|
<p class="Preformatted">Decimal: 2 136 0 1 27 131 0 1 0 0 0 0 0 0 0 139 3<br>
|
||
|
|
            2,136,0,1,27,131,0,1,0,0,0,0,0,0,0,139,3</p>
|
||
|
|
<p class="Preformatted">Hex:       0x02 0x88 0x00 0x01 0x1B 0x83 0x00 0x01 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x8B 0x03<br>
|
||
|
|
            0x02,0x88,0x00,0x01,0x1B,0x83,0x00,0x01,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x8B,0x03</p>
|
||
|
|
<p>Now enable toolbar tracking in the DI message tool by checking
|
||
|
|
the "Auto-track London Architect message toolbar" entry
|
||
|
|
in the Options menu.</p>
|
||
|
|
<p>The string that London Architect is displaying will be automatically
|
||
|
|
shown in the DI message tool in real time, so that you don't need
|
||
|
|
to copy and paste it.</p>
|
||
|
|
<p><img src="Di_tool_tracking_di_toolbar.jpg" alt="Image:di_tool_tracking_di_toolbar.png" title="Image:di_tool_tracking_di_toolbar.png" width="664" height="358" border="2" class="hcp1"></p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Examples" id="Examples"></a></p>
|
||
|
|
<h2>Examples</h2>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Controlling_a_Gain" id="Controlling_a_Gain"></a></p>
|
||
|
|
<h3>Controlling a Gain</h3>
|
||
|
|
<p>The following is an example of using the message tool to set
|
||
|
|
a gain:</p>
|
||
|
|
<p>Enable the Auto-track London Architect Object setting in the
|
||
|
|
DI tool's Options menu.</p>
|
||
|
|
<p><img src="Di_tool_track_la_object.jpg" alt="Image:di_tool_track_la_object.png" title="Image:di_tool_track_la_object.png" width="261" height="110" border="2" class="hcp1"></p>
|
||
|
|
<p>Select HiQnet address in the Message Settings part of the DI
|
||
|
|
message tool dialog. In the Properties window, click on the Gain
|
||
|
|
parameter of a gain processing object. The HiQNet address in the
|
||
|
|
DI tool will change change to that of the gain object.</p>
|
||
|
|
<p><img src="Gain_sv_for_di_tool.jpg" alt="Image:gain_sv_for_di_tool.png" title="Image:gain_sv_for_di_tool.png" width="414" height="151" border="2" class="hcp1"> <img src="Di_tool_hiqnet_address_highlighted.jpg" alt="Image:di_tool_hiqnet_address_highlighted.png" title="Image:di_tool_hiqnet_address_highlighted.png" width="294" height="163" border="2" class="hcp1"></p>
|
||
|
|
<p>Select a message type of Set and a data type of 'Gain, dB.'
|
||
|
|
Data can be entered directly in decibels with the 'Gain, dB' data
|
||
|
|
type. The current value is copied from HiQnet London Architect
|
||
|
|
along with the other object data.</p>
|
||
|
|
<p>Note that the Node, VD, and Object ID fields will accept both
|
||
|
|
hexadecimal and decimal numbers; the numbers generated by HiQnet
|
||
|
|
London Architect for these values are hexadecimal. The State Variable
|
||
|
|
IDs generated in HiQnet London Architect are decimal numbers so
|
||
|
|
these should be entered into the DI tool in decimal.</p>
|
||
|
|
<p>If you wish to enter the Node, VD, and Object ID of a processing
|
||
|
|
object manually, refer to <a href="Common Object and State Variable IDs.html">Common
|
||
|
|
Object and State Variable IDs</a> for a table of common Object
|
||
|
|
IDs. Note in particular that all audio processing objects live
|
||
|
|
in virtual device <span class="hcp4">0x03</span>,
|
||
|
|
and that node <span class="hcp4">0x0000</span>
|
||
|
|
refers to the device directly connected to the DI tool via TCP/IP
|
||
|
|
or RS-232.</p>
|
||
|
|
<p><span class="hcp2"><span class="hcp3">Note:</span>
|
||
|
|
When entering hexadecimal numbers in any of the edit fields, prefix
|
||
|
|
them with 0x.</span></p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Subscribing_to_Meters" id="Subscribing_to_Meters"></a></p>
|
||
|
|
<h3>Subscribing to Meters</h3>
|
||
|
|
<p>The following example sets up the message tool to display the
|
||
|
|
four input meters from an Analogue Input card installed in slot
|
||
|
|
A.</p>
|
||
|
|
<p>Select Subscribe as the message type.</p>
|
||
|
|
<p>The VD should be <span class="hcp4">0x03</span>.
|
||
|
|
The Object ID should be <span class="hcp4">0x000001</span>,
|
||
|
|
which is the first I/O card.</p>
|
||
|
|
<p>Set the State Variable ID to 0, which is the first channel's
|
||
|
|
meter (for Analogue I/O cards).</p>
|
||
|
|
<p>The data field is the subscription rate in milliseconds, so
|
||
|
|
a value of 100 will produce meter updates at a rate of 10 updates
|
||
|
|
per second. Setting this value too low may adversely affect control
|
||
|
|
system and logic performance.</p>
|
||
|
|
<p>Press Send to send this subscribe message.</p>
|
||
|
|
<p><img src="Di_tool_subscribe_to_meter.jpg" alt="Image:di_tool_subscribe_to_meter.png" title="Image:di_tool_subscribe_to_meter.png" width="681" height="608" border="2" class="hcp1"></p>
|
||
|
|
<p>Repeat this process with State Variable IDs of <span class="hcp4">6</span>,
|
||
|
|
<span class="hcp4">12</span>, and <span class="hcp4">18</span>.</p>
|
||
|
|
<p>The meter window provides four meters which listen to messages
|
||
|
|
from Virtual Device <span class="hcp4">0x03</span>,
|
||
|
|
and the Object and State Variables IDs that you provide in the
|
||
|
|
edit boxes. The value is always drawn in decibels. The setting
|
||
|
|
of the Data Type field is ignored when sending a subscribe command.
|
||
|
|
To unsubscribe, change the message type to Unsubscribe. The Data
|
||
|
|
field is not used in this case, while all other settings remain
|
||
|
|
the same as when subscribing. See the <a href="Third-party Control Protocol.html">Third-party
|
||
|
|
Control Protocol</a> section of the help for more information
|
||
|
|
on the message protocol.</p>
|
||
|
|
<p>Set the meters window up as follows:</p>
|
||
|
|
<p><img src="Di_tool_meters.jpg" alt="Image:di_tool_meters.png" title="Image:di_tool_meters.png" width="196" height="379" border="2" class="hcp1"></p>
|
||
|
|
<p>The top edit box on each channel is the Object ID to listen
|
||
|
|
to. The bottom edit box is the State Variable ID to listen to.
|
||
|
|
This window is configured to show all four meters from an Analogue
|
||
|
|
Input card in slot A.</p>
|
||
|
|
<p>See <a href="Common Object and State Variable IDs.html">Common
|
||
|
|
Object and State Variable IDs</a> for a complete list of I/O card
|
||
|
|
and meter State Variable IDs.</p>
|
||
|
|
<p>To subscribe to state variables other than indicators and meters,
|
||
|
|
the Data field must be set to zero (0). When you issue the subscribe
|
||
|
|
command to a State Variable, the current value of that state variable
|
||
|
|
is immediately sent back. Further updates are sent when the state
|
||
|
|
variable changes, unless the change was triggered by the controller
|
||
|
|
holding the subscription. It is not possible to subscribe to non-meter
|
||
|
|
state variables with a periodic update rate.</p>
|
||
|
|
<p>You may use the subscribe command on state variables effectively
|
||
|
|
as a GET command. Each time you send a subscribe message, the
|
||
|
|
current value is sent back, though you should immediately unsubscribe
|
||
|
|
if you don't want to receive future updates.</p>
|
||
|
|
<div class="editsection" style="float: right; margin-left: 5px;">
|
||
|
|
<p> </p>
|
||
|
|
</div>
|
||
|
|
<p><a name="Control_System_Debugging" id="Control_System_Debugging"></a></p>
|
||
|
|
<h2>Control System Debugging</h2>
|
||
|
|
<p>A good way of debugging a system is to be online to the Soundweb
|
||
|
|
London DSP unit with HiQnet London Architect and to run the Direct
|
||
|
|
Inject message tool connected to the unit via TCP/IP or its serial
|
||
|
|
port.</p>
|
||
|
|
<p>With both HiQnet London Architect and the London Direct Inject
|
||
|
|
application open, messages can be tested in both directions; sending
|
||
|
|
from the unit by adjusting a control in HiQnet London Architect
|
||
|
|
and by sending from the message tool.</p>
|
||
|
|
<p>Messages sent from HiQnet London Architect will appear in the
|
||
|
|
incoming box and serve as examples of message construction for
|
||
|
|
sending from your piece of equipment, since they will be the same.</p>
|
||
|
|
<p>Remember, start simple with perhaps just a couple of mute buttons
|
||
|
|
to establish you have everything cabled correctly and each unit
|
||
|
|
configured correctly.<!-- Saved in parser cache with key bugs:pcache:idhash:2754-0!1!0!0!!en!2 and timestamp 20080303115417 --></p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|