Grass Valley iControl Services Gateway - Manual (Page 18)

Page 18 of 26
1.1.16 S ETTING A P ARAMETER TO A V ALUE ( SET [P ARAMETER ])
Purpose:
To affect a parameter of a Service Node Access Key.
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 at of Service Node..

A session with the Miranda Service Node we want to control has been successfully opened with
the command [Service Node Short Identifier]
XML Syntax:
[type]?[value]>
Where [param] is any of the parameter tags . Ex.luma
[type]
– possible values “inc”,”dec”,”set”
[value] – depending of [type] can be 1 to n for inc and dec or the absolute value to set.
All iControl‟s access keys start with lower-case letter. A set command for a specific parameter will be
constructed using the next rule:
“” + [type] +
“?”+”value”+”
Ex.: Service Access Key = “luma”
set command = “set 60
or = “inc 2
For the numeric parameters, when [type] is
“inc” or “dec” , the effect will be the increase/decrease of the
current parameter value with a quantity equal to {value]*step , where step is given by the parameterInfo
message. For example, in the case of a parameter with step = 0.5, “inc 3” will increase the current value
with 1.5.
In case of choice parameters, inc/dec will set the next/previous valid choice in the choice list.
Replies:
 {…} >{…}<[param/][value1]□[value2]□…[valueN] where the number of [valueN] values
varies accordingly to the parameter.
 {…}
Example:
Setting the Luma of a Service Node that supports Luma.
inc 1{…}\r{…}61?[unit]\r
dec 1{...}\r{...}60 [unit]\r
set 50.0{...}\r{...}50 [unit]\r
If following the execution of the set command, the parameter value did not change, only
message is returned in response.
If [value] is out of range, the command will not be executed and only message will be returned.
In the case of interdependent parameters, (like Luma being also part of a total gain parameter), a set
command may also change the other related parameters. The Gateway will send in return also the