7.LW3Programmers’Reference
HDMI-TPS-RX110AY series – User's Manual
80
Appliedfirmwarepackage:v1.5.0b3 | LDCsoftware:v2.5.9b2
7.3.7.
Signature
DEFINITION:
The signature is a four-digit-long hexadecimal value that can be optionally placed before
every command to keep a command and the corresponding responses together as a group.
Eachlineisterminatedwithacarriagereturn(Cr,‘\r’)andlinefeed(Lf,‘\n’)characters.Inseveralcasesthe
number of the lines in the response cannot be determined in advance, e.g. the client intends to receive for the
whole response and also wants to be sure, that the received lines belong together and to the same command.
In these cases, a special feature the ‘signature’ can be used. The response to that particular command will
alsobeprecededbythesignature,andthecorrespondinglineswillbebetweenbrackets:
ç
1700#GET/EDID.*
æ
{1700
æ
pr/EDID.EdidStatus=D1:E1
æ
m-/EDID:copy
æ
m-/EDID:delete
æ
m-/EDID:reset
æ
m-/EDID:switch
æ
m-/EDID:switchAll
æ
}
INFO:
ThelinesofthesignaturearealsoCrandLfterminated.
7.3.8.
Subscription
DEFINITION:
Subscriptiontoanodemeansthattheuserwillgetanotificationifapropertyofthenode
changes.
Ausercansubscribetoanynode.Thesenotificationsareasynchronousmessagesandareusefultokeepthe
clientapplicationuptodate,withouthavingtoperiodicallypollthenodetodetectachangedproperty.When
the user does not want to be informed about the changes anymore, he can simply unsubscribe from the node.
ATTENTION!
The subscriptions are handled separately for connections. Hence, if the connection is
terminated all registered subscriptions are deleted. After reopening a connection all subscribe commands
havetobesentinordertogetthenotificationsofthechangesonthatconnection.
Subscribe to a Node
ç
OPEN/MEDIA/VIDEO
æ
o-/MEDIA/VIDEO
Get the Active Subscriptions
ç
OPEN
æ
o-/MEDIA/VIDEO
æ
o-/EDID
æ
o-/DISCOVERY
Subscribe to Multiple Nodes
ç
OPEN/MEDIA/VIDEO/*
æ
o-/MEDIA/VIDEO/*
Unsubscribe from a Node
ç
CLOSE/MEDIA/VIDEO
æ
c-/MEDIA/VIDEO
Unsubscribe from Multiple Nodes
ç
CLOSE/MEDIA/VIDEO/*
æ
c-/MEDIA/VIDEO/*
7.3.9. Notifications about the Changes of the Properties
Whenthevalueofapropertyischangedandtheuserissubscribedtothenode,whichthepropertybelongs
to,anasynchronousnotificationisgenerated.Thisisnotificationiscalledasthe‘changemessage’.The
format of such a message is very similar to the response for the
GET
command:
æ
CHG/EDID.EdidStatus=F48:E1
A Short Example of How to Use the Subscription
There are two independent users controlling the device through two independent connections (
Connection #1
and
Connection #2
). The events in the rows occur after each other.
ç
OPEN/MEDIA/AUDIO/O2
æ
o-/MEDIA/AUDIO/O2
ç
GET/MEDIA/AUDIO/O2.VolumePercent
æ
pw/MEDIA/AUDIO/O2.VolumePercent=100.00
ç
GET/MEDIA/AUDIO/O2.VolumePercent
æ
pw/MEDIA/AUDIO/O2.VolumePercent=100.00
ç
SET/MEDIA/AUDIO/O2.VolumePercent=50.00
æ
pw/MEDIA/AUDIO/O2.VolumePercent=50.00
æ
CHG/MEDIA/AUDIO/O2.VolumePercent=50.00
Explanation:
Thefirstuser(
Connection #1
)setasubscriptiontoanode.Latertheotheruser(
Connection #2
)
madeachange,andthanksforthesubscription,thefirstusergotanotificationaboutthechange.
7.3.10.
Legend for the Control Commands
Format
Description
<in>
Input port number
<out>
Output port number
<port>
Input or output port number
<loc>
Locationnumber
<parameter>
Specificproperty,whichisdefinedanddescribedinthecommand
<expression>
Batchedparameters:theunderlinemeansthatmoreexpressionsorparameters
can be placed by using a semicolon, e.g.
O1;O2
or
F27:U1;F47:U2
Sent command
Received response
·
Space character
Connection #1
Connection #2
Connection #1
}
}