4 command documents (w) – TANDBERG MPS API Interface D13639 User Manual

Page 13

Advertising
background image

TANDBERG MPS API

User Guide

11


Example 10

From the XML structure below we see that the BaudRate element of SerialPort[1] is
configured to 9600. The BaudRate element references the SerialPortBaudrate element
in the ValueSpace document, showing the value domain for this configuration.

<Configuration>>
<SerialPort item="1">
<BaudRate item="1"
valueSpaceRef="/ValueSpace/SerialPortBaudrate[@item='1']">9600</BaudR
ate>
.
.
</SerialPort>
.
.
</Configuration>

---

<ValueSpace>
<SerialPortBaudrate item="1" type="Literal">
<Value>1200</Value>
<Value>2400</Value>
<Value>4800</Value>
<Value>9600</Value>
<Value>19200</Value>
<Value>38400</Value>
<Value>57600</Value>
<Value>115200</Value>
</SerialPortBaudrate>
</ValueSpace>


To change configurations, the part(s) of the document containing the configurations to be
updated should be posted back to the system with the new values. This will be described
thoroughly in a later section.

1.4.4 Command documents (w)

Command documents contain descriptions of the supported commands for the system. A
Command consists of a Command name and a set of Command parameters. The parameter
elements have attributes to denote whether the parameter is optional or required, in a addition
to referencing the value domain for the given parameter.
Command parameters do not contain any values when read from the system.


Example 11

The command Dial is defined to take five parameters, while only the Number parameter is
required as specified by the attribute required. The value domain for the parameters is
referenced by the attribute valueSpaceRef.

<Command>
<Dial item="1">
<Number item="1" required="True"
valueSpaceRef="/ValueSpace/RemoteNumber"/>
<SubAddress item="1" required="False"
valueSpaceRef="/ValueSpace/SubAddress"/>

Advertising