Guntermann & Drunck IP-Control-API - Handbuch (Seite 25)

Text-based control of a matrix switch
IP-Control-API · 6
Text-based control of a matrix switch
The matrix switch processes text-based commands that it receives over the Ethernet
interface. The text-based control of the matrix switch enables you to connect third-
party devices (for example AMX® and Crestron®) to the matrix switch.
Structure of XML documents
Text-based commands are sent to the matrix switch in the form of XML documents.
Valid XML documents optionally start with a header complying with standards. On
top level, the documents are limited by a tag named <root> :
The command you want to carry out is enclosed in a start and an end tag ( root ). The
different commands are described from page 8.
Replies of the matrix switch
After processing an XML document, the matrix switch’s reply states whether the
document was carried out successfully or an error has occurred in the process.
The following example shows the reply to a <list> command:
The results are enclosed in <result> tags.
NOTE: Text-based control is only possible for matrix switches of the
DVICenter series.
STRUCTURE OF A VALID XML DOCUMENT
<?xml version="1.0" encoding="UTF-8" ?> <!-- optional header -->
<root> <!-- start tag of document -->
</root> <!-- end tag of document -->
LIST OF INFORMATION ABOUT A USER MODULE
<?xml version="1.0" encoding="utf-8"?>
<root>
<result type="list">
<DviConsole>
<item>
<id>0x00000117</id>
<cl>DviConsole</cl>
<type>DVI-CON</type>
<name>CON 00000117</name>
<ownerId>189</ownerId>
<ownerCl>DviMatrix</ownerCl>
<ownerPort>0</ownerPort>
<enable>1</enable>
<poweredOn>false</poweredOn>
</item>
</DviConsole>
</result>
</root>