Legendforthecontrolcommands; Prefixsummary; Commandtypes - Lightware HDMI-TPS-TX226 User Manual

   
7.LW3Programmer'sReference
7.3.3. Legend for the Control Commands
Command and Response – Example
ç GET·/MEDIA/VIDEO/I2.SignalPresent
pr·/MEDIA/VIDEO/I2.SignalPresent=<signal_present>
æ
Format
<in> Input port number
<out> Output port number
<port> Input or output port number
<loc> Locationnumber
<parameter> Specificpropertydefinedanddescribedinthecommand
Batchedparameters:theunderlinemeansthatmoreexpressionsorparameters
<expression>
canbeplacedbyusingasemicolon,e.g.I2;I4;I5 or F27:E1;F47:E2
Sentcommand
ç
Receivedresponse
æ
· Spacecharacter
Further not listed <parameters>aredefinedateachcommands.
7.3.4. Prefix Summary
DEFINITION:
Theprefixisa2-characterlongcodethatdescribesthetypeoftheresponse.
ThefollowingprefixesaredefinedintheLW3protocol:
Prefix Description
n- a node
nE an error for a node
nm a manual of a node
ns a child node of a node
pr aread-onlyproperty
pw read-writeproperty
pE an error for the property
pm a manual for the property
m- a method
mO a response after a success method execution
mF a response after a failed method execution
mE an error for a method
mm a manual for a method
HDMI-TPS-TX200series–User'sManual
Description
Appliedfirmwarepackage:v1.3.2b3 | LDCsoftware:v2.5.7b2
7.3.5. 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.PortUi=P1:12209;P2:12224
æ pr/MEDIA/UART.P1=Local
æ pr/MEDIA/UART.P2=TPSoutRS-232
SET command
The SETcommandcanbeusedtomodifythevalueofaproperty.Usethedotcharacter(.)whenaddressing
theproperty:
ç SET/MEDIA/VIDEO/I2.HdcpEnable=true
æ pw/MEDIA/VIDEO/I2.HdcpEnable=true
CALL command
A method can be invoked by the CALLcommand.Usethecoloncharacter(:)whenaddressingthemethod:
ç CALL/MEDIA/AUDIO/XP:muteSource(I1)
æ mO/MEDIA/AUDIO/XP:muteSource
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 MANcommandtoget
themanual:
ç MAN/MEDIA/AUDIO/I2.Connected
æ pm/MEDIA/AUDIO/I2.Connected["0"|"1"|"F"]Indicatescableordeviceconnected\(0=notpresent;
1=present;F=unknown\)
81