User`s manual

12. Appendix B – Hydra scripting language definition v1.0
Barco – iStudio – R5976569 – user's manual – revision 09 – March-2007
____________________________________________________________________________________
12-2
12.1 How to use scripts without the user interface
• only one user script can be executed at a time on each module, this means that your script will have to wait
until a running script terminates before it will be executed (the script server allows more than 10 pending
connections).
• create a client TCP socket with the address of the H
YDRA module (e.g. 150.158.196.151) and with port 6767
and open the socket, if the connection succeeds, you can send your script line by line as ASCII text, for in-
stance:
begin\n
module this\n
output this\n
end\n
• wait for the script to execute, when the script contains a never-ending loop you will have to stop it by send-
ing: stop\n or by simply closing the socket if you are not interested in output
• messages send with the message command can be received on the fly while the script is executing, mes-
sages are received in the following format : >message\n , e.g. >This is a script message\n.
• after the script is executed/stopped you will receive the following
begin\n
OK\n
script output (zero or more lines depending on the output commands in
script, all lines start with >)
end\n
• you can also receive an error when an unrecognized command is found or the script is interrupted/stopped,
the error contains the line where the problem was found or the script was stopped:
begin\n
ERROR\n
error line\n
script output
end\n
• close the socket, you can now repeat this procedure if necessary