Page 74 / 113
Section 7.
Programmer’s reference
7.2.9. Manual
For every property and method in the tree there is a manual. The manual is a human
readable text that describes the syntax and provides a hint for how to use the primitives.
Command format:
for property:
MAN
●[nodePath].[propertyName]
for method:
MAN
●[nodePath]:[methodName]
Response format:
The human readable manual is separated by a space (
‘ ‘) character from the primitives.
for properties: pm
●[nodePath].[propertyName]●Human readable manual
for methods:
mm
●[nodePath]:[methodName]●Human readable manual
Example:
> MAN●/PRESETS.Count
< pm●/PRESETS.Count:[int] Number of presets
> MAN●/SYS/CORE:ResetLink
< mm●/SYS/CORE:ResetLink:Reset optical link.
7.2.10. Formal definitions
Method parameters and property values are specified in a modified version of Backus-Naur
Form (BNF). The syntax is the following:
“literal”
literals are quoted
<expression1> | <expression2>
vertical bars denote alternatives
[ <expression> ]
expressions in square brackets are optional
<number>*[ <expression> ]
expression is repeated at least <number>
times
*[ <expression> ]
<number> may be omitted, in this case number
defaults to 0
<number>*{ <expression> }
expressions in curly brackets are repeated
exactly <number> times
7.3. LW3 protocol tree
The /MEDIA node contains the sub nodes which are representing the different layers, e.g.
video (/MEDIA/VIDEO), audio (/MEDIA/AUDIO) or RS-232 (/MEDIA/UART). Each layer
has a crosspoint to define connections between the ports associated to the layer, all of
them are represented by a specific node. E.g. the video layer node is /MEDIA/VIDEO:
under the video layer node, the video crosspoint node (XP1) and the video ports
(P1, P2,
…) are located.
