7.LW3Programmers’Reference
HDMI-TPS-RX110AYseries–User'sManual
79
Appliedfirmwarepackage:v1.5.0b3 | LDCsoftware:v2.5.9b2
7.3.3.
Command Types
GET command
The
GET
commandcanbeusedtogetthechildnodes,propertiesandmethodsofaspecificnode.Itcanalso
beusedtogetthevalueofaproperty.Usethedotcharacter(.)whenaddressingaproperty:
ç
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/MEDIA/UART
æ
ns/MEDIA/UART/RECOGNIZER
æ
ns/MEDIA/UART/P1
æ
ns/MEDIA/UART/P2
æ
pr/MEDIA/UART.PortCount=2
æ
pr/MEDIA/UART.PortUi=P1:12209;P2:12224
æ
pr/MEDIA/UART.P1=LocalRS-232
æ
pr/MEDIA/UART.P2=TPSinRS-232
SET command
The
SET
command can be used to modify the value of a property. Use the dot character (.) when addressing
theproperty:
ç
SET/MEDIA/VIDEO/O1.TpgPattern=CYCLE
æ
pw/MEDIA/VIDEO/O1.TpgPattern=CYCLE
CALL command
A method can be invoked by the
CALL
command.Usethecoloncharacter(:)whenaddressingthemethod:
ç
CALL/MEDIA/RELAY/P1:toggle(P1)
æ
mO/MEDIA/RELAY/P1:toggle
MAN command
The manual is a human readable text that describes the syntax and provides a hint for how to use the
primitives. For every node, property and method in the tree there is a manual, type the MAN command to get
themanual:
ç
MAN/MEDIA/VIDEO/O1.Pwr5vMode
æ
pm/MEDIA/VIDEO/O1.Pwr5vMode["0"|"1"|"2"]0-Auto,1-AlwaysOn,2-AlwaysOff
7.3.4. Prefix Summary
DEFINITION:
Theprefixisa2-characterlongcodethatdescribesthetypeoftheresponse.
ThefollowingprefixesaredefinedintheLW3protocol:
Prefix
Description
Prefix
Description
n-
a node
pm
a manual for the property
nE
an error for a node
m-
a method
nm
a manual for a node
mO
a response after a success method execution
pr
a read-only property
mF
a response after a failed method execution
pw
read-write property
mE
an error for a method
pE
an error for the property
mm
a manual for a method
7.3.5.
Error Messages
ThereareseveralerrormessagesdefinedintheLW3protocol,allofthemhaveauniqueerrornumber.
ç
CALL/MEDIA/VIDEO/XP:lock(IA)
æ
mE/MEDIA/VIDEO/XP:lock%E002:Notexist
7.3.6.
Escaping
DEFINITION:
An escape sequence is a sequence of characters that does not represent itself when used
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 which 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).
Controlcharactersarethefollowing:\{}#%()\r\n\t
The
original
message:
CALL /MEDIA/UART/P1:sendMessage(Set(01))
The
escaped
message:
CALL /MEDIA/UART/P1:sendMessage(Set\(01\))
