User`s manual

11. Appendix A - Hydra Open Protocol
Barco – iStudio – R5976569 – user's manual – revision 09 – March-2007
__________________________________________________________________________________
11-39
11.3.8 Alarm related commands
To administrate alarm related information to following commands are available:
Get list alarms
Get a list of all alarms that the system supports.
Send
<COMMAND ID="getlistalarms" SERIAL="example">
</COMMAND>
Receive
<COMMANDRESULT SERIAL="example" ERROR="0">
<ALARM ID="videoloss></ALARM>
...
<ALARM ID="audioloss></ALARM>
...
</COMMANDRESULT>
See also clearsourcealarm, getsourcealarm
Get alarms
Get a list of the configuration of all alarms.
Send
<COMMAND ID="getalarms" SERIAL="example">
</COMMAND>
Receive
<COMMANDRESULT SERIAL="example" ERROR="0">
<LINE>...</LINE>
...
</COMMANDRESULT>
Between the line tags are the lines of the alarm configuration.
See also getlistalarms
Each alarm in the list starts with a line containing the word alarm and ends with a line containing the word
end. The table below shows the lines returned for a typical alarm:
lines - top to bottom explanation
<LINE>Alarm</LINE>
start of the alarm section
<LINE>name = videoblack</LINE>
name of the alarm
<LINE>params = 1</LINE>
Parameter definition
0 no parameters
1 there are parameters
<LINE>param1id = 5001</LINE>
for internal use
<LINE>param1min = 0</LINE>
minimum value this alarm can have
<LINE>param1max = 255</LINE>
maximum value this alarm can have
<LINE>param1def = 0</LINE>
default value of this alarm
<LINE>param1div = 1</LINE>
for internal use
<LINE>end</LINE>
end of the alarm section