Grass Valley iControl Services Gateway - Manual (Page 17)

Page 17 of 26
-
type=”choice” informs that the parameter is implemented as a choice list
- isActive informs if the pa rameter is enabled (“true”) or disabled (“false”). An application should
use this information to activate/deactivate the control of a parameter.
Each choice is defined by a tag like the following:
<choice label="100% Bars" rcpval="100%" active="true"/>
- choice label is the long value label displayed only in the IControl service panel;
- rcpval is the short value label displayed on RCP-100 panel and returned to any client using the
Gateway to control a card;
-
active=“true” or “false” informs if the choice label is a valid choice. An application should use
this information to activate/deactivate the use of this choice
The parameterInfo XML message is generally sent by service also as an unsolicited message, if the
parameter properties have changed. An application may interrogate the parameterInfo properties right
before trying to change the parameter value or keep track of the changes reported by the unsolicited
parameterInfo messages.
1.1.15 G ETTING A P ARAMETER V ALUE ( GET [P ARAMETER ])
Purpose:
Obtain the values associated to a parameter of a Service Access Key.
All iControl‟s access keys start with lower-case letter. A get command for a specific parameter will be
constructed using the next rule:
“<get”+ Service Access key with first letter in capital (lowercase is also accepted) + “/>”
Ex.: Service Access Key = “luma”
Get command = “getLuma/>
Pre-Requisites:

Short Identifier of the Node Service is known.

IP address of the Service Node is known.

TCP/IP socket port 13000 has been successfully opened on Service Node IP address.

A session with the Miranda Service Node we want to query has been successfully opened with
the command <openID>[Service Node Short Identifier]</openID>
XML Syntax:
<get[param]/>
Replies:
 {…}<[param/][value1]?[value2]…[valueN]<param/> where the number of [valueN] varies accordingly to
the parameter.
 {…}<nack/>
Note : all the responses that are coming from iControl or an asynchronous update use the same syntax
which is the next:
<[param>[value]?[unit]</[param]> (Ex. <setup>7.5 IRE</setup>)
Example:
Getting the parameter vLuma of a Service Node that supports vLuma.
<getvLuma/>
{…}<vLuma/>60 </vLuma>
Although the spec of this document specifies that an access key must start with a lower-case letter, get []
and set [] commands accept also an uppercase letter. The reason is that RCP-100 client will send
access keys with uppercase letters.
We must maintain compatibility with RCP-100 but implement the use of the uppercase letter also for
getParameterInfo command