Lightware MMX2-4x3-H20 User Manual page 94

    7. LW3 Programmers' Reference
7.4.4. Command Types
GET command
The GET command can be used to get the child nodes, properties and methods of a specific node. It can also
be used to get the value of a property. Use the dot character (.) when addressing a property:
ç GET /.SerialNumber
æ pr /.SerialNumber=87654321
GETALL command
The GETALL command can be used to get all child nodes, properties and methods of a node with one
command.
ç GETALL /V1/MEDIA/ETHERNET
æ n- /V1/MEDIA/ETHERNET/P1
æ n- /V1/MEDIA/ETHERNET/P2
æ n- /V1/MEDIA/ETHERNET/P3
æ n- /V1/MEDIA/ETHERNET/P4
æ n- /V1/MEDIA/ETHERNET/P5
SET command
The SET command can be used to modify the value of a property. Use the dot character (.) when addressing
the property:
ç SET /V1/MEDIA/VIDEO/I2/HDCP.AllowedHdcpVersion=Off
æ pw /V1/MEDIA/VIDEO/I2/HDCP.AllowedHdcpVersion=Off
CALL command
A method can be invoked by the CALL command. Use the colon character (:) when addressing the method:
ç CALL /V1/EDID:switchAll(F49)
æ mO /V1/EDID:switchAll
MAN command
The manual is a human readable text that describes the syntax and provides a hint on how to use the
primitives. For every node, property and method in the tree there is a manual, type the MAN command to get
the manual:
ç MAN /V1/MEDIA/VIDEO/O1.Output5VMode
æ pm /V1/MEDIA/VIDEO/O1.Output5VMode ["On" | "Auto" | "Off"] Enables/disables power 5V output
MMX2 series – User's Manual
7.4.5. Prefix Summary


DEFINITION:
The following prefixes are defined in the LW3 protocol:
7.4.6. Error Messages
There are several error messages defined in the LW3 protocol, all of them have a unique error number.
ç CALL /MEDIA/VIDEO/XP:lock(IA)
æ mE /MEDIA/VIDEO/XP:lock %E002:Not exist
7.4.7. Escaping


DEFINITION:
inside a character or string literal, but is translated into another character or a sequence of characters.
Property values and method parameters can contain characters that are used as control characters in the
protocol. They must be escaped. The escape character is the backslash ('\') and escaping means injecting
a backslash before the character that should be escaped (like in C language).
Control characters are the following: \ { } # % ( ) \r \n \t
Applied firmware package: v2.9.0b6 | LDC software: v2.7.6b4
The prefix is a 2-character-long code that describes the type of the response.
Prefix
Description
n- a node
nE an error for a node
nm a manual for a node
pr a read-only property
pw read-write property
pE an error for the property
pm a manual for the property
m- a method
a response after a successful
mO
method execution
a response after a failed method
mF
execution
mE an error for a method
mm a manual for a method
An escape sequence is a sequence of characters that does not represent itself when used
94