Commandtypes; Prefixsummary; Errormessages; Escaping - Lightware HDMI-TPS-RX110AY Series User Manual


  
7.LW3Programmers'Reference
7.3.3. Command Types
GET command
The GETcommandcanbeusedtogetthechildnodes,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 CALLcommand.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
HDMI-TPS-RX110AY series – User's Manual
7.3.4. Prefix Summary
DEFINITION:

ThefollowingprefixesaredefinedintheLW3protocol:
Prefix
n-
nE
nm
pr
pw
pE
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:

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.Theymustbeescaped.Theescapecharacteristhebackslash('\')andescapingmeansinjecting
a backslash before the character that should be escaped (like in C language).
Controlcharactersarethefollowing:\{}#%()\r\n\t
The originalmessage:
The escapedmessage:
Appliedfirmwarepackage:v1.4.0 | LDCsoftware:v2.4.0b3
Theprefixisa2-characterlongcodethatdescribesthetypeoftheresponse.
Description Prefix
a node pm
an error for a node m-
a manual for a node mO
a read-only property mF
read-write property mE
an error for the property mm
An escape sequence is a sequence of characters that does not represent itself when used
CALL /MEDIA/UART/P1:sendMessage(Set(01))
CALL /MEDIA/UART/P1:sendMessage(Set\(01\))
67
Description
a manual for the property
a method
a response after a success method execution
a response after a failed method execution
an error for a method
a manual for a method