Message Types - Panamax VT1512-IP Instruction Manual

1. Command Messages
Command messages are sent to the VT1512-IP in order to have it perform a task. The task can be to perform a physical
action, such as switching an outlet (referred to as an "action"). When the task is to transmit data, such as device status,
it is referred to as a "query". Whether the task is an "action" or "query", the message is classified as a command and is
contained within the <command> element.
Example Action Command Message - switch outlet 2 to OFF:
<?xml version="1.0"?>
<device class="vt1512" id="1065a3051970">
<command><outlet id="2">0</outlet></command>
</device>
2. Response Messages
In response to a query command, the VT1512-IP will send a reply message. The contents part of the message will be a
set of elements enclosed in either the <info>, <status> or <settings> element, depending on the query.
Example Response Message- response to "sendinfo" query command:
<?xml version="1.0"?>
<device class="vt1512" id="1065a3051970">
<command><sendinfo/></command>
</device>
This would be considered the "envelope" for all messages, where the "..." is to be considered the "contents" of the
message. Since all messages include the "envelope", message details will only document the "contents".

Message Types

There are three types of messages: command messages, response messages and event messages.
<?xml version="1.0" ?>
<device class="vt1512" id="1065a3050000">
<command><outlet id="2">0</outlet></command>
</device>
By default, the VT1512-IP does not respond to action command messages.
Example Query Command Message – send information
<?xml version="1.0" ?>
<device class="vt1512" id="1065a3050000">
<command><sendinfo/></command>
</device>
Response
<?xml version="1.0" ?>
<device class="vt1512" id="1065a3050000">
<info time="1234567890">
<sernum>PAVT1512PRO0X142160000000</sernum>
<fwver>1.0.0.12520</fwver>
<bootcodever>1.0</bootcodever>
<ipaddr>3194548209</ipaddr>
<coprocfwver>1.0.0.12520</coprocfwver>
<coproclot>1300795003</coproclot>
<coprocdiex>5</coprocdiex>
<coprocdiey>42</coprocdiey>
<coproctest>65272</coproctest>
</info>
</device>
Response messages can be used to verify command message delivery. If a verifiable response message is desired from the VT1512-IP, the optional "xid" attribute is included in the <com-
mand> element. All command messages with the "xid" attribute expressed will return a response message with the same "xid" attribute value enclosed in an <ack> element. This "xid" value
can then be used to match responses to their corollary commands.
Example 1:
Action Command Message with xid –
<?xml version="1.0" ?><device class="vt1512" id="1065a3050000">
<command xid="123"><outlet id="1">0</outlet></command></device>
Response Message with ack –
<?xml version="1.0" ?><device class="vt1512" id="1065a3050000"><ack xid="123"></device>
www.panamax.com
5